com.vmware.nsx_policy.infra package¶

Subpackages¶

Submodules¶

com.vmware.nsx_policy.infra.dhcp_server_configs_client module¶

class com.vmware.nsx_policy.infra.dhcp_server_configs_client.Leases(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

GET_SOURCE_CACHED = 'cached'¶: Possible value for source of method Leases.get().

GET_SOURCE_REALTIME = 'realtime'¶: Possible value for source of method Leases.get().

get(config_id, connectivity_path, address=None, cursor=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, segment_path=None, sort_ascending=None, sort_by=None, source=None)¶

Read DHCP server leases

Parameters:	config_id (`str`) – (required) connectivity_path (`str`) – String Path of Tier0, Tier1 or Segment (required) address (`str` or `None`) – IP or MAC address (optional) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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) segment_path (`str` or `None`) – Segment path to retrieve lease information (optional) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional) source (`str` or `None`) – Data source type. (optional)
Return type:	`com.vmware.nsx_policy.model_client.DhcpLeasesResult`
Returns:	com.vmware.nsx_policy.model.DhcpLeasesResult
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.dhcp_server_configs_client.State(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(config_id, connectivity_path, cursor=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Read DHCP server state

Parameters:	config_id (`str`) – (required) connectivity_path (`str`) – String Path of Tier0, Tier1 or Segment (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.DhcpServerState`
Returns:	com.vmware.nsx_policy.model.DhcpServerState
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.dhcp_server_configs_client.Stats(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(config_id, connectivity_path, cursor=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Read DHCP server statistics

Parameters:	config_id (`str`) – (required) connectivity_path (`str`) – String Path of Tier0, Tier1 or Segment (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.DhcpServerStatistics`
Returns:	com.vmware.nsx_policy.model.DhcpServerStatistics
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.dhcp_server_configs_client.Status(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(config_id, connectivity_path, cursor=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Read DHCP server status

Parameters:	config_id (`str`) – (required) connectivity_path (`str`) – String Path of Tier0, Tier1 or Segment (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.DhcpServerStatus`
Returns:	com.vmware.nsx_policy.model.DhcpServerStatus
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.dhcp_server_configs_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_client module¶

class com.vmware.nsx_policy.infra.domains_client.CommunicationMaps(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 CommunicationMaps.revise().

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

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

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

delete(domain_id, communication_map_id)¶

Deletes the communication map along with all the communication entries This API is deprecated. Please use the following API instead. DELETE /infra/domains/domain-id/security-policies/security-policy-id

Parameters:	domain_id (`str`) – (required) communication_map_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)¶

Read communication-map for a domain. This API is deprecated. Please use the following API instead. GET /infra/domains/domain-id/security-policies/security-policy-id

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.CommunicationMap`
Returns:	com.vmware.nsx_policy.model.CommunicationMap
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, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List all communication maps for a domain. This API is deprecated. Please use the following API instead. GET /infra/domains/domain-id/security-policies

Parameters:	domain_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.CommunicationMapListResult`
Returns:	com.vmware.nsx_policy.model.CommunicationMapListResult
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_map)¶

Patch the communication map for a domain. If a communication map for the given communication-map-id is not present, the object will get created and if it is present it will be updated. This is a full replace This API is deprecated. Please use the following API instead. PATCH /infra/domains/domain-id/security-policies/security-policy-id

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_map (`com.vmware.nsx_policy.model_client.CommunicationMap`) – (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_map, anchor_path=None, operation=None)¶

This is used to set a precedence of a communication map w.r.t others. This API is deprecated. Please use the following API instead. POST /infra/domains/domain-id/security-policies/security-policy-id?action=revise

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_map (`com.vmware.nsx_policy.model_client.CommunicationMap`) – (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.CommunicationMap`
Returns:	com.vmware.nsx_policy.model.CommunicationMap
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_map)¶

Create or Update the communication map for a domain. This is a full replace. All the CommunicationEntries are replaced. This API is deprecated. Please use the following API instead. PUT /infra/domains/domain-id/security-policies/security-policy-id

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_map (`com.vmware.nsx_policy.model_client.CommunicationMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.CommunicationMap`
Returns:	com.vmware.nsx_policy.model.CommunicationMap
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_client.GatewayPolicies(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 GatewayPolicies.revise().

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

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

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

delete(domain_id, gateway_policy_id)¶

Delete GatewayPolicy

Parameters:	domain_id (`str`) – (required) gateway_policy_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)¶

Read gateway policy for a domain.

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.GatewayPolicy`
Returns:	com.vmware.nsx_policy.model.GatewayPolicy
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, cursor=None, include_mark_for_delete_objects=None, include_rule_count=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List all gateway policies for specified Domain.

Parameters:	domain_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) include_rule_count (`bool` or `None`) – Include the count of rules in policy (optional, default to false) 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.GatewayPolicyListResult`
Returns:	com.vmware.nsx_policy.model.GatewayPolicyListResult
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, gateway_policy)¶

Update the gateway policy for a domain. This is a full replace. All the rules are replaced.

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) gateway_policy (`com.vmware.nsx_policy.model_client.GatewayPolicy`) – (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, gateway_policy_id, gateway_policy, anchor_path=None, operation=None)¶

This is used to set a precedence of a gateway policy w.r.t others.

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) gateway_policy (`com.vmware.nsx_policy.model_client.GatewayPolicy`) – (required) anchor_path (`str` or `None`) – The security policy/rule 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.GatewayPolicy`
Returns:	com.vmware.nsx_policy.model.GatewayPolicy
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, gateway_policy)¶

Update the gateway policy for a domain. This is a full replace. All the rules are replaced.

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) gateway_policy (`com.vmware.nsx_policy.model_client.GatewayPolicy`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.GatewayPolicy`
Returns:	com.vmware.nsx_policy.model.GatewayPolicy
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_client.Groups(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, fail_if_subtree_exists=None, force=None)¶

Delete Group

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) fail_if_subtree_exists (`bool` or `None`) – Do not delete if the group subtree has any entities (optional, default to false) force (`bool` or `None`) – Force delete the resource even if it is being used somewhere (optional, default to false)
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)¶

Read group

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required)
Return type:	`com.vmware.nsx_policy.model_client.Group`
Returns:	com.vmware.nsx_policy.model.Group
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, cursor=None, include_mark_for_delete_objects=None, included_fields=None, member_types=None, page_size=None, sort_ascending=None, sort_by=None)¶

