com.vmware.nsx_policy.infra.domains package¶

Subpackages¶

com.vmware.nsx_policy.infra.domains.groups package

Submodules¶

com.vmware.nsx_policy.infra.domains.communication_maps_client module¶

class com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

REVISE_OPERATION_AFTER = 'insert_after'¶: Possible value for operation of method CommunicationEntries.revise().

REVISE_OPERATION_BEFORE = 'insert_before'¶: Possible value for operation of method CommunicationEntries.revise().

REVISE_OPERATION_BOTTOM = 'insert_bottom'¶: Possible value for operation of method CommunicationEntries.revise().

REVISE_OPERATION_TOP = 'insert_top'¶: Possible value for operation of method CommunicationEntries.revise().

delete(domain_id, communication_map_id, communication_entry_id)¶

Delete CommunicationEntry

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_entry_id (`str`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(domain_id, communication_map_id, communication_entry_id)¶

Read CommunicationEntry

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_entry_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.CommunicationEntry`
Returns:	com.vmware.nsx_policy.model.CommunicationEntry
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(domain_id, communication_map_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List CommunicationEntries

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.CommunicationEntryListResult`
Returns:	com.vmware.nsx_policy.model.CommunicationEntryListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, communication_map_id, communication_entry_id, communication_entry)¶

