com.vmware.nsx_policy.infra package¶

Subpackages¶

Submodules¶

com.vmware.nsx_policy.infra.deployment_zones_client module¶

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

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(deployment_zone_id, enforcementpoint_id)¶

Delete EnforcementPoint

Parameters:	deployment_zone_id (`str`) – Deployment zone id (required) enforcementpoint_id (`str`) – enforcementpoint-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(deployment_zone_id, enforcementpoint_id)¶

Read an Enforcement Point

Parameters:	deployment_zone_id (`str`) – Deployment zone id (required) enforcementpoint_id (`str`) – EnforcementPoint id (required)
Return type:	`com.vmware.nsx_policy.model_client.EnforcementPoint`
Returns:	com.vmware.nsx_policy.model.EnforcementPoint
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(deployment_zone_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all enforcementpoints for infra.

Parameters:	deployment_zone_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.EnforcementPointListResult`
Returns:	com.vmware.nsx_policy.model.EnforcementPointListResult
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(deployment_zone_id, enforcementpoint_id, enforcement_point)¶

If the passed Enforcement Point does not already exist, create a new Enforcement Point. If it already exists, patch it.

Parameters:	deployment_zone_id (`str`) – Deployment zone id (required) enforcementpoint_id (`str`) – EnforcementPoint id (required) enforcement_point (`com.vmware.nsx_policy.model_client.EnforcementPoint`) – (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(deployment_zone_id, enforcementpoint_id, enforcement_point)¶

If the passed Enforcement Point does not already exist, create a new Enforcement Point. If it already exists, replace it.

Parameters:	deployment_zone_id (`str`) – Deployment zone id (required) enforcementpoint_id (`str`) – EnforcementPoint id (required) enforcement_point (`com.vmware.nsx_policy.model_client.EnforcementPoint`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.EnforcementPoint`
Returns:	com.vmware.nsx_policy.model.EnforcementPoint
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.deployment_zones_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.nsx_policy.infra.domains_client module¶

class com.vmware.nsx_policy.infra.domains_client.CommunicationMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

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.

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, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List all communication maps 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) 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.

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.

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.

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.DiscoverySessions(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(domain_id, discovery_session_id)¶

Delete discovery session identified by discovery-session-id

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

Read discovery session identified by discovery-session-id

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

List all the discovery sessions created on a domain.

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) 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.DiscoverySessionListResult`
Returns:	com.vmware.nsx_policy.model.DiscoverySessionListResult
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, discovery_session_id, discovery_session)¶

Patch discovery session.

Parameters:	domain_id (`str`) – Domain ID (required) discovery_session_id (`str`) – Discovery session ID (required) discovery_session (`com.vmware.nsx_policy.model_client.DiscoverySession`) – (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, discovery_session_id, discovery_session)¶

Create or update discovery session.

Parameters:	domain_id (`str`) – Domain ID (required) discovery_session_id (`str`) – Discovery session ID (required) discovery_session (`com.vmware.nsx_policy.model_client.DiscoverySession`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.DiscoverySession`
Returns:	com.vmware.nsx_policy.model.DiscoverySession
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.DomainDeploymentMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(domain_id, domain_deployment_map_id)¶

Delete Domain Deployment Map

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

Read a Domain Deployment Map

Parameters:	domain_id (`str`) – Domain ID (required) domain_deployment_map_id (`str`) – Domain Deployment Map id (required)
Return type:	`com.vmware.nsx_policy.model_client.DomainDeploymentMap`
Returns:	com.vmware.nsx_policy.model.DomainDeploymentMap
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, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Domain Deployment Entries for infra.

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) 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.DomainDeploymentMapListResult`
Returns:	com.vmware.nsx_policy.model.DomainDeploymentMapListResult
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, domain_deployment_map_id, domain_deployment_map)¶

If the passed Domain Deployment Map does not already exist, create a new Domain Deployment Map. If it already exist, patch it.

Parameters:	domain_id (`str`) – Domain ID (required) domain_deployment_map_id (`str`) – Domain Deployment Map ID (required) domain_deployment_map (`com.vmware.nsx_policy.model_client.DomainDeploymentMap`) – (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, domain_deployment_map_id, domain_deployment_map)¶

If the passed Domain Deployment Map does not already exist, create a new Domain Deployment Map. If it already exist, replace it.

Parameters:	domain_id (`str`) – Domain ID (required) domain_deployment_map_id (`str`) – Domain Deployment Map ID (required) domain_deployment_map (`com.vmware.nsx_policy.model_client.DomainDeploymentMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.DomainDeploymentMap`
Returns:	com.vmware.nsx_policy.model.DomainDeploymentMap
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.EdgeCommunicationMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

get(domain_id, edge_communication_map_id)¶

Read Edge FW ns-communication-map for a domain.

Parameters:	domain_id (`str`) – (required) edge_communication_map_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.EdgeCommunicationMap`
Returns:	com.vmware.nsx_policy.model.EdgeCommunicationMap
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, edge_communication_map_id, edge_communication_map)¶