List Groups for a domain. Groups can be filtered using member_types query parameter, which returns the groups that contains the specified member types. Multiple member types can be provided as comma separated values. The API also return groups having member type that are subset of provided member_types.

Parameters:	domain_id (`str`) – Domain ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) member_types (`str` or `None`) – Comma Seperated Member types (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.GroupListResult`
Returns:	com.vmware.nsx_policy.model.GroupListResult
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, group)¶

If a group with the group-id is not already present, create a new group. If it already exists, patch the group.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) group (`com.vmware.nsx_policy.model_client.Group`) – (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, group)¶

If a group with the group-id is not already present, create a new group. If it already exists, update the group. Avoid creating groups with multiple MACAddressExpression and IPAddressExpression. In future releases, group will be restricted to contain a single MACAddressExpression and IPAddressExpression along with other expressions. To group IPAddresses or MACAddresses, use nested groups instead of multiple IPAddressExpressions/MACAddressExpression.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) group (`com.vmware.nsx_policy.model_client.Group`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Group`
Returns:	com.vmware.nsx_policy.model.Group
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_client.IntrusionServicePolicies(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 IntrusionServicePolicies.revise().

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

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

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

delete(domain_id, policy_id)¶

Delete intrusion detection system security policy.

Parameters:	domain_id (`str`) – Domain ID (required) policy_id (`str`) – Policy 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, policy_id)¶

Read intrusion detection system security policy.

Parameters:	domain_id (`str`) – Domain ID (required) policy_id (`str`) – Policy ID (required)
Return type:	`com.vmware.nsx_policy.model_client.IdsSecurityPolicy`
Returns:	com.vmware.nsx_policy.model.IdsSecurityPolicy
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, cursor=None, include_mark_for_delete_objects=None, include_rule_count=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List intrusion detection system security policies.

Parameters:	domain_id (`str`) – Domain ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) include_rule_count (`bool` or `None`) – Include the count of rules in policy (optional, default to false) 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.IdsSecurityPolicyListResult`
Returns:	com.vmware.nsx_policy.model.IdsSecurityPolicyListResult
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, policy_id, ids_security_policy)¶

Patch intrusion detection system security policy for a domain.

Parameters:	domain_id (`str`) – Domain ID (required) policy_id (`str`) – Policy ID (required) ids_security_policy (`com.vmware.nsx_policy.model_client.IdsSecurityPolicy`) – (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, policy_id, ids_security_policy, anchor_path=None, operation=None)¶

This is used to set a precedence of a security policy w.r.t others.

Parameters:	domain_id (`str`) – (required) policy_id (`str`) – (required) ids_security_policy (`com.vmware.nsx_policy.model_client.IdsSecurityPolicy`) – (required) anchor_path (`str` or `None`) – The security policy/rule 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.IdsSecurityPolicy`
Returns:	com.vmware.nsx_policy.model.IdsSecurityPolicy
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, policy_id, ids_security_policy)¶

Update intrusion detection system security policy for a domain.

Parameters:	domain_id (`str`) – Domain ID (required) policy_id (`str`) – Policy ID (required) ids_security_policy (`com.vmware.nsx_policy.model_client.IdsSecurityPolicy`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.IdsSecurityPolicy`
Returns:	com.vmware.nsx_policy.model.IdsSecurityPolicy
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_client.SecurityPolicies(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 SecurityPolicies.revise().

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

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

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

delete(domain_id, security_policy_id)¶

Deletes the security policy along with all the rules

Parameters:	domain_id (`str`) – (required) security_policy_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, security_policy_id)¶

Read security policy for a domain.

Parameters:	domain_id (`str`) – (required) security_policy_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SecurityPolicy`
Returns:	com.vmware.nsx_policy.model.SecurityPolicy
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, cursor=None, include_mark_for_delete_objects=None, include_rule_count=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List all security policies for a domain.

Parameters:	domain_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) include_rule_count (`bool` or `None`) – Include the count of rules in policy (optional, default to false) 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.SecurityPolicyListResult`
Returns:	com.vmware.nsx_policy.model.SecurityPolicyListResult
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, security_policy_id, security_policy)¶

Patch the security policy for a domain. If a security policy for the given security-policy-id is not present, the object will get created and if it is present it will be updated. This is a full replace

Parameters:	domain_id (`str`) – (required) security_policy_id (`str`) – (required) security_policy (`com.vmware.nsx_policy.model_client.SecurityPolicy`) – (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, security_policy_id, security_policy, anchor_path=None, operation=None)¶

This is used to set a precedence of a security policy w.r.t others.

Parameters:	domain_id (`str`) – (required) security_policy_id (`str`) – (required) security_policy (`com.vmware.nsx_policy.model_client.SecurityPolicy`) – (required) anchor_path (`str` or `None`) – The security policy/rule 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.SecurityPolicy`
Returns:	com.vmware.nsx_policy.model.SecurityPolicy
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, security_policy_id, security_policy)¶