Patch the CommunicationEntry.

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_entry_id (`str`) – (required) communication_entry (`com.vmware.nsx_policy.model_client.CommunicationEntry`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

revise(domain_id, communication_map_id, communication_entry_id, communication_entry, anchor_path=None, operation=None)¶

This is used to re-order a communictation entry within a communication map.

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_entry_id (`str`) – (required) communication_entry (`com.vmware.nsx_policy.model_client.CommunicationEntry`) – (required) anchor_path (`str` or `None`) – The communication map/communication entry path if operation is ‘insert_after’ or ‘insert_before’ (optional) operation (`str` or `None`) – Operation (optional, default to insert_top)
Return type:	`com.vmware.nsx_policy.model_client.CommunicationEntry`
Returns:	com.vmware.nsx_policy.model.CommunicationEntry
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(domain_id, communication_map_id, communication_entry_id, communication_entry)¶

Update the CommunicationEntry. If a CommunicationEntry with the communication-entry-id is not already present, this API fails with a 404. Creation of CommunicationEntries is not allowed using this API.

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_entry_id (`str`) – (required) communication_entry (`com.vmware.nsx_policy.model_client.CommunicationEntry`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.CommunicationEntry`
Returns:	com.vmware.nsx_policy.model.CommunicationEntry
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.domains.communication_maps_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters:	stub_config (`vmware.vapi.bindings.stub.StubConfiguration`) – Stub config instance

com.vmware.nsx_policy.infra.domains.gateway_policies_client module¶

class com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

delete(domain_id, gateway_policy_id, rule_id)¶

Delete Rule

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) rule_id (`str`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(domain_id, gateway_policy_id, rule_id)¶

Read rule

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) rule_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Rule`
Returns:	com.vmware.nsx_policy.model.Rule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(domain_id, gateway_policy_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List Rules

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.RuleListResult`
Returns:	com.vmware.nsx_policy.model.RuleListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, gateway_policy_id, rule_id, rule)¶

Update the gateway rule. If a rule with the rule-id is not already present, then create new rule.

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) rule_id (`str`) – (required) rule (`com.vmware.nsx_policy.model_client.Rule`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(domain_id, gateway_policy_id, rule_id, rule)¶

Update the gateway rule. If a rule with the rule-id is not already present, create new rule.

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) rule_id (`str`) – (required) rule (`com.vmware.nsx_policy.model_client.Rule`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Rule`
Returns:	com.vmware.nsx_policy.model.Rule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.domains.gateway_policies_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters:	stub_config (`vmware.vapi.bindings.stub.StubConfiguration`) – Stub config instance

com.vmware.nsx_policy.infra.domains.groups_client module¶

class com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

delete(domain_id, group_id, port_mirroring_instance_id)¶

API will delete port mirroring instance. Mirroring from source to destination ports will be stopped.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) port_mirroring_instance_id (`str`) – Port Mirroring Instance Id (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(domain_id, group_id, port_mirroring_instance_id)¶

API will return details of port mirroring instance. If instance does not exist, it will return 404.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) port_mirroring_instance_id (`str`) – Port Mirroring Instance Id (required)
Return type:	`com.vmware.nsx_policy.model_client.PortMirroringInstance`
Returns:	com.vmware.nsx_policy.model.PortMirroringInstance
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(domain_id, group_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all port mirroring instances active on current group.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.PortMirroringInstanceListResult`
Returns:	com.vmware.nsx_policy.model.PortMirroringInstanceListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, group_id, port_mirroring_instance_id, port_mirroring_instance)¶

Create a new Port Mirroring Instance if the Port Mirroring Instance with given id does not already exist. If the Port Mirroring Instance with the given id already exists, patch with the existing Port Mirroring Instance.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) port_mirroring_instance_id (`str`) – Port Mirroring Instance Id (required) port_mirroring_instance (`com.vmware.nsx_policy.model_client.PortMirroringInstance`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(domain_id, group_id, port_mirroring_instance_id, port_mirroring_instance)¶

Create or Replace port mirroring instance. Packets will be mirrored from source group to destination group.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) port_mirroring_instance_id (`str`) – Port Mirroring Instance Id (required) port_mirroring_instance (`com.vmware.nsx_policy.model_client.PortMirroringInstance`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.PortMirroringInstance`
Returns:	com.vmware.nsx_policy.model.PortMirroringInstance
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.domains.groups_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters:	stub_config (`vmware.vapi.bindings.stub.StubConfiguration`) – Stub config instance

com.vmware.nsx_policy.infra.domains.redirection_policies_client module¶

class com.vmware.nsx_policy.infra.domains.redirection_policies_client.Rules(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

delete(domain_id, redirection_policy_id, rule_id)¶

Delete RedirectionRule

Parameters:	domain_id (`str`) – Domain ID (required) redirection_policy_id (`str`) – Redirection policy ID (required) rule_id (`str`) – RedirectionRule ID (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(domain_id, redirection_policy_id, rule_id)¶

Read redirection rule for the given redirection policy and redirection rule id.

Parameters:	domain_id (`str`) – Domain id (required) redirection_policy_id (`str`) – Redirection policy id (required) rule_id (`str`) – Redirection rule id (required)
Return type:	`com.vmware.nsx_policy.model_client.RedirectionRule`
Returns:	com.vmware.nsx_policy.model.RedirectionRule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(domain_id, redirection_policy_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List all the redirection rules for given redirection policy id.

Parameters:	domain_id (`str`) – Domain id (required) redirection_policy_id (`str`) – Redirection policy id (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.RedirectionRuleListResult`
Returns:	com.vmware.nsx_policy.model.RedirectionRuleListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, redirection_policy_id, rule_id, redirection_rule)¶

This API creates a redirection rule with given rule-id if it is not already present, otherwise update it if it already exists.

Parameters:	domain_id (`str`) – Domain id (required) redirection_policy_id (`str`) – Redirection policy id (required) rule_id (`str`) – Redirection rule id (required) redirection_rule (`com.vmware.nsx_policy.model_client.RedirectionRule`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(domain_id, redirection_policy_id, rule_id, redirection_rule)¶

This API creates a redirection rule with given rule-id if it is not already present, otherwise update it if it already exists.

Parameters:	domain_id (`str`) – Domain id (required) redirection_policy_id (`str`) – Redirection policy id (required) rule_id (`str`) – Redirection rule id (required) redirection_rule (`com.vmware.nsx_policy.model_client.RedirectionRule`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.RedirectionRule`
Returns:	com.vmware.nsx_policy.model.RedirectionRule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.domains.redirection_policies_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters:	stub_config (`vmware.vapi.bindings.stub.StubConfiguration`) – Stub config instance