Update the communication map for a domain. This is a full replace. All the CommunicationEntries are replaced.

Parameters:	domain_id (`str`) – (required) edge_communication_map_id (`str`) – (required) edge_communication_map (`com.vmware.nsx_policy.model_client.EdgeCommunicationMap`) – (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, edge_communication_map_id, edge_communication_map)¶

Update the communication map for a domain. This is a full replace. All the CommunicationEntries are replaced.

Parameters:	domain_id (`str`) – (required) edge_communication_map_id (`str`) – (required) edge_communication_map (`com.vmware.nsx_policy.model_client.EdgeCommunicationMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.EdgeCommunicationMap`
Returns:	com.vmware.nsx_policy.model.EdgeCommunicationMap
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

delete(domain_id, group_id, force=None)¶

Delete Group

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) 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, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List Groups for a domain

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) 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.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.

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.RedirectionCommunicationMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(domain_id, redirection_map_id)¶

Delete redirection communication map.

Parameters:	domain_id (`str`) – Domain id (required) redirection_map_id (`str`) – Redirection 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(domain_id, redirection_map_id)¶

Read redirection communication map.

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

patch(domain_id, redirection_map_id, redirection_communication_map)¶

Create or update the redirection communication map.

Parameters:	domain_id (`str`) – Domain id (required) redirection_map_id (`str`) – Redirection map id (required) redirection_communication_map (`com.vmware.nsx_policy.model_client.RedirectionCommunicationMap`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(domain_id, redirection_map_id, redirection_communication_map)¶

Create or update the redirection communication map.

Parameters:	domain_id (`str`) – Domain id (required) redirection_map_id (`str`) – Redirection map id (required) redirection_communication_map (`com.vmware.nsx_policy.model_client.RedirectionCommunicationMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.RedirectionCommunicationMap`
Returns:	com.vmware.nsx_policy.model.RedirectionCommunicationMap
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

com.vmware.nsx_policy.infra.networks_client module¶

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

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(network_id)¶

Delete DNS configuration for network instance

Parameters:	network_id (`str`) – Network 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(network_id)¶

Read the DNS Forwarder for the given Network instance

Parameters:	network_id (`str`) – Network 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(network_id, policy_dns_forwarder)¶

Update the DNS Forwarder

Parameters:	network_id (`str`) – Network 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(network_id, policy_dns_forwarder)¶

Update the DNS Forwarder

Parameters:	network_id (`str`) – Network 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.networks_client.IpfixSwitchCollectionInstances(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(network_id, ipfix_switch_collection_instance_id)¶

API deletes IPFIX Switch Collection Instance.Flow forwarding to selected collector will be stopped.

Parameters:	network_id (`str`) – Network 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(network_id, ipfix_switch_collection_instance_id)¶

API will return details of IPFIX switch collection. If instance does not exist, it will return 404.

Parameters:	network_id (`str`) – Network 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(network_id, cursor=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.

Parameters:	network_id (`str`) – Network ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.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(network_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.

Parameters:	network_id (`str`) – Network 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(network_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.

Parameters:	network_id (`str`) – Network 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.networks_client.Segments(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(network_id, segment_id)¶

Delete segment

Parameters:	network_id (`str`) – Network ID (required) segment_id (`str`) – 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(network_id, segment_id)¶

Read segment

Parameters:	network_id (`str`) – Network ID (required) segment_id (`str`) – Segment ID (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(network_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all segments under network instance

Parameters:	network_id (`str`) – Network ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.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(network_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:	network_id (`str`) – Network ID (required) segment_id (`str`) – Segment ID (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

update(network_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:	network_id (`str`) – Network ID (required) segment_id (`str`) – Segment ID (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.networks_client.StaticRoutes(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(network_id, route_id)¶

Delete network static routes

Parameters:	network_id (`str`) – Network ID (required) route_id (`str`) – Route 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(network_id, route_id)¶

Read network static routes

Parameters:	network_id (`str`) – Network ID (required) route_id (`str`) – Route ID (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(network_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Network Static Routes

Parameters:	network_id (`str`) – Network ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.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(network_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:	network_id (`str`) – Network ID (required) route_id (`str`) – Route ID (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

update(network_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:	network_id (`str`) – Network ID (required) route_id (`str`) – Route ID (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.networks_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.nsx_policy.infra.partner_services_client module¶

class com.vmware.nsx_policy.infra.partner_services_client.Eula(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

create(service_name)¶

Accept EULA for given partner service for requesting customer

Parameters:	service_name (`str`) – Name of the service (required)
Return type:	`com.vmware.nsx_policy.model_client.PartnerServiceEULAStatus`
Returns:	com.vmware.nsx_policy.model.PartnerServiceEULAStatus
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
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` Unauthorized

get(service_name)¶

Get EULA status for partner service for requesting customer. It also contains link to EULA Terms and Conditions.

Parameters:	service_name (`str`) – Name of the service (required)
Return type:	`com.vmware.nsx_policy.model_client.PartnerServiceEULAStatus`
Returns:	com.vmware.nsx_policy.model.PartnerServiceEULAStatus
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
Raise:	`com.vmware.vapi.std.errors_client.Unauthenticated` Unauthorized

class com.vmware.nsx_policy.infra.partner_services_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.nsx_policy.infra.providers_client module¶

class com.vmware.nsx_policy.infra.providers_client.Bgp(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

get(provider_id)¶

Read BGP routing config

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

If an BGP routing config not present, create BGP routing config. If it already exists, update the routing config.

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

If BGP routing config is not already present, create BGP routing config. If it already exists, replace the BGP routing config with this object.

Parameters:	provider_id (`str`) – (required) bgp_routing_config (`com.vmware.nsx_policy.model_client.BgpRoutingConfig`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.BgpRoutingConfig`
Returns:	com.vmware.nsx_policy.model.BgpRoutingConfig
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.providers_client.ByodServiceInstances(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(provider_id, service_instance_id)¶

Delete policy service instance

Parameters:	provider_id (`str`) – Provider id (required) service_instance_id (`str`) – Service 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(provider_id, service_instance_id)¶

Read byod service instance

Parameters:	provider_id (`str`) – Provider id (required) service_instance_id (`str`) – Service instance id (required)
Return type:	`com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance`
Returns:	com.vmware.nsx_policy.model.ByodPolicyServiceInstance
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(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Read all service instance objects under a provider

Parameters:	provider_id (`str`) – Provider id (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.ByodPolicyServiceInstanceListResult`
Returns:	com.vmware.nsx_policy.model.ByodPolicyServiceInstanceListResult
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(provider_id, service_instance_id, byod_policy_service_instance)¶

Create Service Instance.

Parameters:	provider_id (`str`) – Provider id (required) service_instance_id (`str`) – Service instance id (required) byod_policy_service_instance (`com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance`) – (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(provider_id, service_instance_id, byod_policy_service_instance)¶

Create service instance.

Parameters:	provider_id (`str`) – Provider id (required) service_instance_id (`str`) – Byod service instance id (required) byod_policy_service_instance (`com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance`
Returns:	com.vmware.nsx_policy.model.ByodPolicyServiceInstance
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.providers_client.Groups(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(provider_id, group_id)¶

Delete the Group under Provider.

Parameters:	provider_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(provider_id, group_id)¶

Read Provider Group

Parameters:	provider_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(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Groups for Provider.

Parameters:	provider_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.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(provider_id, group_id, group)¶

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

Parameters:	provider_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(provider_id, group_id, group)¶

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

Parameters:	provider_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.providers_client.Interfaces(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(provider_id, interface_id)¶

Delete provider interface

Parameters:	provider_id (`str`) – Provider ID (required) interface_id (`str`) – Interface 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(provider_id, interface_id)¶

Read provider interface

Parameters:	provider_id (`str`) – Provider ID (required) interface_id (`str`) – Interface ID (required)
Return type:	`com.vmware.nsx_policy.model_client.ProviderInterface`
Returns:	com.vmware.nsx_policy.model.ProviderInterface
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(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Provider Interfaces

Parameters:	provider_id (`str`) – Provider ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.ProviderInterfaceListResult`
Returns:	com.vmware.nsx_policy.model.ProviderInterfaceListResult
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(provider_id, interface_id, provider_interface)¶

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

Parameters:	provider_id (`str`) – Provider ID (required) interface_id (`str`) – Interface ID (required) provider_interface (`com.vmware.nsx_policy.model_client.ProviderInterface`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.ProviderInterface`
Returns:	com.vmware.nsx_policy.model.ProviderInterface
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(provider_id, interface_id, provider_interface)¶

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

Parameters:	provider_id (`str`) – Provider ID (required) interface_id (`str`) – Interface ID (required) provider_interface (`com.vmware.nsx_policy.model_client.ProviderInterface`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.ProviderInterface`
Returns:	com.vmware.nsx_policy.model.ProviderInterface
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.providers_client.L2vpnContext(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

get(provider_id)¶

Read L2Vpn Context.

Parameters:	provider_id (`str`) – Provider id (required)
Return type:	`com.vmware.nsx_policy.model_client.L2VpnContext`
Returns:	com.vmware.nsx_policy.model.L2VpnContext
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.providers_client.L3vpnContext(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

get(provider_id)¶

Read the L3Vpn Context under provider.

Parameters:	provider_id (`str`) – Provider id (required)
Return type:	`com.vmware.nsx_policy.model_client.L3VpnContext`
Returns:	com.vmware.nsx_policy.model.L3VpnContext
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(provider_id, l3_vpn_context)¶

Create the new L3Vpn Context under provider if it does not exist. If the L3Vpn Context already exists under provider, merge with the the existing one. This is a patch. If the passed L3VpnContext has new L3VpnRules, add them to the existing L3VpnContext. If the passed L3VpnContext also has existing L3VpnRules, update the existing L3VpnRules.

Parameters:	provider_id (`str`) – Provider id (required) l3_vpn_context (`com.vmware.nsx_policy.model_client.L3VpnContext`) – (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(provider_id, l3_vpn_context)¶

Create the new L3Vpn Context under provider if it does not exist. If the L3Vpn Context already exists under provider, replace the the existing one. This is a full replace.

Parameters:	provider_id (`str`) – Provider id (required) l3_vpn_context (`com.vmware.nsx_policy.model_client.L3VpnContext`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L3VpnContext`
Returns:	com.vmware.nsx_policy.model.L3VpnContext
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.providers_client.L3vpns(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION = 'PolicyBasedL3VpnSession'¶: Possible value for l3vpnSession of method L3vpns.list().

LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION = 'RouteBasedL3VpnSession'¶: Possible value for l3vpnSession of method L3vpns.list().

delete(provider_id, l3vpn_id)¶

Delete the L3Vpn with the given id.

Parameters:	provider_id (`str`) – Provider id (required) l3vpn_id (`str`) – L3Vpn 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(provider_id, l3vpn_id)¶

Read the L3Vpn with the given id. No sensitive data is returned as part of the response.

Parameters:	provider_id (`str`) – Provider id (required) l3vpn_id (`str`) – L3Vpn id (required)
Return type:	`com.vmware.nsx_policy.model_client.L3Vpn`
Returns:	com.vmware.nsx_policy.model.L3Vpn
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(provider_id, cursor=None, included_fields=None, l3vpn_session=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of L3Vpns.

Parameters:	provider_id (`str`) – Provider id (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) l3vpn_session (`str` or `None`) – Resource type of L3Vpn Session (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.L3VpnListResult`
Returns:	com.vmware.nsx_policy.model.L3VpnListResult
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(provider_id, l3vpn_id, l3_vpn)¶

Create the new L3Vpn if it does not exist. If the L3Vpn already exists, merge with the the existing one. This is a patch. - If the passed L3Vpn is a policy-based one and has new L3VpnRules, add them to the existing L3VpnRules. - If the passed L3Vpn is a policy-based one and also has existing L3VpnRules, update the existing L3VpnRules.

Parameters:	provider_id (`str`) – Provider id (required) l3vpn_id (`str`) – L3Vpn id (required) l3_vpn (`com.vmware.nsx_policy.model_client.L3Vpn`) – (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

showsensitivedata(provider_id, l3vpn_id)¶

Read the L3Vpn with the given id. Sensitive data is returned as part of the response.

Parameters:	provider_id (`str`) – Provider id (required) l3vpn_id (`str`) – L3Vpn id (required)
Return type:	`com.vmware.nsx_policy.model_client.L3Vpn`
Returns:	com.vmware.nsx_policy.model.L3Vpn
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(provider_id, l3vpn_id, l3_vpn)¶

Create a new L3Vpn if the L3Vpn with given id does not already exist. If the L3Vpn with the given id already exists, replace the existing L3Vpn. This a full replace.

Parameters:	provider_id (`str`) – Provider id (required) l3vpn_id (`str`) – L3Vpn id (required) l3_vpn (`com.vmware.nsx_policy.model_client.L3Vpn`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L3Vpn`
Returns:	com.vmware.nsx_policy.model.L3Vpn
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.providers_client.ProviderDeploymentMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(provider_id, provider_deployment_map_id)¶

Delete Provider Deployment Map

Parameters:	provider_id (`str`) – Provider ID (required) provider_deployment_map_id (`str`) – provider-deployment-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(provider_id, provider_deployment_map_id)¶

Read a Provider Deployment Map

Parameters:	provider_id (`str`) – Provider ID (required) provider_deployment_map_id (`str`) – Provider Deployment Map id (required)
Return type:	`com.vmware.nsx_policy.model_client.ProviderDeploymentMap`
Returns:	com.vmware.nsx_policy.model.ProviderDeploymentMap
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(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Provider Deployment Entries.

Parameters:	provider_id (`str`) – Provider ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.ProviderDeploymentMapListResult`
Returns:	com.vmware.nsx_policy.model.ProviderDeploymentMapListResult
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(provider_id, provider_deployment_map_id, provider_deployment_map)¶

If the passed Provider Deployment Map does not already exist, create a new Provider Deployment Map. If it already exists, patch it.

Parameters:	provider_id (`str`) – Provider ID (required) provider_deployment_map_id (`str`) – Provider Deployment Map ID (required) provider_deployment_map (`com.vmware.nsx_policy.model_client.ProviderDeploymentMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.ProviderDeploymentMap`
Returns:	com.vmware.nsx_policy.model.ProviderDeploymentMap
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(provider_id, provider_deployment_map_id, provider_deployment_map)¶

If the passed Provider Deployment Map does not already exist, create a new Provider Deployment Map. If it already exists, replace it.

Parameters:	provider_id (`str`) – Provider ID (required) provider_deployment_map_id (`str`) – Provider Deployment Map ID (required) provider_deployment_map (`com.vmware.nsx_policy.model_client.ProviderDeploymentMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.ProviderDeploymentMap`
Returns:	com.vmware.nsx_policy.model.ProviderDeploymentMap
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.providers_client.ServiceInstances(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(provider_id, service_instance_id)¶

Delete policy service instance

Parameters:	provider_id (`str`) – Provider id (required) service_instance_id (`str`) – Service 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(provider_id, service_instance_id)¶

Read service instance

Parameters:	provider_id (`str`) – Provider id (required) service_instance_id (`str`) – Service instance id (required)
Return type:	`com.vmware.nsx_policy.model_client.PolicyServiceInstance`
Returns:	com.vmware.nsx_policy.model.PolicyServiceInstance
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(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Read all service instance objects under a provider

Parameters:	provider_id (`str`) – Provider id (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult`
Returns:	com.vmware.nsx_policy.model.PolicyServiceInstanceListResult
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(provider_id, service_instance_id, policy_service_instance)¶

Create Service Instance.

Parameters:	provider_id (`str`) – Provider id (required) service_instance_id (`str`) – Service instance id (required) policy_service_instance (`com.vmware.nsx_policy.model_client.PolicyServiceInstance`) – (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(provider_id, service_instance_id, policy_service_instance)¶

Create service instance.

Parameters:	provider_id (`str`) – Provider id (required) service_instance_id (`str`) – Service instance id (required) policy_service_instance (`com.vmware.nsx_policy.model_client.PolicyServiceInstance`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.PolicyServiceInstance`
Returns:	com.vmware.nsx_policy.model.PolicyServiceInstance
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.providers_client.ServiceInterfaces(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(provider_id, interface_id)¶

Delete service interface

Parameters:	provider_id (`str`) – Provider ID (required) interface_id (`str`) – Interface 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(provider_id, interface_id)¶

Read service interface

Parameters:	provider_id (`str`) – Provider ID (required) interface_id (`str`) – Interface ID (required)
Return type:	`com.vmware.nsx_policy.model_client.ServiceInterface`
Returns:	com.vmware.nsx_policy.model.ServiceInterface
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(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Service Interfaces

Parameters:	provider_id (`str`) – Provider ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.ServiceInterfaceListResult`
Returns:	com.vmware.nsx_policy.model.ServiceInterfaceListResult
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(provider_id, interface_id, service_interface)¶

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

Parameters:	provider_id (`str`) – Provider ID (required) interface_id (`str`) – Interface ID (required) service_interface (`com.vmware.nsx_policy.model_client.ServiceInterface`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.ServiceInterface`
Returns:	com.vmware.nsx_policy.model.ServiceInterface
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(provider_id, interface_id, service_interface)¶

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

Parameters:	provider_id (`str`) – Provider ID (required) interface_id (`str`) – Interface ID (required) service_interface (`com.vmware.nsx_policy.model_client.ServiceInterface`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.ServiceInterface`
Returns:	com.vmware.nsx_policy.model.ServiceInterface
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.providers_client.StaticRoutes(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(provider_id, route_id)¶

Delete provider static routes

Parameters:	provider_id (`str`) – Provider ID (required) route_id (`str`) – Route 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(provider_id, route_id)¶

Read provider static routes

Parameters:	provider_id (`str`) – Provider ID (required) route_id (`str`) – Route ID (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(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Provider Static Routes

Parameters:	provider_id (`str`) – Provider ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.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(provider_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:	provider_id (`str`) – Provider ID (required) route_id (`str`) – Route ID (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

update(provider_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:	provider_id (`str`) – Provider ID (required) route_id (`str`) – Route ID (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.providers_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

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

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.RealizedEntities(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

list(intent_path)¶

Get list of realized objects associated with intent object

Parameters:	intent_path (`str`) – String Path of the intent object (required)
Return type:	`com.vmware.nsx_policy.model_client.GenericPolicyRealizedResourceListResult`
Returns:	com.vmware.nsx_policy.model.GenericPolicyRealizedResourceListResult
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.RealizedEntity(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

get(realized_path=None)¶

Get realized entity uniquely identified by realized path

Parameters:	realized_path (`str` or `None`) – String Path of the realized object (optional)
Return type:	`com.vmware.nsx_policy.model_client.GenericPolicyRealizedResource`
Returns:	com.vmware.nsx_policy.model.GenericPolicyRealizedResource
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

refresh(intent_path, enforcement_point_path=None)¶

Refresh the status and statistics of all realized entities associated with given intent path synchronously.

Parameters:	intent_path (`str`) – String Path of the intent object (required) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional)
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

get(intent_path)¶

Get consolidated status of an intent object, specified by path in query parameter

Parameters:	intent_path (`str`) – String Path of the intent object (required)
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

com.vmware.nsx_policy.infra.services_client module¶

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

Bases: vmware.vapi.bindings.stub.VapiInterface

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, 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) 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