com.vmware package¶

Subpackages¶

com.vmware.nsx package

Submodules¶

com.vmware.nsx_client module¶

class com.vmware.nsx_client.Associations(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_ASSOCIATED_RESOURCE_TYPE_NSGROUP = 'NSGroup'¶: Possible value for associatedResourceType of method Associations.list().

LIST_RESOURCE_TYPE_DIRECTORYGROUP = 'DirectoryGroup'¶: Possible value for resourceType of method Associations.list().

LIST_RESOURCE_TYPE_IPSET = 'IPSet'¶: Possible value for resourceType of method Associations.list().

LIST_RESOURCE_TYPE_LOGICALPORT = 'LogicalPort'¶: Possible value for resourceType of method Associations.list().

LIST_RESOURCE_TYPE_LOGICALSWITCH = 'LogicalSwitch'¶: Possible value for resourceType of method Associations.list().

LIST_RESOURCE_TYPE_MACSET = 'MACSet'¶: Possible value for resourceType of method Associations.list().

LIST_RESOURCE_TYPE_NSGROUP = 'NSGroup'¶: Possible value for resourceType of method Associations.list().

LIST_RESOURCE_TYPE_VIRTUALMACHINE = 'VirtualMachine'¶: Possible value for resourceType of method Associations.list().

list(associated_resource_type, resource_id, resource_type, cursor=None, fetch_ancestors=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Returns information about resources that are associated with the given resource. Id and type of the resource for which associated resources are to be fetched are to be specified as query parameter in the URI. Resource type of the associated resources must be specified as query parameter.

Parameters

associated_resource_type (str) – Resource type valid for use as target in association API (required)
resource_id (str) – The resource for which associated resources are to be fetched (required)
resource_type (str) – Resource type valid for use as source in association API (required)
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
fetch_ancestors (bool or None) – Fetch complete list of associated resources considering containment and nesting (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.AssociationListResult

Returns

com.vmware.nsx.model.AssociationListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.Batch(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(batch_request, atomic=None)¶

Enables you to make multiple API requests using a single request. The batch API takes in an array of logical HTTP requests represented as JSON arrays. Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the portion of the URL after https://<nsx-mgr>/api/), optional headers array (corresponding to HTTP headers) and an optional body (for POST and PUT requests). The batch API returns an array of logical HTTP responses represented as JSON arrays. Each response has a status code, an optional headers array and an optional body (which is a JSON-encoded string).

Parameters

batch_request (com.vmware.nsx.model_client.BatchRequest) – (required)
atomic (bool or None) – transactional atomicity for the batch of requests embedded in the batch list (optional, default to false)

Return type

com.vmware.nsx.model_client.BatchResponse

Returns

com.vmware.nsx.model.BatchResponse

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.BridgeClusters(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(bridge_cluster)¶

Creates a bridge cluster. It is collection of transport nodes that will do the bridging for overlay network to vlan networks. Bridge cluster may have one or more transport nodes

Parameters: bridge_cluster (com.vmware.nsx.model_client.BridgeCluster) – (required)
Return type: com.vmware.nsx.model_client.BridgeCluster
Returns: com.vmware.nsx.model.BridgeCluster
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(bridgecluster_id)¶

Removes the specified Bridge Cluster.

Parameters: bridgecluster_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(bridgecluster_id)¶

Returns information about a specified bridge cluster.

Parameters: bridgecluster_id (str) – (required)
Return type: com.vmware.nsx.model_client.BridgeCluster
Returns: com.vmware.nsx.model.BridgeCluster
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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)¶

Returns information about all configured bridge clusters

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.model_client.BridgeClusterListResult

Returns

com.vmware.nsx.model.BridgeClusterListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(bridgecluster_id, bridge_cluster)¶

Modifies a existing bridge cluster. One of more transport nodes can be added or removed from the bridge cluster using this API.

Parameters

bridgecluster_id (str) – (required)
bridge_cluster (com.vmware.nsx.model_client.BridgeCluster) – (required)

Return type

com.vmware.nsx.model_client.BridgeCluster

Returns

com.vmware.nsx.model.BridgeCluster

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.BridgeEndpointProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(bridge_endpoint_profile)¶

Creates a Bridge Endpoint Profile. Profile contains edge cluster id, indexes of the member nodes, fialover mode and high availability mode for a Bridge EndPoint

Parameters: bridge_endpoint_profile (com.vmware.nsx.model_client.BridgeEndpointProfile) – (required)
Return type: com.vmware.nsx.model_client.BridgeEndpointProfile
Returns: com.vmware.nsx.model.BridgeEndpointProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(bridgeendpointprofile_id)¶

Deletes the specified Bridge Endpoint Profile.

Parameters: bridgeendpointprofile_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(bridgeendpointprofile_id)¶

Returns information about a specified bridge endpoint profile.

Parameters: bridgeendpointprofile_id (str) – (required)
Return type: com.vmware.nsx.model_client.BridgeEndpointProfile
Returns: com.vmware.nsx.model.BridgeEndpointProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, edge_cluster_id=None, failover_mode=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Returns information about all configured bridge endoint profiles

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
edge_cluster_id (str or None) – Edge Cluster Identifier (optional)
failover_mode (str or None) – (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.model_client.BridgeEndpointProfileListResult

Returns

com.vmware.nsx.model.BridgeEndpointProfileListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(bridgeendpointprofile_id, bridge_endpoint_profile)¶

Modifies a existing bridge endpoint profile.

Parameters

bridgeendpointprofile_id (str) – (required)
bridge_endpoint_profile (com.vmware.nsx.model_client.BridgeEndpointProfile) – (required)

Return type

com.vmware.nsx.model_client.BridgeEndpointProfile

Returns

com.vmware.nsx.model.BridgeEndpointProfile

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.BridgeEndpoints(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(bridge_endpoint)¶

Creates a Bridge Endpoint. It describes the physical attributes of the bridge like vlan. A logical port can be attached to a vif providing bridging functionality from the logical overlay network to the physical vlan network

Parameters: bridge_endpoint (com.vmware.nsx.model_client.BridgeEndpoint) – (required)
Return type: com.vmware.nsx.model_client.BridgeEndpoint
Returns: com.vmware.nsx.model.BridgeEndpoint
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(bridgeendpoint_id)¶

Deletes the specified Bridge Endpoint.

Parameters: bridgeendpoint_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(bridgeendpoint_id)¶

Returns information about a specified bridge endpoint.

Parameters: bridgeendpoint_id (str) – (required)
Return type: com.vmware.nsx.model_client.BridgeEndpoint
Returns: com.vmware.nsx.model.BridgeEndpoint
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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(bridge_cluster_id=None, bridge_endpoint_profile_id=None, cursor=None, included_fields=None, logical_switch_id=None, page_size=None, sort_ascending=None, sort_by=None, vlan_transport_zone_id=None)¶

Returns information about all configured bridge endoints

Parameters

bridge_cluster_id (str or None) – Bridge Cluster Identifier (optional)
bridge_endpoint_profile_id (str or None) – Bridge endpoint profile used by the edge cluster (optional)
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)
logical_switch_id (str or None) – Logical Switch Identifier (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)
vlan_transport_zone_id (str or None) – VLAN transport zone id used by the edge cluster (optional)

Return type

com.vmware.nsx.model_client.BridgeEndpointListResult

Returns

com.vmware.nsx.model.BridgeEndpointListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(bridgeendpoint_id, bridge_endpoint)¶

Modifies a existing bridge endpoint.

Parameters

bridgeendpoint_id (str) – (required)
bridge_endpoint (com.vmware.nsx.model_client.BridgeEndpoint) – (required)

Return type

com.vmware.nsx.model_client.BridgeEndpoint

Returns

com.vmware.nsx.model.BridgeEndpoint

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.Cluster(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

backuptoremote()¶

Request one-time backup. The backup will be uploaded using the same server configuration as for automatic backup.

Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

create(target_node_id, target_uri)¶

Invoke POST request on target cluster node

Parameters

target_node_id (str) – Target node UUID or keyword self (required)
target_uri (str) – URI of API to invoke on target node (required)

Raise

com.vmware.vapi.std.errors_client.TimedOut Gateway Timeout

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

delete(target_node_id, target_uri)¶

Invoke DELETE request on target cluster node

Parameters

target_node_id (str) – Target node UUID or keyword self (required)
target_uri (str) – URI of API to invoke on target node (required)

Raise

com.vmware.vapi.std.errors_client.TimedOut Gateway Timeout

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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()¶

Returns information about the NSX cluster configuration. An NSX cluster has two functions or purposes, commonly referred to as “roles.” These two roles are control and management. Each NSX installation has a single cluster. Separate NSX clusters do not share data. In other words, a given data-plane node is attached to only one cluster, not to multiple clusters.

Return type: com.vmware.nsx.model_client.ClusterConfig
Returns: com.vmware.nsx.model.ClusterConfig
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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_0(target_node_id, target_uri)¶

Invoke GET request on target cluster node

Parameters

target_node_id (str) – Target node UUID or keyword self (required)
target_uri (str) – URI of API to invoke on target node (required)

Raise

com.vmware.vapi.std.errors_client.TimedOut Gateway Timeout

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

summarizeinventorytoremote()¶

Request one-time inventory summary. The backup will be uploaded using the same server configuration as for an automatic backup.

Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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(target_node_id, target_uri)¶

Invoke PUT request on target cluster node

Parameters

target_node_id (str) – Target node UUID or keyword self (required)
target_uri (str) – URI of API to invoke on target node (required)

Raise

com.vmware.vapi.std.errors_client.TimedOut Gateway Timeout

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.ClusterProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE = 'BridgeHighAvailabilityClusterProfile'¶: Possible value for resourceType of method ClusterProfiles.list().

LIST_RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILE = 'EdgeHighAvailabilityProfile'¶: Possible value for resourceType of method ClusterProfiles.list().

create(cluster_profile)¶

Create a cluster profile. The resource_type is required.

Parameters: cluster_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.ClusterProfile.
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.ClusterProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.ClusterProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(cluster_profile_id)¶

Delete a specified cluster profile.

Parameters: cluster_profile_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(cluster_profile_id)¶

Returns information about a specified cluster profile.

Parameters: cluster_profile_id (str) – (required)
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.ClusterProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.ClusterProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, include_system_owned=None, included_fields=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)¶

Returns paginated list of cluster profiles Cluster profiles define policies for edge cluster and bridge cluster.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_system_owned (bool or None) – Whether the list result contains system resources (optional, default to true)
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)
resource_type (str or None) – Supported cluster profiles. (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.ClusterProfileListResult

Returns

com.vmware.nsx.model.ClusterProfileListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(cluster_profile_id, cluster_profile)¶

Modifie a specified cluster profile. The body of the PUT request must include the resource_type.

Parameters

cluster_profile_id (str) – (required)
cluster_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.ClusterProfile.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.ClusterProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.ClusterProfile.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.ComputeCollectionTransportNodeTemplates(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(compute_collection_transport_node_template)¶

If automated transport node creation is configured on compute collection, this template will serve as the default setting for transport node creation.

Parameters: compute_collection_transport_node_template (com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplate) – (required)
Return type: com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplate
Returns: com.vmware.nsx.model.ComputeCollectionTransportNodeTemplate
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(template_id)¶

Delete the specified compute collection transport node template.

Parameters: template_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(template_id)¶

Returns compute collection transportnode template by id

Parameters: template_id (str) – (required)
Return type: com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplate
Returns: com.vmware.nsx.model.ComputeCollectionTransportNodeTemplate
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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(compute_collection_id=None)¶

Returns all eligible compute collection transportnode templates

Parameters: compute_collection_id (str or None) – Compute collection id (optional)
Return type: com.vmware.nsx.model_client.TransportNodeTemplateListResult
Returns: com.vmware.nsx.model.TransportNodeTemplateListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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(template_id, compute_collection_transport_node_template)¶

Update configuration of compute collection transportnode template. Compute_collection_id isn’t allowed to be changed since it represents the association between ComputeCollection and this template. This is determined when ComputeCollectionTransportNodeTemplate got created.

Parameters

template_id (str) – (required)
compute_collection_transport_node_template (com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplate) – (required)

Return type

com.vmware.nsx.model_client.ComputeCollectionTransportNodeTemplate

Returns

com.vmware.nsx.model.ComputeCollectionTransportNodeTemplate

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.EdgeClusters(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(edge_cluster)¶

Creates a new edge cluster. It only supports homogeneous members. The TransportNodes backed by EdgeNode are only allowed in cluster members. DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is recommended to be the same. EdgeCluster supports members of different deployment types.

Parameters: edge_cluster (com.vmware.nsx.model_client.EdgeCluster) – (required)
Return type: com.vmware.nsx.model_client.EdgeCluster
Returns: com.vmware.nsx.model.EdgeCluster
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(edge_cluster_id)¶

Deletes the specified edge cluster.

Parameters: edge_cluster_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(edge_cluster_id)¶

Returns information about the specified edge cluster.

Parameters: edge_cluster_id (str) – (required)
Return type: com.vmware.nsx.model_client.EdgeCluster
Returns: com.vmware.nsx.model.EdgeCluster
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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)¶

Returns information about the configured edge clusters, which enable you to group together transport nodes of the type EdgeNode and apply fabric profiles to all members of the edge cluster. Each edge node can participate in only one edge cluster.

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.model_client.EdgeClusterListResult

Returns

com.vmware.nsx.model.EdgeClusterListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

replacetransportnode(edge_cluster_id, edge_cluster_member_transport_node)¶

Replace the transport node in the specified member of the edge-cluster. This is a disruptive action. This will move all the LogicalRouterPorts(uplink and routerLink) host on the old transport_node to the new transport_node. The transportNode cannot be present in another member of any edgeClusters.

Parameters

edge_cluster_id (str) – (required)
edge_cluster_member_transport_node (com.vmware.nsx.model_client.EdgeClusterMemberTransportNode) – (required)

Return type

com.vmware.nsx.model_client.EdgeCluster

Returns

com.vmware.nsx.model.EdgeCluster

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(edge_cluster_id, edge_cluster)¶

Modifies the specified edge cluster. Modifiable parameters include the description, display_name, transport-node-id. If the optional fabric_profile_binding is included, resource_type and profile_id are required. User should do a GET on the edge-cluster and obtain the payload and retain the member_index of the existing members as returning in the GET output. For new member additions, the member_index cannot be defined by the user, user can read the system allocated index to the new member in the output of this API call or by doing a GET call. User cannot use this PUT api to replace the transport_node of an existing member because this is a disruption action, we have exposed a explicit API for doing so, refer to “ReplaceEdgeClusterMemberTransportNode” EdgeCluster only supports homogeneous members. The TransportNodes backed by EdgeNode are only allowed in cluster members. DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is recommended to be the same. EdgeCluster supports members of different deployment types.

Parameters

edge_cluster_id (str) – (required)
edge_cluster (com.vmware.nsx.model_client.EdgeCluster) – (required)

Return type

com.vmware.nsx.model_client.EdgeCluster

Returns

com.vmware.nsx.model.EdgeCluster

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.ErrorResolver(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(error_id)¶

Returns some metadata about the given error_id. This includes information of whether there is a resolver present for the given error_id and its associated user input data

Parameters: error_id (str) – (required)
Return type: com.vmware.nsx.model_client.ErrorResolverInfo
Returns: com.vmware.nsx.model.ErrorResolverInfo
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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()¶

Returns a list of metadata for all the error resolvers registered.

Return type: com.vmware.nsx.model_client.ErrorResolverInfoList
Returns: com.vmware.nsx.model.ErrorResolverInfoList
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

resolveerror(error_resolver_metadata_list)¶

Invokes the corresponding error resolver for the given error(s) present in the payload

Parameters: error_resolver_metadata_list (com.vmware.nsx.model_client.ErrorResolverMetadataList) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_client.HostSwitchProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_HOSTSWITCH_PROFILE_TYPE_EXTRACONFIGHOSTSWITCHPROFILE = 'ExtraConfigHostSwitchProfile'¶: Possible value for hostswitchProfileType of method HostSwitchProfiles.list().

LIST_HOSTSWITCH_PROFILE_TYPE_LLDPHOSTSWITCHPROFILE = 'LldpHostSwitchProfile'¶: Possible value for hostswitchProfileType of method HostSwitchProfiles.list().

LIST_HOSTSWITCH_PROFILE_TYPE_NIOCPROFILE = 'NiocProfile'¶: Possible value for hostswitchProfileType of method HostSwitchProfiles.list().

LIST_HOSTSWITCH_PROFILE_TYPE_UPLINKHOSTSWITCHPROFILE = 'UplinkHostSwitchProfile'¶: Possible value for hostswitchProfileType of method HostSwitchProfiles.list().

create(base_host_switch_profile)¶

Creates a hostswitch profile. The resource_type is required. For uplink profiles, the teaming and policy parameters are required. By default, the mtu is 1600 and the transport_vlan is 0. The supported MTU range is 1280 through 9000.

Parameters: base_host_switch_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.BaseHostSwitchProfile.
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.BaseHostSwitchProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(host_switch_profile_id)¶

Deletes a specified hostswitch profile.

Parameters: host_switch_profile_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(host_switch_profile_id)¶

Returns information about a specified hostswitch profile.

Parameters: host_switch_profile_id (str) – (required)
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.BaseHostSwitchProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, hostswitch_profile_type=None, include_system_owned=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, uplink_teaming_policy_name=None)¶

Returns information about the configured hostswitch profiles. Hostswitch profiles define networking policies for hostswitches (sometimes referred to as bridges in OVS). Currently, only uplink teaming is supported. Uplink teaming allows NSX to load balance traffic across different physical NICs (PNICs) on the hypervisor hosts. Multiple teaming policies are supported, including LACP active, LACP passive, load balancing based on source ID, and failover order.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
hostswitch_profile_type (str or None) – Supported HostSwitch profiles. (optional)
include_system_owned (bool or None) – Whether the list result contains system resources (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)
uplink_teaming_policy_name (str or None) – The host switch profile’s uplink teaming policy name (optional)

Return type

com.vmware.nsx.model_client.HostSwitchProfilesListResult

Returns

com.vmware.nsx.model.HostSwitchProfilesListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(host_switch_profile_id, base_host_switch_profile)¶

Modifies a specified hostswitch profile. The body of the PUT request must include the resource_type. For uplink profiles, the put request must also include teaming parameters. Modifiable attributes include display_name, mtu, and transport_vlan. For uplink teaming policies, uplink_name and policy are also modifiable.

Parameters

host_switch_profile_id (str) – (required)
base_host_switch_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.BaseHostSwitchProfile.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.BaseHostSwitchProfile.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.IpSets(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(ip_set)¶

Creates a new IPSet that can group either IPv4 or IPv6 individual ip addresses, ranges or subnets.

Parameters: ip_set (com.vmware.nsx.model_client.IPSet) – (required)
Return type: com.vmware.nsx.model_client.IPSet
Returns: com.vmware.nsx.model.IPSet
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(ip_set_id, force=None)¶

Deletes the specified IPSet. By default, if the IPSet is added to an NSGroup, it won’t be deleted. In such situations, pass “force=true” as query param to force delete the IPSet.

Parameters

ip_set_id (str) – IPSet 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.ConcurrentChange Conflict

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

get(ip_set_id)¶

Returns information about the specified IPSet

Parameters: ip_set_id (str) – IPSet Id (required)
Return type: com.vmware.nsx.model_client.IPSet
Returns: com.vmware.nsx.model.IPSet
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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)¶

Returns paginated list of IPSets

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.model_client.IPSetListResult

Returns

com.vmware.nsx.model.IPSetListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(ip_set_id, ip_set)¶

Updates the specified IPSet. Modifiable parameters include description, display_name and ip_addresses.

Parameters

ip_set_id (str) – IPSet Id (required)
ip_set (com.vmware.nsx.model_client.IPSet) – (required)

Return type

com.vmware.nsx.model_client.IPSet

Returns

com.vmware.nsx.model.IPSet

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.IpfixCollectorProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(ipfix_collector_upm_profile)¶

Create a new IPFIX collector profile with essential properties.

Parameters: ipfix_collector_upm_profile (com.vmware.nsx.model_client.IpfixCollectorUpmProfile) – (required)
Return type: com.vmware.nsx.model_client.IpfixCollectorUpmProfile
Returns: com.vmware.nsx.model.IpfixCollectorUpmProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(ipfix_collector_profile_id)¶

Delete an existing IPFIX collector profile by ID.

Parameters: ipfix_collector_profile_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(ipfix_collector_profile_id)¶

Get an existing IPFIX collector profile by profile ID.

Parameters: ipfix_collector_profile_id (str) – (required)
Return type: com.vmware.nsx.model_client.IpfixCollectorUpmProfile
Returns: com.vmware.nsx.model.IpfixCollectorUpmProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, profile_types=None, sort_ascending=None, sort_by=None)¶

Query IPFIX collector profiles with list parameters. List result can be filtered by profile type defined by IpfixCollectorUpmProfileType.

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)
profile_types (str or None) – IPFIX Collector Profile Type List (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.IpfixCollectorUpmProfileListResult

Returns

com.vmware.nsx.model.IpfixCollectorUpmProfileListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(ipfix_collector_profile_id, ipfix_collector_upm_profile)¶

Update an existing IPFIX collector profile with profile ID and modified properties.

Parameters

ipfix_collector_profile_id (str) – (required)
ipfix_collector_upm_profile (com.vmware.nsx.model_client.IpfixCollectorUpmProfile) – (required)

Return type

com.vmware.nsx.model_client.IpfixCollectorUpmProfile

Returns

com.vmware.nsx.model.IpfixCollectorUpmProfile

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.IpfixObsPoints(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

list()¶

Deprecated - Please use /ipfix-profiles for switch IPFIX profile and /ipfix-collector-profiles for IPFIX collector profile.

Return type: com.vmware.nsx.model_client.IpfixObsPointsListResult
Returns: com.vmware.nsx.model.IpfixObsPointsListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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_client.IpfixProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_APPLIED_TO_ENTITY_TYPE_LOGICALPORT = 'LogicalPort'¶: Possible value for appliedToEntityType of method IpfixProfiles.list().

LIST_APPLIED_TO_ENTITY_TYPE_LOGICALSWITCH = 'LogicalSwitch'¶: Possible value for appliedToEntityType of method IpfixProfiles.list().

LIST_APPLIED_TO_ENTITY_TYPE_NSGROUP = 'NSGroup'¶: Possible value for appliedToEntityType of method IpfixProfiles.list().

create(ipfix_upm_profile)¶

Create a new IPFIX profile with essential properties.

Parameters: ipfix_upm_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.IpfixUpmProfile.
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.IpfixUpmProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.IpfixUpmProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(ipfix_profile_id)¶

Delete an existing IPFIX profile by ID.

Parameters: ipfix_profile_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(ipfix_profile_id)¶

Get an existing IPFIX profile by profile ID.

Parameters: ipfix_profile_id (str) – (required)
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.IpfixUpmProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.IpfixUpmProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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(applied_to_entity_id=None, applied_to_entity_type=None, cursor=None, included_fields=None, page_size=None, profile_types=None, sort_ascending=None, sort_by=None)¶

Query IPFIX profiles with list parameters. List result can be filtered by profile type defined by IpfixUpmProfileType.

Parameters

applied_to_entity_id (str or None) – ID of Entity Applied with Profile (optional)
applied_to_entity_type (str or None) – Supported Entity Types (optional)
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)
profile_types (str or None) – IPFIX Profile Type List (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.IpfixUpmProfileListResult

Returns

com.vmware.nsx.model.IpfixUpmProfileListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(ipfix_profile_id, ipfix_upm_profile)¶

Update an existing IPFIX profile with profile ID and modified properties.

Parameters

ipfix_profile_id (str) – (required)
ipfix_upm_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.IpfixUpmProfile.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.IpfixUpmProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.IpfixUpmProfile.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.Licenses(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(license)¶

This will add a license key to the system. The API supports adding only one license key for each license edition type - Standard, Advanced or Enterprise. If a new license key is tried to add for an edition for which the license key already exists, then this API will return an error.

Parameters: license (com.vmware.nsx.model_client.License) – (required)
Return type: com.vmware.nsx.model_client.License
Returns: com.vmware.nsx.model.License
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(license_key)¶

Deprecated. Use POST /licenses?action=delete API instead.

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

delete_0(license)¶

This will delete the license key identified in the request body by “license_key” and its properties from the system. Attempting to delete the last license key will result in an error.

Parameters: license (com.vmware.nsx.model_client.License) – (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()¶

Deprecated. Use the GET /licenses API instead.

Return type: com.vmware.nsx.model_client.License
Returns: com.vmware.nsx.model.License
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

getlicensebykey(license_key)¶

Deprecated. Use GET /licenses API instead.

Parameters: license_key (str) – (required)
Return type: com.vmware.nsx.model_client.License
Returns: com.vmware.nsx.model.License
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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()¶

Returns all licenses.

Return type: com.vmware.nsx.model_client.LicensesListResult
Returns: com.vmware.nsx.model.LicensesListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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(license)¶

Deprecated. Use the POST /licenses API instead

Parameters: license (com.vmware.nsx.model_client.License) – (required)
Return type: com.vmware.nsx.model_client.License
Returns: com.vmware.nsx.model.License
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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_client.LogicalPorts(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_ATTACHMENT_TYPE_BRIDGEENDPOINT = 'BRIDGEENDPOINT'¶: Possible value for attachmentType of method LogicalPorts.list().

LIST_ATTACHMENT_TYPE_DHCP_SERVICE = 'DHCP_SERVICE'¶: Possible value for attachmentType of method LogicalPorts.list().

LIST_ATTACHMENT_TYPE_L2VPN_SESSION = 'L2VPN_SESSION'¶: Possible value for attachmentType of method LogicalPorts.list().

LIST_ATTACHMENT_TYPE_LOGICALROUTER = 'LOGICALROUTER'¶: Possible value for attachmentType of method LogicalPorts.list().

LIST_ATTACHMENT_TYPE_METADATA_PROXY = 'METADATA_PROXY'¶: Possible value for attachmentType of method LogicalPorts.list().

LIST_ATTACHMENT_TYPE_NONE = 'NONE'¶: Possible value for attachmentType of method LogicalPorts.list().

LIST_ATTACHMENT_TYPE_VIF = 'VIF'¶: Possible value for attachmentType of method LogicalPorts.list().

create(logical_port)¶

Creates a new logical switch port. The required parameters are the associated logical_switch_id and admin_state (UP or DOWN). Optional parameters are the attachment and switching_profile_ids. If you don’t specify switching_profile_ids, default switching profiles are assigned to the port. If you don’t specify an attachment, the switch port remains empty. To configure an attachment, you must specify an id, and optionally you can specify an attachment_type (VIF or LOGICALROUTER). The attachment_type is VIF by default.

Parameters: logical_port (com.vmware.nsx.model_client.LogicalPort) – (required)
Return type: com.vmware.nsx.model_client.LogicalPort
Returns: com.vmware.nsx.model.LogicalPort
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(lport_id, detach=None)¶

Deletes the specified logical switch port. By default, if logical port has attachments, or it is added to any NSGroup, the deletion will be failed. Option detach could be used for deleting logical port forcibly.

Parameters

lport_id (str) – (required)
detach (bool or None) – force delete even if attached or referenced by a group (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(lport_id)¶

Returns information about a specified logical port.

Parameters: lport_id (str) – (required)
Return type: com.vmware.nsx.model_client.LogicalPort
Returns: com.vmware.nsx.model.LogicalPort
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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(attachment_id=None, attachment_type=None, bridge_cluster_id=None, container_ports_only=None, cursor=None, diagnostic=None, included_fields=None, logical_switch_id=None, page_size=None, parent_vif_id=None, sort_ascending=None, sort_by=None, switching_profile_id=None, transport_node_id=None, transport_zone_id=None)¶

Returns information about all configured logical switch ports. Logical switch ports connect to VM virtual network interface cards (NICs). Each logical port is associated with one logical switch.

Parameters

attachment_id (str or None) – Logical Port attachment Id (optional)
attachment_type (str or None) – Type of attachment for logical port; for query only. (optional)
bridge_cluster_id (str or None) – Bridge Cluster identifier (optional)
container_ports_only (bool or None) – Only container VIF logical ports will be returned if true (optional, default to false)
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
diagnostic (bool or None) – Flag to enable showing of transit logical port. (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
logical_switch_id (str or None) – Logical Switch identifier (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
parent_vif_id (str or None) – ID of the VIF of type PARENT (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)
switching_profile_id (str or None) – Network Profile identifier (optional)
transport_node_id (str or None) – Transport node identifier (optional)
transport_zone_id (str or None) – Transport zone identifier (optional)

Return type

com.vmware.nsx.model_client.LogicalPortListResult

Returns

com.vmware.nsx.model.LogicalPortListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(lport_id, logical_port)¶

Modifies an existing logical switch port. Parameters that can be modified include attachment_type (LOGICALROUTER, VIF), admin_state (UP or DOWN), attachment id and switching_profile_ids. You cannot modify the logical_switch_id. In other words, you cannot move an existing port from one switch to another switch.

Parameters

lport_id (str) – (required)
logical_port (com.vmware.nsx.model_client.LogicalPort) – (required)

Return type

com.vmware.nsx.model_client.LogicalPort

Returns

com.vmware.nsx.model.LogicalPort

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.LogicalRouterPorts(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT = 'LogicalRouterCentralizedServicePort'¶: Possible value for resourceType of method LogicalRouterPorts.list().

LIST_RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORT = 'LogicalRouterDownLinkPort'¶: Possible value for resourceType of method LogicalRouterPorts.list().

LIST_RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORT = 'LogicalRouterIPTunnelPort'¶: Possible value for resourceType of method LogicalRouterPorts.list().

LIST_RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0 = 'LogicalRouterLinkPortOnTIER0'¶: Possible value for resourceType of method LogicalRouterPorts.list().

LIST_RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1 = 'LogicalRouterLinkPortOnTIER1'¶: Possible value for resourceType of method LogicalRouterPorts.list().

LIST_RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORT = 'LogicalRouterLoopbackPort'¶: Possible value for resourceType of method LogicalRouterPorts.list().

LIST_RESOURCE_TYPE_LOGICALROUTERUPLINKPORT = 'LogicalRouterUpLinkPort'¶: Possible value for resourceType of method LogicalRouterPorts.list().

create(logical_router_port)¶

Creates a logical router port. The required parameters include resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort); and logical_router_id (the router to which each logical router port is assigned). The service_bindings parameter is optional.

Parameters: logical_router_port (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.LogicalRouterPort.
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.LogicalRouterPort The return value will contain all the attributes defined in com.vmware.nsx.model_client.LogicalRouterPort.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(logical_router_port_id, force=None)¶

Deletes the specified logical router port. You must delete logical router ports before you can delete the associated logical router. To Delete Tier0 router link port you must have to delete attached tier1 router link port, otherwise pass “force=true” as query param to force delete the Tier0 router link port.

Parameters

logical_router_port_id (str) – (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(logical_router_port_id)¶

Returns information about the specified logical router port.

Parameters: logical_router_port_id (str) – (required)
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.LogicalRouterPort The return value will contain all the attributes defined in com.vmware.nsx.model_client.LogicalRouterPort.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, logical_router_id=None, logical_switch_id=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)¶

Returns information about all logical router ports. Information includes the resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort); logical_router_id (the router to which each logical router port is assigned); and any service_bindings (such as DHCP relay service). The GET request can include a query parameter (logical_router_id or logical_switch_id).

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)
logical_router_id (str or None) – Logical Router identifier (optional)
logical_switch_id (str or None) – Logical Switch identifier (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
resource_type (str or None) – Resource types of logical router port (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.LogicalRouterPortListResult

Returns

com.vmware.nsx.model.LogicalRouterPortListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(logical_router_port_id, logical_router_port)¶

Modifies the specified logical router port. Required parameters include the resource_type and logical_router_id. Modifiable parameters include the resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort), logical_router_id (to reassign the port to a different router), and service_bindings.

Parameters

logical_router_port_id (str) – (required)
logical_router_port (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.LogicalRouterPort.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.LogicalRouterPort The return value will contain all the attributes defined in com.vmware.nsx.model_client.LogicalRouterPort.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.LogicalRouters(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_ROUTER_TYPE_TIER0 = 'TIER0'¶: Possible value for routerType of method LogicalRouters.list().

LIST_ROUTER_TYPE_TIER1 = 'TIER1'¶: Possible value for routerType of method LogicalRouters.list().

create(logical_router)¶

Creates a logical router. The required parameters are router_type (TIER0 or TIER1) and edge_cluster_id (TIER0 only). Optional parameters include internal and external transit network addresses.

Parameters: logical_router (com.vmware.nsx.model_client.LogicalRouter) – (required)
Return type: com.vmware.nsx.model_client.LogicalRouter
Returns: com.vmware.nsx.model.LogicalRouter
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(logical_router_id, force=None)¶

Deletes the specified logical router. You must delete associated logical router ports before you can delete a logical router. Otherwise use force delete which will delete all related ports and other entities associated with that LR. To force delete logical router pass force=true in query param.

Parameters

logical_router_id (str) – (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(logical_router_id)¶

Returns information about the specified logical router.

Parameters: logical_router_id (str) – (required)
Return type: com.vmware.nsx.model_client.LogicalRouter
Returns: com.vmware.nsx.model.LogicalRouter
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, router_type=None, sort_ascending=None, sort_by=None)¶

Returns information about all logical routers, including the UUID, internal and external transit network addresses, and the router type (TIER0 or TIER1). You can get information for only TIER0 routers or only the TIER1 routers by including the router_type query parameter.

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)
router_type (str or None) – Type of Logical Router (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.LogicalRouterListResult

Returns

com.vmware.nsx.model.LogicalRouterListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

reallocate(logical_router_id, service_router_allocation_config)¶

API to re allocate edge node placement for TIER1 logical router. You can re-allocate service routers of TIER1 in same edge cluster or different edge cluster. You can also place edge nodes manually and provide maximum two indices for HA mode ACTIVE_STANDBY. To re-allocate on new edge cluster you must have existing edge cluster for TIER1 logical router. This will be disruptive operation and all existing statistics of logical router will be remove.

Parameters

logical_router_id (str) – (required)
service_router_allocation_config (com.vmware.nsx.model_client.ServiceRouterAllocationConfig) – (required)

Return type

com.vmware.nsx.model_client.LogicalRouter

Returns

com.vmware.nsx.model.LogicalRouter

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

reprocess(logical_router_id)¶

Reprocess logical router configuration and configuration of related entities like logical router ports, static routing, etc. Any missing Updates are published to controller.

Parameters: logical_router_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

update(logical_router_id, logical_router)¶

Modifies the specified logical router. Modifiable attributes include the internal_transit_network, external_transit_networks, and edge_cluster_id (for TIER0 routers).

Parameters

logical_router_id (str) – (required)
logical_router (com.vmware.nsx.model_client.LogicalRouter) – (required)

Return type

com.vmware.nsx.model_client.LogicalRouter

Returns

com.vmware.nsx.model.LogicalRouter

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.LogicalSwitches(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_TRANSPORT_TYPE_OVERLAY = 'OVERLAY'¶: Possible value for transportType of method LogicalSwitches.list().

LIST_TRANSPORT_TYPE_VLAN = 'VLAN'¶: Possible value for transportType of method LogicalSwitches.list().

create(logical_switch)¶

Creates a new logical switch. The request must include the transport_zone_id, display_name, and admin_state (UP or DOWN). The replication_mode (MTEP or SOURCE) is required for overlay logical switches, but not for VLAN-based logical switches. A vlan needs to be provided for VLAN-based logical switches

Parameters: logical_switch (com.vmware.nsx.model_client.LogicalSwitch) – (required)
Return type: com.vmware.nsx.model_client.LogicalSwitch
Returns: com.vmware.nsx.model.LogicalSwitch
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(lswitch_id, cascade=None, detach=None)¶

Removes a logical switch from the associated overlay or VLAN transport zone. By default, a logical switch cannot be deleted if there are logical ports on the switch, or it is added to a NSGroup. Cascade option can be used to delete all ports and the logical switch. Detach option can be used to delete the logical switch forcibly.

Parameters

lswitch_id (str) – (required)
cascade (bool or None) – Delete a Logical Switch and all the logical ports in it, if none of the logical ports have any attachment. (optional, default to false)
detach (bool or None) – Force delete a logical switch (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(lswitch_id)¶

Returns information about the specified logical switch Id.

Parameters: lswitch_id (str) – (required)
Return type: com.vmware.nsx.model_client.LogicalSwitch
Returns: com.vmware.nsx.model.LogicalSwitch
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, diagnostic=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, switching_profile_id=None, transport_type=None, transport_zone_id=None, uplink_teaming_policy_name=None, vlan=None, vni=None)¶

Returns information about all configured logical switches.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
diagnostic (bool or None) – Flag to enable showing of transit logical switch. (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)
switching_profile_id (str or None) – Switching Profile identifier (optional)
transport_type (str or None) – Mode of transport supported in the transport zone for this logical switch (optional)
transport_zone_id (str or None) – Transport zone identifier (optional)
uplink_teaming_policy_name (str or None) – The logical switch’s uplink teaming policy name (optional)
vlan (long or None) – Virtual Local Area Network Identifier (optional)
vni (long or None) – VNI of the OVERLAY LogicalSwitch(es) to return. (optional)

Return type

com.vmware.nsx.model_client.LogicalSwitchListResult

Returns

com.vmware.nsx.model.LogicalSwitchListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(lswitch_id, logical_switch)¶

Modifies attributes of an existing logical switch. Modifiable attributes include admin_state, replication_mode, switching_profile_ids and VLAN spec. You cannot modify the original transport_zone_id.

Parameters

lswitch_id (str) – (required)
logical_switch (com.vmware.nsx.model_client.LogicalSwitch) – (required)

Return type

com.vmware.nsx.model_client.LogicalSwitch

Returns

com.vmware.nsx.model.LogicalSwitch

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.MacSets(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(m_ac_set)¶

Creates a new MACSet that can group individual MAC addresses.

Parameters: m_ac_set (com.vmware.nsx.model_client.MACSet) – (required)
Return type: com.vmware.nsx.model_client.MACSet
Returns: com.vmware.nsx.model.MACSet
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(mac_set_id, force=None)¶

Deletes the specified MACSet. By default, if the MACSet is added to an NSGroup, it won’t be deleted. In such situations, pass “force=true” as query param to force delete the MACSet.

Parameters

mac_set_id (str) – MACSet 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.ConcurrentChange Conflict

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

get(mac_set_id)¶

Returns information about the specified MACSet

Parameters: mac_set_id (str) – MACSet Id (required)
Return type: com.vmware.nsx.model_client.MACSet
Returns: com.vmware.nsx.model.MACSet
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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)¶

Returns paginated list of MACSets

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.model_client.MACSetListResult

Returns

com.vmware.nsx.model.MACSetListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(mac_set_id, m_ac_set)¶

Updates the specified MACSet. Modifiable parameters include the description, display_name and mac_addresses.

Parameters

mac_set_id (str) – MACSet Id (required)
m_ac_set (com.vmware.nsx.model_client.MACSet) – (required)

Return type

com.vmware.nsx.model_client.MACSet

Returns

com.vmware.nsx.model.MACSet

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.MdProxies(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(metadata_proxy)¶

Create a metadata proxy

Parameters: metadata_proxy (com.vmware.nsx.model_client.MetadataProxy) – (required)
Return type: com.vmware.nsx.model_client.MetadataProxy
Returns: com.vmware.nsx.model.MetadataProxy
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(proxy_id)¶

Delete a metadata proxy

Parameters: proxy_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(proxy_id)¶

Get a metadata proxy

Parameters: proxy_id (str) – (required)
Return type: com.vmware.nsx.model_client.MetadataProxy
Returns: com.vmware.nsx.model.MetadataProxy
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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)¶

Get a paginated list of metadata proxies

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.model_client.MetadataProxyListResult

Returns

com.vmware.nsx.model.MetadataProxyListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(proxy_id, metadata_proxy)¶

Update a metadata proxy

Parameters

proxy_id (str) – (required)
metadata_proxy (com.vmware.nsx.model_client.MetadataProxy) – (required)

Return type

com.vmware.nsx.model_client.MetadataProxy

Returns

com.vmware.nsx.model.MetadataProxy

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.Migration(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

upgrademc()¶

Upgrade the migration coordinator.

Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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_client.MirrorSessions(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(port_mirroring_session)¶

Create a mirror session

Parameters: port_mirroring_session (com.vmware.nsx.model_client.PortMirroringSession) – (required)
Return type: com.vmware.nsx.model_client.PortMirroringSession
Returns: com.vmware.nsx.model.PortMirroringSession
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(mirror_session_id)¶

Delete the mirror session

Parameters: mirror_session_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(mirror_session_id)¶

Get the mirror session

Parameters: mirror_session_id (str) – (required)
Return type: com.vmware.nsx.model_client.PortMirroringSession
Returns: com.vmware.nsx.model.PortMirroringSession
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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)¶

List all mirror sessions

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.model_client.PortMirroringSessionListResult

Returns

com.vmware.nsx.model.PortMirroringSessionListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(mirror_session_id, port_mirroring_session)¶

Update the mirror session

Parameters

mirror_session_id (str) – (required)
port_mirroring_session (com.vmware.nsx.model_client.PortMirroringSession) – (required)

Return type

com.vmware.nsx.model_client.PortMirroringSession

Returns

com.vmware.nsx.model.PortMirroringSession

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

verify(mirror_session_id)¶

Verify whether all participants are on the same transport node

Parameters: mirror_session_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

class com.vmware.nsx_client.NetworkMigrationSpecs(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_TYPE_HOSTPROFILENETWORKMIGRATIONSPEC = 'HostProfileNetworkMigrationSpec'¶: Possible value for type of method NetworkMigrationSpecs.list().

create(network_migration_spec)¶

Network migration specification once created and can be used as a template to indicate associated component which networks should be migrated and where. Currently migration template can be associated with compute collections which are managed by vCenter host profiles, to trigger automatic migration of networks for Stateless ESX hosts. Currently we only support creation of HostProfileNetworkMigrationSpec type of specification.

Parameters: network_migration_spec (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.NetworkMigrationSpec.
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.NetworkMigrationSpec The return value will contain all the attributes defined in com.vmware.nsx.model_client.NetworkMigrationSpec.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(template_id)¶

Delete the specified network migration specification template. Delete will fail if this is a HostProfileNetworkMigrationSpec and is associated with certain compute collection.

Parameters: template_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(template_id)¶

Network migration specification once created and can be used as a template to indicate associated component which networks should be migrated and where. Currently migration template can be associated with compute collections which are managed by vCenter host profiles, to trigger automatic migration of networks for Stateless ESX hosts. Currently we only support creation of HostProfileNetworkMigrationSpec type of specification.

Parameters: template_id (str) – (required)
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.NetworkMigrationSpec The return value will contain all the attributes defined in com.vmware.nsx.model_client.NetworkMigrationSpec.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, include_system_owned=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶

Network migration specification once created and can be used as a template to indicate associated component which networks should be migrated and where. Currently migration template can be associated with compute collections which are managed by vCenter host profiles, to trigger automatic migration of networks for Stateless ESX hosts. Currently we only support creation of HostProfileNetworkMigrationSpec type of specification.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_system_owned (bool or None) – Whether the list result contains system resources (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)
type (str or None) – Supported network migration specification types. (optional)

Return type

com.vmware.nsx.model_client.NetworkMigrationSpecListResult

Returns

com.vmware.nsx.model.NetworkMigrationSpecListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(template_id, network_migration_spec)¶

Network migration specification once created and can be used as a template to indicate associated component which networks should be migrated and where. Currently migration template can be associated with compute collections which are managed by vCenter host profiles, to trigger automatic migration of networks for Stateless ESX hosts. Currently we only support creation of HostProfileNetworkMigrationSpec type of specification. For a HostProfileNetworkMigrationSpec which is already associated with a compute collection, updating it would mean next time the system needs to trigger migration for hosts managed by compute collection, it will use the updated migration specification.

Parameters

template_id (str) – (required)
network_migration_spec (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.NetworkMigrationSpec.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.NetworkMigrationSpec The return value will contain all the attributes defined in com.vmware.nsx.model_client.NetworkMigrationSpec.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.Node(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get()¶

Returns information about the NSX Manager appliance. Information includes release number, time zone, system time, kernel version, message of the day (motd), and host name.

Return type: com.vmware.nsx.model_client.NodeProperties
Returns: com.vmware.nsx.model.NodeProperties
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

restart()¶

Restarts or shuts down the NSX Manager appliance.

Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

shutdown()¶

Restarts or shuts down the NSX Manager appliance.

Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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(node_properties)¶

Modifies NSX Manager appliance properties. Modifiable properties include the timezone, message of the day (motd), and hostname. The NSX Manager node_version, system_time, and kernel_version are read only and cannot be modified with this method.

Parameters: node_properties (com.vmware.nsx.model_client.NodeProperties) – (required)
Return type: com.vmware.nsx.model_client.NodeProperties
Returns: com.vmware.nsx.model.NodeProperties
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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_client.Normalizations(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_PREFERRED_NORMALIZATION_TYPE_DIRECTORYGROUP = 'DirectoryGroup'¶: Possible value for preferredNormalizationType of method Normalizations.list().

LIST_PREFERRED_NORMALIZATION_TYPE_IPSET = 'IPSet'¶: Possible value for preferredNormalizationType of method Normalizations.list().

LIST_PREFERRED_NORMALIZATION_TYPE_LOGICALPORT = 'LogicalPort'¶: Possible value for preferredNormalizationType of method Normalizations.list().

LIST_PREFERRED_NORMALIZATION_TYPE_LOGICALSWITCH = 'LogicalSwitch'¶: Possible value for preferredNormalizationType of method Normalizations.list().

LIST_PREFERRED_NORMALIZATION_TYPE_MACSET = 'MACSet'¶: Possible value for preferredNormalizationType of method Normalizations.list().

LIST_PREFERRED_NORMALIZATION_TYPE_NSGROUP = 'NSGroup'¶: Possible value for preferredNormalizationType of method Normalizations.list().

LIST_RESOURCE_TYPE_NSGROUP = 'NSGroup'¶: Possible value for resourceType of method Normalizations.list().

list(preferred_normalization_type, resource_id, resource_type, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Returns the list of normalized resources based on the query parameters. Id and Type of the resource on which the normalizations is to be performed, are to be specified as query parameters in the URI. The target resource types to which normalization is to be done should also be specified as query parameter.

Parameters

preferred_normalization_type (str) – Resource type valid for use as target in normalization API. (required)
resource_id (str) – Identifier of the resource on which normalization is to be performed (required)
resource_type (str) – Resource type valid for use as source in normalization API. (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.model_client.NormalizedResourceListResult

Returns

com.vmware.nsx.model.NormalizedResourceListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.NsGroups(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

ADDORREMOVEEXPRESSION_ACTION_ADD_MEMBERS = 'ADD_MEMBERS'¶: Possible value for action of method NsGroups.addorremoveexpression().

ADDORREMOVEEXPRESSION_ACTION_REMOVE_MEMBERS = 'REMOVE_MEMBERS'¶: Possible value for action of method NsGroups.addorremoveexpression().

addorremoveexpression(ns_group_id, ns_group_expression_list, action)¶

Add/remove the expressions passed in the request body to/from the NSGroup

Parameters

ns_group_id (str) – NSGroup Id (required)
ns_group_expression_list (com.vmware.nsx.model_client.NSGroupExpressionList) – (required)
action (str) – Specifies addition or removal action (required)

Return type

com.vmware.nsx.model_client.NSGroup

Returns

com.vmware.nsx.model.NSGroup

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

create(ns_group)¶

Creates a new NSGroup that can group NSX resources - VIFs, Lports and LSwitches as well as the grouping objects - IPSet, MACSet and other NSGroups

Parameters: ns_group (com.vmware.nsx.model_client.NSGroup) – (required)
Return type: com.vmware.nsx.model_client.NSGroup
Returns: com.vmware.nsx.model.NSGroup
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(ns_group_id, force=None)¶

Deletes the specified NSGroup. By default, if the NSGroup is added to another NSGroup, it won’t be deleted. In such situations, pass “force=true” as query param to force delete the NSGroup.

Parameters

ns_group_id (str) – NSGroup 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(ns_group_id, populate_references=None)¶

Returns information about the specified NSGroup.

Parameters

ns_group_id (str) – NSGroup Id (required)
populate_references (bool or None) – Populate metadata of resource referenced by NSGroupExpressions (optional, default to false)

Return type

com.vmware.nsx.model_client.NSGroup

Returns

com.vmware.nsx.model.NSGroup

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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, member_types=None, page_size=None, populate_references=None, sort_ascending=None, sort_by=None)¶

List the NSGroups in a paginated format. The page size is restricted to 50 NSGroups so that the size of the response remains small even in the worst case. Optionally, specify valid member types as request parameter to filter NSGroups.

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)
member_types (str or None) – Specify member types to filter corresponding NSGroups (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
populate_references (bool or None) – Populate metadata of resource referenced by NSGroupExpressions (optional, default to false)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.NSGroupListResult

Returns

com.vmware.nsx.model.NSGroupListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(ns_group_id, ns_group)¶

Updates the specified NSGroup. Modifiable parameters include the description, display_name and members.

Parameters

ns_group_id (str) – NSGroup Id (required)
ns_group (com.vmware.nsx.model_client.NSGroup) – (required)

Return type

com.vmware.nsx.model_client.NSGroup

Returns

com.vmware.nsx.model.NSGroup

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.NsServiceGroups(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(ns_service_group)¶

Creates a new NSServiceGroup which can contain NSServices. A given NSServiceGroup can contain either only ether type of NSServices or only non-ether type of NSServices, i.e. an NSServiceGroup cannot contain a mix of both ether and non-ether types of NSServices.

Parameters: ns_service_group (com.vmware.nsx.model_client.NSServiceGroup) – (required)
Return type: com.vmware.nsx.model_client.NSServiceGroup
Returns: com.vmware.nsx.model.NSServiceGroup
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(ns_service_group_id, force=None)¶

Deletes the specified NSServiceGroup. By default, if the NSServiceGroup is consumed in a Firewall rule, it won’t get deleted. In such situations, pass “force=true” as query param to force delete the NSServiceGroup.

Parameters

ns_service_group_id (str) – NSServiceGroup 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.ConcurrentChange Conflict

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

get(ns_service_group_id)¶

Returns information about the specified NSServiceGroup

Parameters: ns_service_group_id (str) – NSServiceGroup Id (required)
Return type: com.vmware.nsx.model_client.NSServiceGroup
Returns: com.vmware.nsx.model.NSServiceGroup
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, default_service=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Returns paginated list of NSServiceGroups

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
default_service (bool or None) – Fetch all default NSServiceGroups (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.model_client.NSServiceGroupListResult

Returns

com.vmware.nsx.model.NSServiceGroupListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(ns_service_group_id, ns_service_group)¶

Updates the specified NSService. Modifiable parameters include the description, display_name and members.

Parameters

ns_service_group_id (str) – NSServiceGroup Id (required)
ns_service_group (com.vmware.nsx.model_client.NSServiceGroup) – (required)

Return type

com.vmware.nsx.model_client.NSServiceGroup

Returns

com.vmware.nsx.model.NSServiceGroup

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.ConcurrentChange Conflict

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_client.NsServices(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(ns_service)¶

Creates a new NSService which allows users to specify characteristics to use for matching network traffic.

Parameters: ns_service (com.vmware.nsx.model_client.NSService) – (required)
Return type: com.vmware.nsx.model_client.NSService
Returns: com.vmware.nsx.model.NSService
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(ns_service_id, force=None)¶

Deletes the specified NSService. By default, if the NSService is being referred in an NSServiceGroup, it can’t be deleted. In such situations, pass “force=true” as a parameter to force delete the NSService. System defined NSServices can’t be deleted using “force” flag.

Parameters

ns_service_id (str) – NSService 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.ConcurrentChange Conflict

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

get(ns_service_id)¶

Returns information about the specified NSService

Parameters: ns_service_id (str) – NSService Id (required)
Return type: com.vmware.nsx.model_client.NSService
Returns: com.vmware.nsx.model.NSService
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, default_service=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Returns paginated list of NSServices

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
default_service (bool or None) – Fetch all default NSServices (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.model_client.NSServiceListResult

Returns

com.vmware.nsx.model.NSServiceListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(ns_service_id, ns_service)¶

Updates the specified NSService. Modifiable parameters include the description, display_name and the NSService element. The system defined NSServices can’t be modified

Parameters

ns_service_id (str) – NSService Id (required)
ns_service (com.vmware.nsx.model_client.NSService) – (required)

Return type

com.vmware.nsx.model_client.NSService

Returns

com.vmware.nsx.model.NSService

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.ConcurrentChange Conflict

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_client.ServiceProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(service_profile)¶

Creates a service profile, which can then be used to create a service. Services are then applied to one or more logical router ports.

Parameters: service_profile (com.vmware.nsx.model_client.ServiceProfile) – (required)
Return type: com.vmware.nsx.model_client.ServiceProfile
Returns: com.vmware.nsx.model.ServiceProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(service_profile_id)¶

Deletes the specified service profile.

Parameters: service_profile_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(service_profile_id)¶

Returns information about the specified service profile.

Parameters: service_profile_id (str) – (required)
Return type: com.vmware.nsx.model_client.ServiceProfile
Returns: com.vmware.nsx.model.ServiceProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, resource_type=None, sort_ascending=None, sort_by=None)¶

Returns information about all service profiles. A service profile is a configuration that you can use to create a service, which is then applied to one or more logical router ports. Currently, only the DhcpRelayProfile is supported.

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)
resource_type (str or None) – (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.ServiceProfileListResult

Returns

com.vmware.nsx.model.ServiceProfileListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_profile_id, service_profile)¶

Modifies the specified service profile. The PUT request must include the resource_type parameters. Modifiable parameters include description and display_name. Other parameters might be modifiable, depending on the specified service type.

Parameters

service_profile_id (str) – (required)
service_profile (com.vmware.nsx.model_client.ServiceProfile) – (required)

Return type

com.vmware.nsx.model_client.ServiceProfile

Returns

com.vmware.nsx.model.ServiceProfile

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.Services(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(logical_service)¶

Creates a service that can be applied to one or more logical router ports. For some service types, you must create a service-profile before you can create a service.

Parameters: logical_service (com.vmware.nsx.model_client.LogicalService) – (required)
Return type: com.vmware.nsx.model_client.LogicalService
Returns: com.vmware.nsx.model.LogicalService
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(service_id)¶

Deletes the specified logical router service.

Parameters: service_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(service_id)¶

Returns information about the specified service.

Parameters: service_id (str) – (required)
Return type: com.vmware.nsx.model_client.LogicalService
Returns: com.vmware.nsx.model.LogicalService
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, resource_type=None, sort_ascending=None, sort_by=None)¶

Returns information about all configured logical router services that can be applied to one or more logical router ports. You must create a service-profile before you can create a service. Currently, only DhcpRelayService is supported.

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)
resource_type (str or None) – (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.LogicalServiceListResult

Returns

com.vmware.nsx.model.LogicalServiceListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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, logical_service)¶

Modifies the specified logical router service. The resource_type parameter is required. The modifiable parameters depend on the service type.

Parameters

service_id (str) – (required)
logical_service (com.vmware.nsx.model_client.LogicalService) – (required)

Return type

com.vmware.nsx.model_client.LogicalService

Returns

com.vmware.nsx.model.LogicalService

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

class com.vmware.nsx_client.SwitchingProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(base_switching_profile)¶

Creates a new, custom qos, port-mirroring, spoof-guard or port-security switching profile. You can override their default switching profile assignments by creating a new switching profile and assigning it to one or more logical switches. You cannot override the default ipfix or ip_discovery switching profiles.

Parameters: base_switching_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.BaseSwitchingProfile.
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.BaseSwitchingProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.BaseSwitchingProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(switching_profile_id, unbind=None)¶

Deletes the specified switching profile.

Parameters

switching_profile_id (str) – (required)
unbind (bool or None) – force unbinding of logical switches and ports from a switching profile (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(switching_profile_id)¶

Returns information about a specified switching profile.

Parameters: switching_profile_id (str) – (required)
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.BaseSwitchingProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.BaseSwitchingProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, include_system_owned=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, switching_profile_type=None)¶

Returns information about the system-default and user-configured switching profiles. Each switching profile has a unique ID, a display name, and various other read-only and configurable properties. The default switching profiles are assigned automatically to each switch.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_system_owned (bool or None) – Whether the list result contains system resources (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)
switching_profile_type (str or None) – comma-separated list of switching profile types, e.g. ?switching_profile_type=QosSwitchingProfile,PortMirroringSwitchingProfile (optional)

Return type

com.vmware.nsx.model_client.SwitchingProfilesListResult

Returns

com.vmware.nsx.model.SwitchingProfilesListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(switching_profile_id, base_switching_profile)¶

Updates the user-configurable parameters of a switching profile. Only the qos, port-mirroring, spoof-guard and port-security switching profiles can be modified. You cannot modify the ipfix or ip-discovery switching profiles.

Parameters

switching_profile_id (str) – (required)
base_switching_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.BaseSwitchingProfile.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.BaseSwitchingProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.BaseSwitchingProfile.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.Tasks(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(task_id)¶

Get information about the specified task

Parameters: task_id (str) – ID of task to read (required)
Return type: com.vmware.nsx.model_client.TaskProperties
Returns: com.vmware.nsx.model.TaskProperties
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, request_uri=None, sort_ascending=None, sort_by=None, status=None, user=None)¶

Get information about all tasks

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)
request_uri (str or None) – Request URI(s) to include in query result (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)
status (str or None) – Status(es) to include in query result (optional)
user (str or None) – Names of users to include in query result (optional)

Return type

com.vmware.nsx.model_client.TaskListResult

Returns

com.vmware.nsx.model.TaskListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.Traceflows(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(traceflow_request)¶

Initiate a Traceflow Operation on the Specified Port

Parameters: traceflow_request (com.vmware.nsx.model_client.TraceflowRequest) – (required)
Return type: com.vmware.nsx.model_client.Traceflow
Returns: com.vmware.nsx.model.Traceflow
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(traceflow_id)¶

Delete the Traceflow round

Parameters: traceflow_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(traceflow_id)¶

Get the Traceflow round status and result summary

Parameters: traceflow_id (str) – (required)
Return type: com.vmware.nsx.model_client.Traceflow
Returns: com.vmware.nsx.model.Traceflow
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, lport_id=None, page_size=None, sort_ascending=None, sort_by=None)¶

List all Traceflow rounds; if a logical port id is given as a query parameter, only those originated from the logical port are returned.

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)
lport_id (str or None) – id of the source logical port where the trace flows originated (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.model_client.TraceflowListResult

Returns

com.vmware.nsx.model.TraceflowListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.TransportNodes(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

UPDATEMAINTENANCEMODE_ACTION_ENTER_MAINTENANCE_MODE = 'enter_maintenance_mode'¶: Possible value for action of method TransportNodes.updatemaintenancemode().

UPDATEMAINTENANCEMODE_ACTION_EXIT_MAINTENANCE_MODE = 'exit_maintenance_mode'¶: Possible value for action of method TransportNodes.updatemaintenancemode().

UPDATEMAINTENANCEMODE_ACTION_FORCED_ENTER_MAINTENANCE_MODE = 'forced_enter_maintenance_mode'¶: Possible value for action of method TransportNodes.updatemaintenancemode().

create(transport_node)¶

Enables a fabric node to act as a transport node. Additional documentation on creating a transport node can be found in the NSX-T Installation Guide. Transport nodes are hypervisor hosts and NSX Edges that will participate in an NSX-T overlay. For a hypervisor host, this means that it hosts VMs that will communicate over NSX-T logical switches. For NSX Edges, this means that it will have logical router uplinks and downlinks. When creating a transport node, you must provide the node id of an existing fabric node (hypervisor host or NSX Edge node) in the node_id property of the payload. This property is required. Additionally, in order for the transport node to forward packets, the host_switch_spec property must be specified. Host switches (called bridges in OVS on KVM hypervisors) are the individual switches within the host virtual switch. Virtual machines are connected to the host switches. When creating a transport node, you need to specify if the host switches are already manually preconfigured on the node, or if NSX should create and manage the host switches. You specify this choice by the type of host switches you pass in the host_switch_spec property of the TransportNode request payload. For a KVM host, you can preconfigure the host switch, or you can have NSX Manager perform the configuration. For an ESXi host or NSX Edge node, NSX Manager always configures the host switch. To preconfigure the host switches on a KVM host, pass an array of PreconfiguredHostSwitchSpec objects that describes those host switches. In the current NSX-T release, only one prefonfigured host switch can be specified. See the PreconfiguredHostSwitchSpec schema definition for documentation on the properties that must be provided. Preconfigured host switches are only supported on KVM hosts, not on ESXi hosts or NSX Edge nodes. To allow NSX to manage the host switch configuration on KVM hosts, ESXi hosts, or NSX Edge nodes, pass an array of StandardHostSwitchSpec objects in the host_switch_spec property, and NSX will automatically create host switches with the properties you provide. In the current NSX-T release, up to 5 host switches can be automatically managed. See the StandardHostSwitchSpec schema definition for documentation on the properties that must be provided. Note: previous versions of NSX-T used a property named host_switches to specify the host switch configuration on the transport node. That property is deprecated, but still functions. You should configure new host switches using the host_switch_spec property.

Parameters: transport_node (com.vmware.nsx.model_client.TransportNode) – (required)
Return type: com.vmware.nsx.model_client.TransportNode
Returns: com.vmware.nsx.model.TransportNode
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(transportnode_id, force=None)¶

Deletes the specified transport node. Query param force can be used to force delete the host nodes. Force deletion of edge and public cloud gateway nodes is not supported.

Parameters

transportnode_id (str) – (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(transportnode_id)¶

Returns information about a specified transport node.

Parameters: transportnode_id (str) – (required)
Return type: com.vmware.nsx.model_client.TransportNode
Returns: com.vmware.nsx.model.TransportNode
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, in_maintenance_mode=None, included_fields=None, node_id=None, node_ip=None, node_types=None, page_size=None, sort_ascending=None, sort_by=None, transport_zone_id=None)¶

Returns information about all transport nodes. A transport node is a fabric node (host or edge) that contains hostswitches. A hostswitch can have virtual machines connected to them. Because each transport node has HostSwitches, transport nodes can also have virtual tunnel endpoints, which means that they can be part of the overlay.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
in_maintenance_mode (bool or None) – maintenance mode flag (optional)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
node_id (str or None) – node identifier (optional)
node_ip (str or None) – Fabric node IP address (optional)
node_types (str or None) – a list of fabric node types separated by comma or a single type (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)
transport_zone_id (str or None) – Transport zone identifier (optional)

Return type

com.vmware.nsx.model_client.TransportNodeListResult

Returns

com.vmware.nsx.model.TransportNodeListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

resynchostconfig(transportnode_id)¶

Resync the TransportNode configuration on a host. It is similar to updating the TransportNode with existing configuration, but force synce these configurations to the host (no backend optimizations).

Parameters: transportnode_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

update(transportnode_id, transport_node, esx_mgmt_if_migration_dest=None, if_id=None, vnic=None, vnic_migration_dest=None)¶

Modifies the transport node information. Modifiable parameters include the host_switch_spec and transport_zone_endpoints. The host_switch_name field must match the host_switch_name value specified in the transport zone (API: transport-zones). You must create the associated uplink profile (API: host-switch-profiles) before you can specify an uplink_name here. If the host is an ESX and has only one physical NIC being used by a vSphere standard switch, TransportNodeUpdateParameters should be used to migrate the management interface and the physical NIC into a logical switch that is in a transport zone this transport node will join or has already joined. If the migration is already done, TransportNodeUpdateParameters can also be used to migrate the management interface and the physical NIC back to a vSphere standard switch. In other cases, the TransportNodeUpdateParameters should NOT be used. When updating transport node user should follow pattern where he should fetch the existing transport node and then only modify the required properties keeping other properties as is. For API backward compatibility, property host_switches will be still returned in response and will contain the configuration matching the one in host_switch_spec. In update call user should only modify configuration in either host_switch_spec or host_switches, but not both. Property host_switch_spec should be preferred over deprecated host_switches property when creating or updating transport nodes.

Parameters

transportnode_id (str) – (required)
transport_node (com.vmware.nsx.model_client.TransportNode) – (required)
esx_mgmt_if_migration_dest (str or None) – The network ids to which the ESX vmk interfaces will be migrated (optional)
if_id (str or None) – The ESX vmk interfaces to migrate (optional)
vnic (str or None) – The ESX vmk interfaces and/or VM NIC to migrate (optional)
vnic_migration_dest (str or None) – The migration destinations of ESX vmk interfaces and/or VM NIC (optional)

Return type

com.vmware.nsx.model_client.TransportNode

Returns

com.vmware.nsx.model.TransportNode

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

updatemaintenancemode(transportnode_id, action=None)¶

Put transport node into maintenance mode or exit from maintenance mode.

Parameters

transportnode_id (str) – (required)
action (str or None) – (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_client.TransportZones(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(transport_zone)¶

Creates a new transport zone. The required parameters are host_switch_name and transport_type (OVERLAY or VLAN). The optional parameters are description and display_name.

Parameters: transport_zone (com.vmware.nsx.model_client.TransportZone) – (required)
Return type: com.vmware.nsx.model_client.TransportZone
Returns: com.vmware.nsx.model.TransportZone
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(zone_id)¶

Deletes an existing transport zone.

Parameters: zone_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(zone_id)¶

Returns information about a single transport zone.

Parameters: zone_id (str) – (required)
Return type: com.vmware.nsx.model_client.TransportZone
Returns: com.vmware.nsx.model.TransportZone
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, uplink_teaming_policy_name=None)¶

Returns information about configured transport zones. NSX requires at least one transport zone. NSX uses transport zones to provide connectivity based on the topology of the underlying network, trust zones, or organizational separations. For example, you might have hypervisors that use one network for management traffic and a different network for VM traffic. This architecture would require two transport zones. The combination of transport zones plus transport connectors enables NSX to form tunnels between hypervisors. Transport zones define which interfaces on the hypervisors can communicate with which other interfaces on other hypervisors to establish overlay tunnels or provide connectivity to a VLAN. A logical switch can be in one (and only one) transport zone. This means that all of a switch’s interfaces must be in the same transport zone. However, each hypervisor virtual switch (OVS or VDS) has multiple interfaces (connectors), and each connector can be attached to a different logical switch. For example, on a single hypervisor with two connectors, connector A can be attached to logical switch 1 in transport zone A, while connector B is attached to logical switch 2 in transport zone B. In this way, a single hypervisor can participate in multiple transport zones. The API for creating a transport zone requires that a single host switch be specified for each transport zone, and multiple transport zones can share the same host switch.

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)
uplink_teaming_policy_name (str or None) – The transport zone’s uplink teaming policy name (optional)

Return type

com.vmware.nsx.model_client.TransportZoneListResult

Returns

com.vmware.nsx.model.TransportZoneListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(zone_id, transport_zone)¶

Updates an existing transport zone. Modifiable parameters are transport_type (VLAN or OVERLAY), description, and display_name. The request must include the existing host_switch_name.

Parameters

zone_id (str) – (required)
transport_zone (com.vmware.nsx.model_client.TransportZone) – (required)

Return type

com.vmware.nsx.model_client.TransportZone

Returns

com.vmware.nsx.model.TransportZone

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.TransportzoneProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(transport_zone_profile)¶

Creates a transport zone profile. The resource_type is required.

Parameters: transport_zone_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.TransportZoneProfile.
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.TransportZoneProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.TransportZoneProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(transportzone_profile_id)¶

Deletes a specified transport zone profile.

Parameters: transportzone_profile_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(transportzone_profile_id)¶

Returns information about a specified transport zone profile.

Parameters: transportzone_profile_id (str) – (required)
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx.model.TransportZoneProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.TransportZoneProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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, include_system_owned=None, included_fields=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)¶

Returns information about the configured transport zone profiles. Transport zone profiles define networking policies for transport zones and transport zone endpoints.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_system_owned (bool or None) – Whether the list result contains system resources (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
resource_type (str or None) – comma-separated list of transport zone profile types, e.g. ?resource_type=BfdHealthMonitoringProfile (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.TransportZoneProfileListResult

Returns

com.vmware.nsx.model.TransportZoneProfileListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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(transportzone_profile_id, transport_zone_profile)¶

Modifies a specified transport zone profile. The body of the PUT request must include the resource_type.

Parameters

transportzone_profile_id (str) – (required)
transport_zone_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx.model_client.TransportZoneProfile.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx.model.TransportZoneProfile The return value will contain all the attributes defined in com.vmware.nsx.model_client.TransportZoneProfile.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.TrustManagement(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get()¶

Returns information about the supported algorithms and key sizes.

Return type: com.vmware.nsx.model_client.TrustManagementData
Returns: com.vmware.nsx.model.TrustManagementData
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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_client.UiViews(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(view)¶

Creates a new View.

Parameters: view (com.vmware.nsx.model_client.View) – (required)
Return type: com.vmware.nsx.model_client.View
Returns: com.vmware.nsx.model.View
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(view_id)¶

Delete View

Parameters: view_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(view_ids=None, widget_id=None)¶

If no query params are specified then all the views entitled for the user are returned. The views to which a user is entitled to include the views created by the user and the shared views.

Parameters

view_ids (str or None) – Ids of the Views (optional)
widget_id (str or None) – Id of widget configuration (optional)

Return type

com.vmware.nsx.model_client.ViewList

Returns

com.vmware.nsx.model.ViewList

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_0(view_id)¶

Returns Information about a specific View.

Parameters: view_id (str) – (required)
Return type: com.vmware.nsx.model_client.View
Returns: com.vmware.nsx.model.View
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_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(view_id, view)¶

Update View

Parameters

view_id (str) – (required)
view (com.vmware.nsx.model_client.View) – (required)

Return type

com.vmware.nsx.model_client.View

Returns

com.vmware.nsx.model.View

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_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_client.Upgrade(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

upgradeuc()¶

Upgrade the upgrade coordinator.

Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

com.vmware.nsx_client_for_vmc module¶

Convenience methods to get API clients for NSX APIs in VMC

class com.vmware.nsx_client_for_vmc.CSPSecurityContextFilter(session, refresh_token, refresh_url)¶

Bases: vmware.vapi.security.client.security_context_filter.SecurityContextFilter

CSP Security Context filter in API Provider chain adds the security context based on a refresh token to the execution context passed in.

Initialize SecurityContextFilter

Parameters

session (requests.Session) – Requests Session object to use for making HTTP calls
refresh_token (str) – Refresh token to use for obtaining an access token
refresh_url (str) – URL that allows exchanging a refresh token for an access token

get_max_retries()¶

Get the max number of retries

Return type: int
Returns: Number of retries

get_security_context(on_error)¶

Retrieve security context. If this method is called after an error occured, then a new access token is obtained using the refresh token and a new security context is created.

Parameters: on_error (bool) – Whether this method is called after getting an error
Return type: vmware.vapi.core.SecurityContext
Returns: Security context

should_retry(error_value)¶

Returns whether the request should be retried or not based on the error specified.

Parameters: error_value (vmware.vapi.data.value.ErrorValue) – Method error
Return type: bool
Returns: Returns True if request should be retried in case the error is either Unauthenticated or Unauthorized else False

class com.vmware.nsx_client_for_vmc.VmcNsxClient(stub_factory_class, session, refresh_token, vmc_url, csp_url, org_id, sddc_id)¶

Bases: vmware.vapi.bindings.stub.ApiClient

Client class that providess access to stubs for all the services in the VMC NSX API

Initialize VmcClient by creating a stub factory instance using a CSP Security context filter added to the filter chain of the connector

Parameters

stub_factory_class (type) – Which stub factory class to use
session (requests.Session) – Requests HTTP session instance
refresh_token (str) – Refresh token obtained from CSP
vmc_url (str) – URL of the VMC service
csp_url (str) – URL of the CSP service
org_id (str) – ID of the VMC organization
sddc_id (str) – ID of the VMC Software-Defined Data Center (SDDC)

com.vmware.nsx_client_for_vmc.create_nsx_client_for_vmc(refresh_token, org_id, sddc_id, session=None)¶

Helper method to create an instance of the VMC NSX API client

Parameters

refresh_token (str) – Refresh token obtained from CSP
org_id (str) – ID of the VMC organization
sddc_id (str) – ID of the VMC Software-Defined Data Center (SDDC)
session (requests.Session or None) – Requests HTTP session instance. If not specified, then one is automatically created and used

Return type

vmware.vapi.vmc.client.VmcNsxClient

Returns

VMC NSX Client instance