Create or Update the security policy for a domain. This is a full replace. All the rules are replaced.

Parameters:	domain_id (`str`) – (required) security_policy_id (`str`) – (required) security_policy (`com.vmware.nsx_policy.model_client.SecurityPolicy`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SecurityPolicy`
Returns:	com.vmware.nsx_policy.model.SecurityPolicy
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_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.drafts_client module¶

class com.vmware.nsx_policy.infra.drafts_client.Aggregated(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(draft_id)¶

Get an aggregated configuration that will get applied onto current configuration during publish of this draft. The response is a hierarichal payload containing the aggregated configuration differences from the latest auto draft till the specified draft.

Parameters:	draft_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Infra`
Returns:	com.vmware.nsx_policy.model.Infra
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.drafts_client.Complete(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(draft_id)¶

Get a preview of a configuration which will be present after publish of a specified draft. The response essentially is a hierarichal payload containing the configuration, which will be in active after a specified draft gets published onto current configuration.

Parameters:	draft_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Infra`
Returns:	com.vmware.nsx_policy.model.Infra
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.drafts_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.flood_protection_profiles_client module¶

class com.vmware.nsx_policy.infra.flood_protection_profiles_client.Bindings(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

list(flood_protection_profile_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all Flood Protection Profiles bindings.

Parameters:	flood_protection_profile_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.FloodProtectionProfileBindingListResult`
Returns:	com.vmware.nsx_policy.model.FloodProtectionProfileBindingListResult
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.flood_protection_profiles_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.realized_state_client module¶

class com.vmware.nsx_policy.infra.realized_state_client.EnforcementPoints(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(enforcement_point_name)¶

Read a Enforcement Point and the complete tree underneath. Returns the populated enforcement point object.

Parameters:	enforcement_point_name (`str`) – Enforcement Point Name (required)
Return type:	`com.vmware.nsx_policy.model_client.RealizedEnforcementPoint`
Returns:	com.vmware.nsx_policy.model.RealizedEnforcementPoint
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(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all enforcement points. Returns the populated enforcement points.

Parameters:	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.RealizedEnforcementPointListResult`
Returns:	com.vmware.nsx_policy.model.RealizedEnforcementPointListResult
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.realized_state_client.Status(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(intent_path, include_enforced_status=None, site_path=None)¶

Parameters:	intent_path (`str`) – Policy Path of the intent object (required) include_enforced_status (`bool` or `None`) – Include Enforced Status Flag (optional, default to false) site_path (`str` or `None`) – Policy Path of the site from where the realization status needs to be fetched (optional)
Return type:	`com.vmware.nsx_policy.model_client.ConsolidatedRealizedStatus`
Returns:	com.vmware.nsx_policy.model.ConsolidatedRealizedStatus
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.realized_state_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

class com.vmware.nsx_policy.infra.realized_state_client.UnassociatedVirtualMachines(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

list(cursor=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

This API filters objects of type virtual machine which are not part of any group. This API also gives some VM details such as VM name, IDs and the current state of the VMs.

Parameters:	cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.VirtualMachineListResult`
Returns:	com.vmware.nsx_policy.model.VirtualMachineListResult
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.realized_state_client.VirtualMachines(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

list(cursor=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

This API filters objects of type virtual machine. This API also gives some VM details such as VM name, IDs and the current state of the VMs.

Parameters:	cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.VirtualMachineListResult`
Returns:	com.vmware.nsx_policy.model.VirtualMachineListResult
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

com.vmware.nsx_policy.infra.segments_client module¶

class com.vmware.nsx_policy.infra.segments_client.ArpTable(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

list(segment_id, cursor=None, edge_path=None, enforcement_point_path=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the interface (downlink) attaching segment to tier-0/tier-1 gateway, on a edge node specified in edge_path parameter. The edge_path parameter is mandatory.

Parameters:	segment_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) edge_path (`str` or `None`) – Policy path of edge node (optional) enforcement_point_path (`str` or `None`) – Enforcement point path (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.InterfaceArpTable`
Returns:	com.vmware.nsx_policy.model.InterfaceArpTable
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.segments_client.DhcpStaticBindingConfigs(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(segment_id, binding_id)¶

Delete DHCP static binding

Parameters:	segment_id (`str`) – (required) binding_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(segment_id, binding_id)¶

Read DHCP static binding

Parameters:	segment_id (`str`) – (required) binding_id (`str`) – (required)
Return type:	`vmware.vapi.struct.VapiStruct`
Returns:	com.vmware.nsx_policy.model.DhcpStaticBindingConfig The return value will contain all the attributes defined in `com.vmware.nsx_policy.model_client.DhcpStaticBindingConfig`.
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(segment_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all DHCP static binding instances

Parameters:	segment_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.DhcpStaticBindingConfigListResult`
Returns:	com.vmware.nsx_policy.model.DhcpStaticBindingConfigListResult
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(segment_id, binding_id, dhcp_static_binding_config)¶

If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with specified attributes.

Parameters:	segment_id (`str`) – (required) binding_id (`str`) – (required) dhcp_static_binding_config (`vmware.vapi.struct.VapiStruct`) – (required) The parameter must contain all the attributes defined in `com.vmware.nsx_policy.model_client.DhcpStaticBindingConfig`.
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(segment_id, binding_id, dhcp_static_binding_config)¶

If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with this object.

Parameters:	segment_id (`str`) – (required) binding_id (`str`) – (required) dhcp_static_binding_config (`vmware.vapi.struct.VapiStruct`) – (required) The parameter must contain all the attributes defined in `com.vmware.nsx_policy.model_client.DhcpStaticBindingConfig`.
Return type:	`vmware.vapi.struct.VapiStruct`
Returns:	com.vmware.nsx_policy.model.DhcpStaticBindingConfig The return value will contain all the attributes defined in `com.vmware.nsx_policy.model_client.DhcpStaticBindingConfig`.
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.segments_client.Ports(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(segment_id, port_id)¶

Delete an infra segment port by giving ID.

Parameters:	segment_id (`str`) – (required) port_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(segment_id, port_id)¶

Get detail information on an infra segment port by giving ID.

Parameters:	segment_id (`str`) – (required) port_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentPort`
Returns:	com.vmware.nsx_policy.model.SegmentPort
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(segment_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List all the ports for an infra.

Parameters:	segment_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.SegmentPortListResult`
Returns:	com.vmware.nsx_policy.model.SegmentPortListResult
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(segment_id, port_id, segment_port)¶

Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body.

Parameters:	segment_id (`str`) – (required) port_id (`str`) – (required) segment_port (`com.vmware.nsx_policy.model_client.SegmentPort`) – (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(segment_id, port_id, segment_port)¶

Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists.

Parameters:	segment_id (`str`) – (required) port_id (`str`) – (required) segment_port (`com.vmware.nsx_policy.model_client.SegmentPort`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentPort`
Returns:	com.vmware.nsx_policy.model.SegmentPort
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.segments_client.SegmentMonitoringProfileBindingMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(infra_segment_id, segment_monitoring_profile_binding_map_id)¶

API will delete Infra Segment Monitoring Profile Binding Profile.

Parameters:	infra_segment_id (`str`) – Infra Segment ID (required) segment_monitoring_profile_binding_map_id (`str`) – Segment Monitoring Profile Binding Map 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(infra_segment_id, segment_monitoring_profile_binding_map_id)¶

API will get Infra Segment Monitoring Profile Binding Map.

Parameters:	infra_segment_id (`str`) – Infra Segment ID (required) segment_monitoring_profile_binding_map_id (`str`) – Segment Monitoring Profile Binding Map ID (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SegmentMonitoringProfileBindingMap
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(infra_segment_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all Infra Segment Monitoring Profile Binding Maps in current segment id.

Parameters:	infra_segment_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.SegmentMonitoringProfileBindingMapListResult`
Returns:	com.vmware.nsx_policy.model.SegmentMonitoringProfileBindingMapListResult
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(infra_segment_id, segment_monitoring_profile_binding_map_id, segment_monitoring_profile_binding_map)¶

API will create infra segment monitoring profile binding map.

Parameters:	infra_segment_id (`str`) – Infra Segment ID (required) segment_monitoring_profile_binding_map_id (`str`) – Segment Monitoring Profile Binding Map ID (required) segment_monitoring_profile_binding_map (`com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap`) – (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(infra_segment_id, segment_monitoring_profile_binding_map_id, segment_monitoring_profile_binding_map)¶

API will update Infra Segment Monitoring Profile Binding Map.

Parameters:	infra_segment_id (`str`) – Infra Segment ID (required) segment_monitoring_profile_binding_map_id (`str`) – Segment Monitoring Profile Binding Map ID (required) segment_monitoring_profile_binding_map (`com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SegmentMonitoringProfileBindingMap
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.segments_client.ServiceSegments(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(service_segment_id)¶

Delete Service Segment with given ID

Parameters:	service_segment_id (`str`) – Service Segment 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(service_segment_id)¶

Read a Service Segment with the given id

Parameters:	service_segment_id (`str`) – Service Segment ID (required)
Return type:	`com.vmware.nsx_policy.model_client.ServiceSegment`
Returns:	com.vmware.nsx_policy.model.ServiceSegment
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(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Service Segments

Parameters:	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.ServiceSegmentListResult`
Returns:	com.vmware.nsx_policy.model.ServiceSegmentListResult
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(service_segment_id, service_segment)¶

A service segment with the service-segment-id is created. Modification of service segment is not supported.

Parameters:	service_segment_id (`str`) – Service Segment ID (required) service_segment (`com.vmware.nsx_policy.model_client.ServiceSegment`) – (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(service_segment_id, service_segment)¶

A service segment with the service-segment-id is created. Modification of service segment is not supported.

Parameters:	service_segment_id (`str`) – Service Segment ID (required) service_segment (`com.vmware.nsx_policy.model_client.ServiceSegment`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.ServiceSegment`
Returns:	com.vmware.nsx_policy.model.ServiceSegment
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.segments_client.State(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(segments_id, cursor=None, edge_path=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Get infra segment state information.

Parameters:	segments_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) edge_path (`str` or `None`) – Policy path of edge node (optional) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.SegmentConfigurationState`
Returns:	com.vmware.nsx_policy.model.SegmentConfigurationState
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.segments_client.Statistics(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(segments_id, cursor=None, edge_path=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Get infra segment statistics information.

Parameters:	segments_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) edge_path (`str` or `None`) – Policy path of edge node (optional) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.SegmentStatistics`
Returns:	com.vmware.nsx_policy.model.SegmentStatistics
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.segments_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.services_client module¶

class com.vmware.nsx_policy.infra.services_client.ServiceEntries(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(service_id, service_entry_id)¶

Delete Service entry

Parameters:	service_id (`str`) – Service ID (required) service_entry_id (`str`) – Service entry 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(service_id, service_entry_id)¶

Service entry

Parameters:	service_id (`str`) – Service ID (required) service_entry_id (`str`) – Service entry ID (required)
Return type:	`vmware.vapi.struct.VapiStruct`
Returns:	com.vmware.nsx_policy.model.ServiceEntry The return value will contain all the attributes defined in `com.vmware.nsx_policy.model_client.ServiceEntry`.
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(service_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of Service entries for the given service

Parameters:	service_id (`str`) – Service ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.ServiceEntryListResult`
Returns:	com.vmware.nsx_policy.model.ServiceEntryListResult
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(service_id, service_entry_id, service_entry)¶

If a service entry with the service-entry-id is not already present, create a new service entry. If it already exists, patch the service entry.

Parameters:	service_id (`str`) – Service ID (required) service_entry_id (`str`) – Service entry ID (required) service_entry (`vmware.vapi.struct.VapiStruct`) – (required) The parameter must contain all the attributes defined in `com.vmware.nsx_policy.model_client.ServiceEntry`.
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(service_id, service_entry_id, service_entry)¶

If a service entry with the service-entry-id is not already present, create a new service entry. If it already exists, update the service entry.

Parameters:	service_id (`str`) – Service ID (required) service_entry_id (`str`) – Service entry ID (required) service_entry (`vmware.vapi.struct.VapiStruct`) – (required) The parameter must contain all the attributes defined in `com.vmware.nsx_policy.model_client.ServiceEntry`.
Return type:	`vmware.vapi.struct.VapiStruct`
Returns:	com.vmware.nsx_policy.model.ServiceEntry The return value will contain all the attributes defined in `com.vmware.nsx_policy.model_client.ServiceEntry`.
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.services_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.tags_client module¶

class com.vmware.nsx_policy.infra.tags_client.EffectiveResources(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

list(cursor=None, filter_text=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, scope=None, sort_ascending=None, sort_by=None, tag=None)¶

Paginated list of all objects assigned with matching scope and tag values. Objects are represented in form of resource reference.

Parameters:	cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) filter_text (`str` or `None`) – Filter text to restrict tagged objects list with matching filter text. (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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) scope (`str` or `None`) – Tag scope (optional) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional) tag (`str` or `None`) – Tag value (optional)
Return type:	`com.vmware.nsx_policy.model_client.PolicyResourceReferenceListResult`
Returns:	com.vmware.nsx_policy.model.PolicyResourceReferenceListResult
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.tags_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

class com.vmware.nsx_policy.infra.tags_client.TagOperations(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(operation_id)¶

Get details of tag bulk operation request with which tag is applied or removed on virtual machines.

Parameters:	operation_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.TagBulkOperation`
Returns:	com.vmware.nsx_policy.model.TagBulkOperation
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(operation_id, tag_bulk_operation)¶

Tag can be assigned or unassigned on multiple objects. Supported object type is restricted to Virtual Machine for now and support for other objects will be added later. Permissions for tag bulk operation would be similar to virtual machine tag permissions.

Parameters:	operation_id (`str`) – (required) tag_bulk_operation (`com.vmware.nsx_policy.model_client.TagBulkOperation`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.TagBulkOperation`
Returns:	com.vmware.nsx_policy.model.TagBulkOperation
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

com.vmware.nsx_policy.infra.tier_0s_client module¶

class com.vmware.nsx_policy.infra.tier_0s_client.CommunityLists(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(tier0_id, community_list_id)¶

Read a BGP community list

Parameters:	tier0_id (`str`) – (required) community_list_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.CommunityList`
Returns:	com.vmware.nsx_policy.model.CommunityList
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(tier0_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all community lists under a tier-0

Parameters:	tier0_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.CommunityListListResult`
Returns:	com.vmware.nsx_policy.model.CommunityListListResult
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(tier0_id, community_list_id, community_list)¶

If a community list with the community-list-id is not already present, create a new community list. If it already exists, update the community list for specified attributes.

Parameters:	tier0_id (`str`) – (required) community_list_id (`str`) – (required) community_list (`com.vmware.nsx_policy.model_client.CommunityList`) – (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

class com.vmware.nsx_policy.infra.tier_0s_client.ForwardingTable(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_ROUTE_SOURCE_BGP = 'BGP'¶: Possible value for routeSource of method ForwardingTable.list().

LIST_ROUTE_SOURCE_CONNECTED = 'CONNECTED'¶: Possible value for routeSource of method ForwardingTable.list().

LIST_ROUTE_SOURCE_STATIC = 'STATIC'¶: Possible value for routeSource of method ForwardingTable.list().

list(tier0_id, cursor=None, edge_id=None, edge_path=None, enforcement_point_path=None, included_fields=None, network_prefix=None, page_size=None, route_source=None, sort_ascending=None, sort_by=None)¶

Get forwarding table from tier-0

Parameters:	tier0_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) edge_id (`str` or `None`) – UUID of edge node (optional) edge_path (`str` or `None`) – Policy path of edge node (optional) enforcement_point_path (`str` or `None`) – Enforcement point path (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) network_prefix (`str` or `None`) – IPv4 or IPv6 CIDR Block (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) route_source (`str` or `None`) – Filter routes based on the source from which route is learned (optional) 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.RoutingTableListResult`
Returns:	com.vmware.nsx_policy.model.RoutingTableListResult
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.tier_0s_client.Groups(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier0_id, group_id)¶

Delete the Group under Tier-0.

Parameters:	tier0_id (`str`) – (required) group_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(tier0_id, group_id)¶

Read Tier-0 Group

Parameters:	tier0_id (`str`) – (required) group_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Group`
Returns:	com.vmware.nsx_policy.model.Group
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(tier0_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, member_types=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Groups for Tier-0.

Parameters:	tier0_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) member_types (`str` or `None`) – Comma Seperated Member types (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.GroupListResult`
Returns:	com.vmware.nsx_policy.model.GroupListResult
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(tier0_id, group_id, group)¶

If a Group with the group-id is not already present, create a new Group under the tier-0-id. Update if exists. The API valiates that Tier-0 is present before creating the Group.

Parameters:	tier0_id (`str`) – (required) group_id (`str`) – (required) group (`com.vmware.nsx_policy.model_client.Group`) – (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(tier0_id, group_id, group)¶

If a Group with the group-id is not already present, create a new Group under the tier-0-id. Update if exists. The API valiates that Tier-0 is present before creating the Group.

Parameters:	tier0_id (`str`) – (required) group_id (`str`) – (required) group (`com.vmware.nsx_policy.model_client.Group`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Group`
Returns:	com.vmware.nsx_policy.model.Group
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.tier_0s_client.LocaleServices(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier0_id, locale_services_id)¶

Delete Tier-0 locale-services

Parameters:	tier0_id (`str`) – (required) locale_services_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(tier0_id, locale_services_id)¶

Read Tier-0 locale-services

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.LocaleServices`
Returns:	com.vmware.nsx_policy.model.LocaleServices
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(tier0_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Tier-0 locale-services

Parameters:	tier0_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.LocaleServicesListResult`
Returns:	com.vmware.nsx_policy.model.LocaleServicesListResult
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(tier0_id, locale_services_id, locale_services)¶

If a Tier-0 locale-services with the locale-services-id is not already present, create a new locale-services. If it already exists, update Tier-0 locale-services with specified attributes.

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required) locale_services (`com.vmware.nsx_policy.model_client.LocaleServices`) – (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(tier0_id, locale_services_id, locale_services)¶

If a Tier-0 locale-services with the locale-services-id is not already present, create a new locale-services. If it already exists, replace the Tier-0 locale-services instance with the new object.

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required) locale_services (`com.vmware.nsx_policy.model_client.LocaleServices`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.LocaleServices`
Returns:	com.vmware.nsx_policy.model.LocaleServices
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.tier_0s_client.PrefixLists(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier0_id, prefix_list_id)¶

Delete a prefix list

Parameters:	tier0_id (`str`) – (required) prefix_list_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(tier0_id, prefix_list_id)¶

Read a prefix list

Parameters:	tier0_id (`str`) – (required) prefix_list_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.PrefixList`
Returns:	com.vmware.nsx_policy.model.PrefixList
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(tier0_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all prefix lists

Parameters:	tier0_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.PrefixListResult`
Returns:	com.vmware.nsx_policy.model.PrefixListResult
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(tier0_id, prefix_list_id, prefix_list)¶

If prefix list for prefix-list-id is not already present, create a prefix list. If it already exists, update prefix list for prefix-list-id.

Parameters:	tier0_id (`str`) – (required) prefix_list_id (`str`) – (required) prefix_list (`com.vmware.nsx_policy.model_client.PrefixList`) – (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(tier0_id, prefix_list_id, prefix_list)¶

If prefix list for prefix-list-id is not already present, create a prefix list. If it already exists, replace the prefix list for prefix-list-id.

Parameters:	tier0_id (`str`) – Tier-0 ID (required) prefix_list_id (`str`) – Prefix List ID (required) prefix_list (`com.vmware.nsx_policy.model_client.PrefixList`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.PrefixList`
Returns:	com.vmware.nsx_policy.model.PrefixList
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.tier_0s_client.RouteMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier0_id, route_map_id)¶

Delete a route map

Parameters:	tier0_id (`str`) – (required) route_map_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

list(tier0_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all route maps under a tier-0

Parameters:	tier0_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.Tier0RouteMapListResult`
Returns:	com.vmware.nsx_policy.model.Tier0RouteMapListResult
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.tier_0s_client.RoutingTable(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_ROUTE_SOURCE_BGP = 'BGP'¶: Possible value for routeSource of method RoutingTable.list().

LIST_ROUTE_SOURCE_CONNECTED = 'CONNECTED'¶: Possible value for routeSource of method RoutingTable.list().

LIST_ROUTE_SOURCE_STATIC = 'STATIC'¶: Possible value for routeSource of method RoutingTable.list().

list(tier0_id, cursor=None, edge_id=None, edge_path=None, enforcement_point_path=None, included_fields=None, network_prefix=None, page_size=None, route_source=None, sort_ascending=None, sort_by=None)¶

Get routing table from tier-0

Parameters:	tier0_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) edge_id (`str` or `None`) – UUID of edge node (optional) edge_path (`str` or `None`) – Policy path of edge node (optional) enforcement_point_path (`str` or `None`) – Enforcement point path (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) network_prefix (`str` or `None`) – IPv4 or IPv6 CIDR Block (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) route_source (`str` or `None`) – Filter routes based on the source from which route is learned (optional) 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.RoutingTableListResult`
Returns:	com.vmware.nsx_policy.model.RoutingTableListResult
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.tier_0s_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.tier_1s_client module¶

class com.vmware.nsx_policy.infra.tier_1s_client.DnsForwarder(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

CREATE_ACTION_CACHE = 'clear_cache'¶: Possible value for action of method DnsForwarder.create().

create(tier1_id, action, enforcement_point_path=None)¶

Perform the specified action for Tier0 DNS forwarder on specified enforcement point.

Parameters:	tier1_id (`str`) – (required) action (`str`) – An action to be performed for DNS forwarder on EP (required) enforcement_point_path (`str` or `None`) – An enforcement point path, on which the action is to be performed (optional, default to /infra/sites/default/enforcement-points/default)
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

delete(tier1_id)¶

Delete DNS configuration for tier-1 instance

Parameters:	tier1_id (`str`) – Tier-1 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(tier1_id)¶

Read the DNS Forwarder for the given tier-1 instance

Parameters:	tier1_id (`str`) – Tier-1 ID (required)
Return type:	`com.vmware.nsx_policy.model_client.PolicyDnsForwarder`
Returns:	com.vmware.nsx_policy.model.PolicyDnsForwarder
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(tier1_id, policy_dns_forwarder)¶

Create or update the DNS Forwarder

Parameters:	tier1_id (`str`) – Tier-1 ID (required) policy_dns_forwarder (`com.vmware.nsx_policy.model_client.PolicyDnsForwarder`) – (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(tier1_id, policy_dns_forwarder)¶

Create or update the DNS Forwarder

Parameters:	tier1_id (`str`) – Tier-1 ID (required) policy_dns_forwarder (`com.vmware.nsx_policy.model_client.PolicyDnsForwarder`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.PolicyDnsForwarder`
Returns:	com.vmware.nsx_policy.model.PolicyDnsForwarder
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.tier_1s_client.ForwardingTable(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_ROUTE_SOURCE_BGP = 'BGP'¶: Possible value for routeSource of method ForwardingTable.list().

LIST_ROUTE_SOURCE_CONNECTED = 'CONNECTED'¶: Possible value for routeSource of method ForwardingTable.list().

LIST_ROUTE_SOURCE_STATIC = 'STATIC'¶: Possible value for routeSource of method ForwardingTable.list().

list(tier1_id, cursor=None, edge_id=None, edge_path=None, enforcement_point_path=None, included_fields=None, network_prefix=None, page_size=None, route_source=None, sort_ascending=None, sort_by=None)¶

Get forwarding table from tier-1

Parameters:	tier1_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) edge_id (`str` or `None`) – UUID of edge node (optional) edge_path (`str` or `None`) – Policy path of edge node (optional) enforcement_point_path (`str` or `None`) – Enforcement point path (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) network_prefix (`str` or `None`) – IPv4 or IPv6 CIDR Block (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) route_source (`str` or `None`) – Filter routes based on the source from which route is learned (optional) 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.RoutingTableListResult`
Returns:	com.vmware.nsx_policy.model.RoutingTableListResult
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.tier_1s_client.GatewayFirewall(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

list(tier1_id)¶

Get filtered view of Gateway Firewall rules associated with the Tier-1. The gateway policies are returned in the order of category and sequence number.

Parameters:	tier1_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.GatewayPolicyListResult`
Returns:	com.vmware.nsx_policy.model.GatewayPolicyListResult
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.tier_1s_client.IpfixSwitchCollectionInstances(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id, ipfix_switch_collection_instance_id)¶

API deletes IPFIX Switch Collection Instance.Flow forwarding to selected collector will be stopped. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/ipfix-l2-profiles

Parameters:	tier1_id (`str`) – Tier-1 ID (required) ipfix_switch_collection_instance_id (`str`) – IPFIX Switch Collection 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(tier1_id, ipfix_switch_collection_instance_id)¶

API will return details of IPFIX switch collection. If instance does not exist, it will return 404. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/ipfix-l2-profiles

Parameters:	tier1_id (`str`) – Tier-1 ID (required) ipfix_switch_collection_instance_id (`str`) – IPFIX switch collection id (required)
Return type:	`com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance`
Returns:	com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstance
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(tier1_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API provides list IPFIX Switch collection instances available on selected logical switch. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/ipfix-l2-profiles

Parameters:	tier1_id (`str`) – Tier-1 ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.IPFIXSwitchCollectionInstanceListResult`
Returns:	com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstanceListResult
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(tier1_id, ipfix_switch_collection_instance_id, i_pfix_switch_collection_instance)¶

Create a new IPFIX switch collection instance if the IPFIX switch collection instance with given id does not already exist. If the IPFIX switch collection instance with the given id already exists, patch with the existing IPFIX switch collection instance. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/ipfix-l2-profiles

Parameters:	tier1_id (`str`) – Tier-1 ID (required) ipfix_switch_collection_instance_id (`str`) – IPFIX Switch Collection Instance ID (required) i_pfix_switch_collection_instance (`com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance`) – (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(tier1_id, ipfix_switch_collection_instance_id, i_pfix_switch_collection_instance)¶

Create or replace IPFIX switch collection instance. Instance will start forwarding data to provided IPFIX collector. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/ipfix-l2-profiles

Parameters:	tier1_id (`str`) – Tier-1 ID (required) ipfix_switch_collection_instance_id (`str`) – IPFIX Switch Collection Instance ID (required) i_pfix_switch_collection_instance (`com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance`
Returns:	com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstance
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.tier_1s_client.LocaleServices(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id, locale_services_id)¶

Delete Tier-1 locale-services

Parameters:	tier1_id (`str`) – (required) locale_services_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(tier1_id, locale_services_id)¶

Read Tier-1 locale-services

Parameters:	tier1_id (`str`) – (required) locale_services_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.LocaleServices`
Returns:	com.vmware.nsx_policy.model.LocaleServices
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(tier1_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Tier-1 locale-services

Parameters:	tier1_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.LocaleServicesListResult`
Returns:	com.vmware.nsx_policy.model.LocaleServicesListResult
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(tier1_id, locale_services_id, locale_services)¶

If a Tier-1 locale services with the locale-services-id is not already present, create a new locale services. If it already exists, update Tier-1 locale services with specified attributes.

Parameters:	tier1_id (`str`) – (required) locale_services_id (`str`) – (required) locale_services (`com.vmware.nsx_policy.model_client.LocaleServices`) – (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(tier1_id, locale_services_id, locale_services)¶

If a Tier-1 locale services with the locale-services-id is not already present, create a new locale-services. If it already exists, replace the Tier-1 locale services instance with the new object. Modifying edge cluster re-allocates NSX service routers of TIER1 to a different edge cluster. You can also place edge nodes manually and provide maximum two indices for HA mode ACTIVE_STANDBY. To re-allocating edge cluster is a disruptive operation and all existing statistics of Tier1 gateway will be removed.

Parameters:	tier1_id (`str`) – (required) locale_services_id (`str`) – (required) locale_services (`com.vmware.nsx_policy.model_client.LocaleServices`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.LocaleServices`
Returns:	com.vmware.nsx_policy.model.LocaleServices
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.tier_1s_client.Segments(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id, segment_id)¶

Delete segment

Parameters:	tier1_id (`str`) – (required) segment_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

delete_0(tier1_id, segment_id)¶

Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.

Parameters:	tier1_id (`str`) – (required) segment_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(tier1_id, segment_id)¶

Read segment

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Segment`
Returns:	com.vmware.nsx_policy.model.Segment
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(tier1_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all segments under Tier-1 instance

Parameters:	tier1_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.SegmentListResult`
Returns:	com.vmware.nsx_policy.model.SegmentListResult
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(tier1_id, segment_id, segment)¶

If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes.

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) segment (`com.vmware.nsx_policy.model_client.Segment`) – (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(tier1_id, segment_id, segment)¶

If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object.

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) segment (`com.vmware.nsx_policy.model_client.Segment`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Segment`
Returns:	com.vmware.nsx_policy.model.Segment
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.tier_1s_client.State(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(tier1_id, cursor=None, enforcement_point_path=None, included_fields=None, interface_path=None, page_size=None, sort_ascending=None, sort_by=None)¶

Returns

Parameters:	tier1_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) enforcement_point_path (`str` or `None`) – Enforcement point path (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) interface_path (`str` or `None`) – Interface path for interface specific state such as IPv6 DAD state (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.Tier1GatewayState`
Returns:	com.vmware.nsx_policy.model.Tier1GatewayState
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.tier_1s_client.StaticRoutes(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id, route_id)¶

Delete Tier-1 static routes

Parameters:	tier1_id (`str`) – (required) route_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(tier1_id, route_id)¶

Read Tier-1 static routes

Parameters:	tier1_id (`str`) – (required) route_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.StaticRoutes`
Returns:	com.vmware.nsx_policy.model.StaticRoutes
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(tier1_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Tier-1 Static Routes

Parameters:	tier1_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) 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.StaticRoutesListResult`
Returns:	com.vmware.nsx_policy.model.StaticRoutesListResult
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(tier1_id, route_id, static_routes)¶

If static routes for route-id are not already present, create static routes. If it already exists, update static routes for route-id.

Parameters:	tier1_id (`str`) – (required) route_id (`str`) – (required) static_routes (`com.vmware.nsx_policy.model_client.StaticRoutes`) – (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(tier1_id, route_id, static_routes)¶

If static routes for route-id are not already present, create static routes. If it already exists, replace the static routes for route-id.

Parameters:	tier1_id (`str`) – (required) route_id (`str`) – (required) static_routes (`com.vmware.nsx_policy.model_client.StaticRoutes`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.StaticRoutes`
Returns:	com.vmware.nsx_policy.model.StaticRoutes
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.tier_1s_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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