com.vmware.nsx_client.Associations(config)¶com.vmware.nsx_client.Associations(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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_TRANSPORTNODE = 'TransportNode'¶Possible value for resourceType of method Associations.list().
LIST_RESOURCE_TYPE_VIRTUALMACHINE = 'VirtualMachine'¶Possible value for resourceType of method Associations.list().
LIST_RESOURCE_TYPE_VIRTUALNETWORKINTERFACE = 'VirtualNetworkInterface'¶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)¶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. @@ -744,18 +744,18 @@ Not Found
com.vmware.nsx_client.Batch(config)¶com.vmware.nsx_client.Batch(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(batch_request, atomic=None)¶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 @@ -804,18 +804,18 @@ Not Found
com.vmware.nsx_client.BridgeClusters(config)¶com.vmware.nsx_client.BridgeClusters(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
delete(bridgecluster_id)¶delete(bridgecluster_id)¶
Removes the specified Bridge Cluster.
get(bridgecluster_id)¶get(bridgecluster_id)¶
Returns information about a specified bridge cluster.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all configured bridge clusters
update(bridgecluster_id, bridge_cluster)¶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.
com.vmware.nsx_client.BridgeEndpointProfiles(config)¶com.vmware.nsx_client.BridgeEndpointProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
delete(bridgeendpointprofile_id)¶delete(bridgeendpointprofile_id)¶
Deletes the specified Bridge Endpoint Profile.
get(bridgeendpointprofile_id)¶get(bridgeendpointprofile_id)¶
Returns information about a specified bridge endpoint profile.
list(cursor=None, edge_cluster_id=None, failover_mode=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶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
update(bridgeendpointprofile_id, bridge_endpoint_profile)¶update(bridgeendpointprofile_id, bridge_endpoint_profile)¶
Modifies a existing bridge endpoint profile.
com.vmware.nsx_client.BridgeEndpoints(config)¶com.vmware.nsx_client.BridgeEndpoints(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
delete(bridgeendpoint_id)¶delete(bridgeendpoint_id)¶
Deletes the specified Bridge Endpoint.
get(bridgeendpoint_id)¶get(bridgeendpoint_id)¶
Returns information about a specified bridge endpoint.
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)¶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
update(bridgeendpoint_id, bridge_endpoint)¶update(bridgeendpoint_id, bridge_endpoint)¶
Modifies a existing bridge endpoint.
com.vmware.nsx_client.Cluster(config)¶com.vmware.nsx_client.Cluster(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
REMOVENODE_FORCE_FALSE = 'false'¶Possible value for force of method Cluster.removenode().
REMOVENODE_FORCE_TRUE = 'true'¶Possible value for force of method Cluster.removenode().
REMOVENODE_GRACEFUL_SHUTDOWN_FALSE = 'false'¶Possible value for gracefulShutdown of method Cluster.removenode().
REMOVENODE_GRACEFUL_SHUTDOWN_TRUE = 'true'¶Possible value for gracefulShutdown of method Cluster.removenode().
REMOVENODE_IGNORE_REPOSITORY_IP_CHECK_FALSE = 'false'¶Possible value for ignoreRepositoryIpCheck of method
Cluster.removenode().
REMOVENODE_IGNORE_REPOSITORY_IP_CHECK_TRUE = 'true'¶Possible value for ignoreRepositoryIpCheck of method
Cluster.removenode().
backuptoremote()¶Request one-time backup. The backup will be uploaded using the same @@ -1500,9 +1500,9 @@ Not Found
get_0(node_id)¶get_0(node_id)¶
Returns information about the specified NSX cluster node.
get_1(target_node_id, target_uri)¶get_1(target_node_id, target_uri)¶
Invoke GET request on target cluster node
joincluster(join_cluster_parameters)¶joincluster(join_cluster_parameters)¶
Join this node to a NSX Cluster
removenode(node_id, force=None, graceful_shutdown=None, ignore_repository_ip_check=None)¶removenode(node_id, force=None, graceful_shutdown=None, ignore_repository_ip_check=None)¶
Detach a node from the Cluster
summarizeinventorytoremote()¶Request one-time inventory summary. The backup will be uploaded using @@ -1798,9 +1798,9 @@ Not Found
update(target_node_id, target_uri)¶update(target_node_id, target_uri)¶
Invoke PUT request on target cluster node
com.vmware.nsx_client.ClusterProfiles(config)¶com.vmware.nsx_client.ClusterProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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(cluster_profile)¶
Create a cluster profile. The resource_type is required.
delete(cluster_profile_id)¶delete(cluster_profile_id)¶
Delete a specified cluster profile.
get(cluster_profile_id)¶get(cluster_profile_id)¶
Returns information about a specified cluster profile.
list(cursor=None, include_system_owned=None, included_fields=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)¶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.
update(cluster_profile_id, cluster_profile)¶update(cluster_profile_id, cluster_profile)¶
Modifie a specified cluster profile. The body of the PUT request must include the resource_type.
com.vmware.nsx_client.ComputeCollectionTransportNodeTemplates(config)¶com.vmware.nsx_client.ComputeCollectionTransportNodeTemplates(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(compute_collection_transport_node_template)¶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. Note- transport node templates APIs are @@ -2117,9 +2117,9 @@ Not Found
update(template_id, compute_collection_transport_node_template)¶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 @@ -2275,18 +2275,18 @@ Not Found
com.vmware.nsx_client.EdgeClusters(config)¶com.vmware.nsx_client.EdgeClusters(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
delete(edge_cluster_id)¶delete(edge_cluster_id)¶
Deletes the specified edge cluster.
get(edge_cluster_id)¶get(edge_cluster_id)¶
Returns information about the specified edge cluster.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶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 @@ -2442,9 +2442,9 @@ Not Found
replacetransportnode(edge_cluster_id, edge_cluster_member_transport_node)¶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 @@ -2486,9 +2486,9 @@ Not Found
update(edge_cluster_id, edge_cluster)¶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 @@ -2544,18 +2544,18 @@ Not Found
com.vmware.nsx_client.ErrorResolver(config)¶com.vmware.nsx_client.ErrorResolver(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list()¶Returns a list of metadata for all the error resolvers registered.
@@ -2626,9 +2626,9 @@ Not Foundresolveerror(error_resolver_metadata_list)¶resolveerror(error_resolver_metadata_list)¶
Invokes the corresponding error resolver for the given error(s) present in the payload
com.vmware.nsx_client.FailureDomains(config)¶com.vmware.nsx_client.FailureDomains(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(failure_domain)¶create(failure_domain)¶
Creates a new failure domain.
update(failure_domain_id, failure_domain)¶update(failure_domain_id, failure_domain)¶
Updates an existing failure domain. Modifiable parameters are display_name, preferred_active_edge_services flag.
com.vmware.nsx_client.GlobalConfigs(config)¶com.vmware.nsx_client.GlobalConfigs(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
resyncconfig(config_type, global_configs)¶resyncconfig(config_type, global_configs)¶
It is similar to update global configurations but this request would trigger update even if the configs are unmodified. However, the realization of the new configurations is config-type specific. Refer to @@ -2985,9 +2985,9 @@ Not Found
update(config_type, global_configs)¶update(config_type, global_configs)¶
com.vmware.nsx_client.HostSwitchProfiles(config)¶com.vmware.nsx_client.HostSwitchProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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)¶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 @@ -3113,9 +3113,9 @@ Not Found
delete(host_switch_profile_id)¶delete(host_switch_profile_id)¶
Deletes a specified hostswitch profile.
get(host_switch_profile_id)¶get(host_switch_profile_id)¶
Returns information about a specified hostswitch profile.
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)¶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 @@ -3239,9 +3239,9 @@ Not Found
update(host_switch_profile_id, base_host_switch_profile)¶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 @@ -3289,30 +3289,30 @@ Not Found
com.vmware.nsx_client.IpSets(config)¶com.vmware.nsx_client.IpSets(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
CREATE_0_ACTION_ADD_IP = 'add_ip'¶Possible value for action of method IpSets.create_0().
CREATE_0_ACTION_REMOVE_IP = 'remove_ip'¶Possible value for action of method IpSets.create_0().
create(ip_set)¶create(ip_set)¶
Creates a new IPSet that can group either IPv4 or IPv6 individual ip addresses, ranges or subnets.
get(ip_set_id)¶get(ip_set_id)¶
Returns information about the specified IPSet
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns paginated list of IPSets
update(ip_set_id, ip_set)¶update(ip_set_id, ip_set)¶
Updates the specified IPSet. Modifiable parameters include description, display_name and ip_addresses.
com.vmware.nsx_client.IpfixCollectorProfiles(config)¶com.vmware.nsx_client.IpfixCollectorProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(ipfix_collector_upm_profile)¶create(ipfix_collector_upm_profile)¶
Create a new IPFIX collector profile with essential properties.
delete(ipfix_collector_profile_id)¶delete(ipfix_collector_profile_id)¶
Delete an existing IPFIX collector profile by ID.
get(ipfix_collector_profile_id)¶get(ipfix_collector_profile_id)¶
Get an existing IPFIX collector profile by profile ID.
list(cursor=None, included_fields=None, page_size=None, profile_types=None, sort_ascending=None, sort_by=None)¶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.
update(ipfix_collector_profile_id, ipfix_collector_upm_profile)¶update(ipfix_collector_profile_id, ipfix_collector_upm_profile)¶
Update an existing IPFIX collector profile with profile ID and modified properties.
com.vmware.nsx_client.IpfixObsPoints(config)¶com.vmware.nsx_client.IpfixObsPoints(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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 @@ -3807,39 +3807,39 @@ Not Found
com.vmware.nsx_client.IpfixProfiles(config)¶com.vmware.nsx_client.IpfixProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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(ipfix_upm_profile)¶
Create a new IPFIX profile with essential properties.
delete(ipfix_profile_id)¶delete(ipfix_profile_id)¶
Delete an existing IPFIX profile by ID.
get(ipfix_profile_id)¶get(ipfix_profile_id)¶
Get an existing IPFIX profile by profile ID.
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)¶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.
update(ipfix_profile_id, ipfix_upm_profile)¶update(ipfix_profile_id, ipfix_upm_profile)¶
Update an existing IPFIX profile with profile ID and modified properties.
com.vmware.nsx_client.Licenses(config)¶com.vmware.nsx_client.Licenses(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Deprecated. Use the GET /licenses API instead.
@@ -4193,9 +4193,9 @@ Not Foundupdate(license)¶update(license)¶
Deprecated. Use the POST /licenses API instead
com.vmware.nsx_client.LogicalPorts(config)¶com.vmware.nsx_client.LogicalPorts(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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().
delete(lport_id, detach=None)¶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.
@@ -4435,9 +4435,9 @@ Not Foundget(lport_id)¶get(lport_id)¶
Returns information about a specified logical port.
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)¶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.
@@ -4532,9 +4532,9 @@ Not Foundupdate(lport_id, logical_port)¶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 @@ -4578,60 +4578,60 @@ Not Found
com.vmware.nsx_client.LogicalRouterPorts(config)¶com.vmware.nsx_client.LogicalRouterPorts(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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().
delete(logical_router_port_id, cascade_delete_linked_ports=None, force=None)¶delete(logical_router_port_id, cascade_delete_linked_ports=None, 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 @@ -4716,9 +4716,9 @@ Not Found
get(logical_router_port_id)¶get(logical_router_port_id)¶
Returns information about the specified logical router port.
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)¶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, @@ -4811,9 +4811,9 @@ Not Found
update(logical_router_port_id, logical_router_port)¶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, @@ -4862,30 +4862,30 @@ Not Found
com.vmware.nsx_client.LogicalRouters(config)¶com.vmware.nsx_client.LogicalRouters(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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().
delete(logical_router_id, cascade_delete_linked_ports=None, force=None)¶delete(logical_router_id, cascade_delete_linked_ports=None, 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 @@ -4963,9 +4963,9 @@ Not Found
get(logical_router_id)¶get(logical_router_id)¶
Returns information about the specified logical router.
list(cursor=None, included_fields=None, page_size=None, router_type=None, sort_ascending=None, sort_by=None)¶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 @@ -5050,9 +5050,9 @@ Not Found
reallocate(logical_router_id, service_router_allocation_config)¶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 @@ -5096,9 +5096,9 @@ Not Found
update(logical_router_id, logical_router)¶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).
@@ -5173,30 +5173,30 @@ Not Foundcom.vmware.nsx_client.LogicalSwitches(config)¶com.vmware.nsx_client.LogicalSwitches(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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().
delete(lswitch_id, cascade=None, detach=None)¶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 @@ -5275,9 +5275,9 @@ Not Found
get(lswitch_id)¶get(lswitch_id)¶
Returns information about the specified logical switch Id.
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)¶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.
update(lswitch_id, logical_switch)¶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.
@@ -5411,18 +5411,18 @@ Not Foundcom.vmware.nsx_client.MacSets(config)¶com.vmware.nsx_client.MacSets(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(mac_set_id)¶get(mac_set_id)¶
Returns information about the specified MACSet
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns paginated list of MACSets
update(mac_set_id, m_ac_set)¶update(mac_set_id, m_ac_set)¶
Updates the specified MACSet. Modifiable parameters include the description, display_name and mac_addresses.
com.vmware.nsx_client.ManualHealthChecks(config)¶com.vmware.nsx_client.ManualHealthChecks(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
delete(manual_health_check_id)¶delete(manual_health_check_id)¶
Delete an existing manual health check by ID.
get(manual_health_check_id)¶get(manual_health_check_id)¶
Get an existing manual health check by health check ID.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Query manual health checks with list parameters.
com.vmware.nsx_client.MdProxies(config)¶com.vmware.nsx_client.MdProxies(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(metadata_proxy)¶create(metadata_proxy)¶
Create a metadata proxy
delete(proxy_id)¶delete(proxy_id)¶
Delete a metadata proxy
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get a paginated list of metadata proxies
update(proxy_id, metadata_proxy)¶update(proxy_id, metadata_proxy)¶
Update a metadata proxy
com.vmware.nsx_client.MirrorSessions(config)¶com.vmware.nsx_client.MirrorSessions(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(port_mirroring_session)¶create(port_mirroring_session)¶
Create a mirror session
delete(mirror_session_id)¶delete(mirror_session_id)¶
Delete the mirror session
get(mirror_session_id)¶get(mirror_session_id)¶
Get the mirror session
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
List all mirror sessions
update(mirror_session_id, port_mirroring_session)¶update(mirror_session_id, port_mirroring_session)¶
Update the mirror session
verify(mirror_session_id)¶verify(mirror_session_id)¶
Verify whether all participants are on the same transport node
com.vmware.nsx_client.NetworkMigrationSpecs(config)¶com.vmware.nsx_client.NetworkMigrationSpecs(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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)¶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 @@ -6288,9 +6288,9 @@ Not Found
list(cursor=None, include_system_owned=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶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 @@ -6427,9 +6427,9 @@ Not Found
update(template_id, network_migration_spec)¶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 @@ -6484,16 +6484,16 @@ Not Found
com.vmware.nsx_client.Node(config)¶com.vmware.nsx_client.Node(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Returns information about the NSX appliance. Information includes @@ -6529,7 +6529,7 @@ Not Found
restart()¶Restarts or shuts down the NSX appliance.
@@ -6557,9 +6557,9 @@ Not Foundsetsystemtime(node_time)¶setsystemtime(node_time)¶
Set the node system time to the given time in UTC in the RFC3339 format ‘yyyy-mm-ddThh:mm:ssZ’.
shutdown()¶Restarts or shuts down the NSX appliance.
@@ -6621,9 +6621,9 @@ Not Foundupdate(node_properties)¶update(node_properties)¶
Modifies NSX appliance properties. Modifiable properties include the timezone, message of the day (motd), and hostname. The NSX appliance node_version, system_time, and kernel_version are read only and cannot @@ -6663,66 +6663,66 @@ Not Found
com.vmware.nsx_client.Normalizations(config)¶com.vmware.nsx_client.Normalizations(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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)¶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 @@ -6778,18 +6778,18 @@ Not Found
com.vmware.nsx_client.NotificationWatchers(config)¶com.vmware.nsx_client.NotificationWatchers(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
update(watcher_id, notification_watcher)¶update(watcher_id, notification_watcher)¶
Update notification watcher.
com.vmware.nsx_client.NsGroups(config)¶com.vmware.nsx_client.NsGroups(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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().
get(ns_group_id, populate_references=None)¶get(ns_group_id, populate_references=None)¶
Returns information about the specified NSGroup.
list(cursor=None, included_fields=None, member_types=None, page_size=None, populate_references=None, sort_ascending=None, sort_by=None)¶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 @@ -7204,9 +7204,9 @@ Not Found
update(ns_group_id, ns_group)¶update(ns_group_id, ns_group)¶
Updates the specified NSGroup. Modifiable parameters include the description, display_name and members. For NSGroups containing VM criteria(both static and dynamic), system VMs will not be included as @@ -7252,18 +7252,18 @@ Not Found
com.vmware.nsx_client.NsProfiles(config)¶com.vmware.nsx_client.NsProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
delete(ns_profile_id, force=None)¶delete(ns_profile_id, force=None)¶
Deletes the specified NSProfile. By default, if the NSProfile is consumed in a Firewall rule, it won’t get deleted. In such situations, pass “force=true” as query param to force delete the NSProfile.
@@ -7344,9 +7344,9 @@ Not Foundget(ns_profile_id)¶get(ns_profile_id)¶
Returns information about the specified NSProfile.
list(attribute_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(attribute_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
List the NSProfiles created in a paginated format.The page size is restricted to 50 NSProfiles, so that the size of the response remains small even when there are high number of NSProfiles with multiple @@ -7431,9 +7431,9 @@ Not Found
update(ns_profile_id, ns_profile)¶update(ns_profile_id, ns_profile)¶
Updates the specified NSProfile. Rules for using attributes and sub-attributes in single NSProfile 1. One type of attribute can’t have multiple occurrences. ( Example - Attribute type APP_ID can be used @@ -7481,18 +7481,18 @@ Not Found
com.vmware.nsx_client.NsServiceGroups(config)¶com.vmware.nsx_client.NsServiceGroups(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
delete(ns_service_group_id, force=None)¶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 @@ -7572,9 +7572,9 @@ Not Found
get(ns_service_group_id)¶get(ns_service_group_id)¶
Returns information about the specified NSServiceGroup
list(cursor=None, default_service=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, default_service=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns paginated list of NSServiceGroups
update(ns_service_group_id, ns_service_group)¶update(ns_service_group_id, ns_service_group)¶
Updates the specified NSService. Modifiable parameters include the description, display_name and members.
com.vmware.nsx_client.NsServices(config)¶com.vmware.nsx_client.NsServices(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(ns_service)¶create(ns_service)¶
Creates a new NSService which allows users to specify characteristics to use for matching network traffic.
delete(ns_service_id, force=None)¶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. @@ -7792,9 +7792,9 @@ Not Found
get(ns_service_id)¶get(ns_service_id)¶
Returns information about the specified NSService
list(cursor=None, default_service=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, default_service=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns paginated list of NSServices
update(ns_service_id, ns_service)¶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
@@ -7924,18 +7924,18 @@ Not Foundcom.vmware.nsx_client.ServiceConfigs(config)¶com.vmware.nsx_client.ServiceConfigs(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(service_config)¶create(service_config)¶
Creates a new service config that can group profiles and configs
delete(config_set_id)¶delete(config_set_id)¶
Deletes the specified service config
get(config_set_id)¶get(config_set_id)¶
Returns information about the specified Service Config.
list(cursor=None, included_fields=None, page_size=None, profile_type=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, profile_type=None, sort_ascending=None, sort_by=None)¶
List of all service configs.
update(config_set_id, service_config)¶update(config_set_id, service_config)¶
Updates the specified ServiceConfig.
com.vmware.nsx_client.StubFactory(stub_config)¶com.vmware.nsx_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx_client.SwitchingProfiles(config)¶com.vmware.nsx_client.SwitchingProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(base_switching_profile)¶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 @@ -8193,9 +8193,9 @@ Not Found
delete(switching_profile_id, unbind=None)¶delete(switching_profile_id, unbind=None)¶
Deletes the specified switching profile.
get(switching_profile_id)¶get(switching_profile_id)¶
Returns information about a specified switching profile.
list(cursor=None, include_system_owned=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, switching_profile_type=None)¶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 @@ -8321,9 +8321,9 @@ Not Found
update(switching_profile_id, base_switching_profile)¶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 @@ -8370,18 +8370,18 @@ Not Found
com.vmware.nsx_client.Tasks(config)¶com.vmware.nsx_client.Tasks(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(task_id)¶get(task_id)¶
Get information about the specified task
list(cursor=None, included_fields=None, page_size=None, request_uri=None, sort_ascending=None, sort_by=None, status=None, user=None)¶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
com.vmware.nsx_client.Traceflows(config)¶com.vmware.nsx_client.Traceflows(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(traceflow_request)¶create(traceflow_request)¶
Initiate a Traceflow Operation on the Specified Port
delete(traceflow_id)¶delete(traceflow_id)¶
Delete the Traceflow round
get(traceflow_id)¶get(traceflow_id)¶
Get the Traceflow round status and result summary
list(cursor=None, included_fields=None, lport_id=None, page_size=None, sort_ascending=None, sort_by=None)¶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.
com.vmware.nsx_client.TransportNodeCollections(config)¶com.vmware.nsx_client.TransportNodeCollections(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(transport_node_collection)¶create(transport_node_collection)¶
When transport node collection is created the hosts which are part of compute collection will be prepared automatically i.e. NSX Manager attempts to install the NSX components on hosts. Transport nodes for @@ -8682,9 +8682,9 @@ Not Found
delete(transport_node_collection_id)¶delete(transport_node_collection_id)¶
By deleting transport node collection, we are detaching the transport node profile(TNP) from the compute collection. It has no effect on existing transport nodes. However, new hosts added to the compute @@ -8717,9 +8717,9 @@ Not Found
update(transport_node_collection_id, transport_node_collection)¶update(transport_node_collection_id, transport_node_collection)¶
Attach different transport node profile to compute collection by updating transport node collection.
com.vmware.nsx_client.TransportNodeProfiles(config)¶com.vmware.nsx_client.TransportNodeProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
delete(transport_node_profile_id)¶delete(transport_node_profile_id)¶
Deletes the specified transport node profile. A transport node profile can be deleted only when it is not attached to any compute collection.
get(transport_node_profile_id)¶get(transport_node_profile_id)¶
Returns information about a specified transport node profile.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all transport node profiles.
update(transport_node_profile_id, transport_node_profile, esx_mgmt_if_migration_dest=None, if_id=None, ping_ip=None, vnic=None, vnic_migration_dest=None)¶update(transport_node_profile_id, transport_node_profile, esx_mgmt_if_migration_dest=None, if_id=None, ping_ip=None, vnic=None, vnic_migration_dest=None)¶
When configurations of a transport node profile(TNP) is updated, all the transport nodes in all the compute collections to which this TNP is attached are updated to reflect the updated configuration.
@@ -9046,39 +9046,39 @@ Not Foundcom.vmware.nsx_client.TransportNodes(config)¶com.vmware.nsx_client.TransportNodes(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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().
delete(transport_node_id, force=None, unprepare_host=None)¶delete(transport_node_id, force=None, unprepare_host=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. It also removes the specified node @@ -9213,9 +9213,9 @@ Not Found
deleteontransportnode(target_node_id, target_uri)¶deleteontransportnode(target_node_id, target_uri)¶
Invoke DELETE request on target transport node
disableflowcache(transport_node_id)¶disableflowcache(transport_node_id)¶
Disable flow cache for edge transport node. Caution: This involves restart of the edge dataplane and hence may lead to network disruption.
enableflowcache(transport_node_id)¶enableflowcache(transport_node_id)¶
Enable flow cache for edge transport node. Caution: This involves restart of the edge dataplane and hence may lead to network disruption.
get(transport_node_id)¶get(transport_node_id)¶
Returns information about a specified transport node.
getontransportnode(target_node_id, target_uri)¶getontransportnode(target_node_id, target_uri)¶
Invoke GET request on target transport node
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)¶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 along with underlying host or edge details. A transport node is a host or edge that contains hostswitches. A hostswitch can have virtual machines connected to them. @@ -9447,9 +9447,9 @@ Not Found
postontransportnode(target_node_id, target_uri)¶postontransportnode(target_node_id, target_uri)¶
Invoke POST request on target transport node
putontransportnode(target_node_id, target_uri)¶putontransportnode(target_node_id, target_uri)¶
Invoke PUT request on target transport node
refreshnodeconfiguration(transport_node_id)¶refreshnodeconfiguration(transport_node_id)¶
The API is applicable for Edge transport nodes. If you update the VM configuration and find a discrepancy in VM configuration at NSX Manager, then use this API to refresh configuration at NSX Manager. It @@ -9559,9 +9559,9 @@ Not Found
restoreclusterconfig(transport_node_id)¶restoreclusterconfig(transport_node_id)¶
A host can be overridden to have different configuration than Transport Node Profile(TNP) on cluster. This action will restore such overridden host back to cluster level TNP. This API can be used in other case. @@ -9629,9 +9629,9 @@ Not Found
resynchostconfig(transportnode_id)¶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).
@@ -9662,9 +9662,9 @@ Not Foundupdate(transport_node_id, transport_node, esx_mgmt_if_migration_dest=None, if_id=None, ping_ip=None, vnic=None, vnic_migration_dest=None)¶update(transport_node_id, transport_node, esx_mgmt_if_migration_dest=None, if_id=None, ping_ip=None, vnic=None, vnic_migration_dest=None)¶
Modifies the transport node information. 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 @@ -9731,9 +9731,9 @@ Not Found
updatemaintenancemode(transportnode_id, action=None)¶updatemaintenancemode(transportnode_id, action=None)¶
Put transport node into maintenance mode or exit from maintenance mode.
com.vmware.nsx_client.TransportZones(config)¶com.vmware.nsx_client.TransportZones(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
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 TransportZones.list().
LIST_TRANSPORT_TYPE_VLAN = 'VLAN'¶Possible value for transportType of method TransportZones.list().
delete(zone_id)¶delete(zone_id)¶
Deletes an existing transport zone.
get(zone_id)¶get(zone_id)¶
Returns information about a single transport zone.
list(cursor=None, included_fields=None, is_default=None, page_size=None, sort_ascending=None, sort_by=None, transport_type=None, uplink_teaming_policy_name=None)¶list(cursor=None, included_fields=None, is_default=None, page_size=None, sort_ascending=None, sort_by=None, transport_type=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 @@ -9966,9 +9966,9 @@ Not Found
update(zone_id, transport_zone)¶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.
@@ -10010,18 +10010,18 @@ Not Foundcom.vmware.nsx_client.TransportzoneProfiles(config)¶com.vmware.nsx_client.TransportzoneProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(transport_zone_profile)¶create(transport_zone_profile)¶
Creates a transport zone profile. The resource_type is required.
delete(transportzone_profile_id)¶delete(transportzone_profile_id)¶
Deletes a specified transport zone profile.
get(transportzone_profile_id)¶get(transportzone_profile_id)¶
Returns information about a specified transport zone profile.
list(cursor=None, include_system_owned=None, included_fields=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)¶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.
@@ -10182,9 +10182,9 @@ Not Foundupdate(transportzone_profile_id, transport_zone_profile)¶update(transportzone_profile_id, transport_zone_profile)¶
Modifies a specified transport zone profile. The body of the PUT request must include the resource_type.
com.vmware.nsx_client.TrustManagement(config)¶com.vmware.nsx_client.TrustManagement(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Returns information about the supported algorithms and key sizes.
@@ -10274,18 +10274,18 @@ Not Foundcom.vmware.nsx_client.UiViews(config)¶com.vmware.nsx_client.UiViews(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(tag=None, view_ids=None, widget_id=None)¶get(tag=None, 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.
@@ -10394,9 +10394,9 @@ Not Foundget_0(view_id)¶get_0(view_id)¶
Returns Information about a specific View.
update(view_id, view)¶update(view_id, view)¶
Update View
com.vmware.nsx_client.Upgrade(config)¶com.vmware.nsx_client.Upgrade(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
abortpreupgradechecks()¶Aborts execution of pre-upgrade checks if already in progress. Halts @@ -10513,9 +10513,9 @@ Not Found
executepostupgradechecks(component_type)¶executepostupgradechecks(component_type)¶
Run pre-defined checks to identify issues after upgrade of a component. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of post-upgrade checks is part @@ -10549,9 +10549,9 @@ Not Found
executepreupgradechecks(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶executepreupgradechecks(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Run pre-defined checks to identify potential issues which can be encountered during an upgrade or can cause an upgrade to fail. The results of the checks are added to the respective upgrade units @@ -10597,7 +10597,7 @@ Not Found
upgradeuc()¶Upgrade the upgrade coordinator module itself. This call is invoked @@ -10631,127 +10631,8 @@ Not Found
Convenience methods to get API clients for NSX APIs in VMC
-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
-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
-int
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.
-on_error (bool) – Whether this method is called after getting an error
vmware.vapi.core.SecurityContext
Security context
-should_retry(error_value)¶Returns whether the request should be retried or not based on the error -specified.
-error_value (vmware.vapi.data.value.ErrorValue) – Method error
bool
Returns True if request should be retried in case the error is -either Unauthenticated or Unauthorized else False
-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
-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
-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
vmware.vapi.vmc.client.VmcNsxClient
VMC NSX Client instance
-com.vmware.nsx.aaa.vidm_client.Groups(config)¶com.vmware.nsx.aaa.vidm_client.Groups(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get all the User Groups where vIDM display name matches the search key case insensitively. The search key is checked to be a substring of display name. This is a non paginated API.
@@ -236,18 +236,18 @@ Not Foundcom.vmware.nsx.aaa.vidm_client.Search(config)¶com.vmware.nsx.aaa.vidm_client.Search(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶create(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. This is a @@ -297,9 +297,9 @@ Not Found
com.vmware.nsx.aaa.vidm_client.StubFactory(stub_config)¶com.vmware.nsx.aaa.vidm_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.aaa.vidm_client.Users(config)¶com.vmware.nsx.aaa.vidm_client.Users(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(search_string, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non diff --git a/nsx/nsx/com.vmware.nsx.app_discovery.html b/nsx/nsx/com.vmware.nsx.app_discovery.html index 9f2ef725..b4481181 100644 --- a/nsx/nsx/com.vmware.nsx.app_discovery.html +++ b/nsx/nsx/com.vmware.nsx.app_discovery.html @@ -8,7 +8,7 @@ -
com.vmware.nsx.app_discovery.sessions_client.AppProfiles(config)¶com.vmware.nsx.app_discovery.sessions_client.AppProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(session_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(session_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns the application profiles that was part of the application discovery session | while it was started.
com.vmware.nsx.app_discovery.sessions_client.InstalledApps(config)¶com.vmware.nsx.app_discovery.sessions_client.InstalledApps(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(session_id, app_profile_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, vm_id=None)¶list(session_id, app_profile_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, vm_id=None)¶
Returns the details of the installed apps for the app profile ID in that session
com.vmware.nsx.app_discovery.sessions_client.NsGroups(config)¶com.vmware.nsx.app_discovery.sessions_client.NsGroups(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(session_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(session_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns the ns groups that was part of the application discovery session | while it was started
com.vmware.nsx.app_discovery.sessions_client.ReClassify(config)¶com.vmware.nsx.app_discovery.sessions_client.ReClassify(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(session_id, session_reclassification_parameter)¶create(session_id, session_reclassification_parameter)¶
Re-classify completed application discovery session against input AppProfiles. If no AppProfiles are specified then we use the previous AppProfiles of that session.
@@ -420,9 +420,9 @@ Not Foundcom.vmware.nsx.app_discovery.sessions_client.StubFactory(stub_config)¶com.vmware.nsx.app_discovery.sessions_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.app_discovery.sessions_client.Summary(config)¶com.vmware.nsx.app_discovery.sessions_client.Summary(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(session_id)¶get(session_id)¶
Returns the summary of the application discovery session
com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members(config)¶com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(session_id, ns_group_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(session_id, ns_group_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns the vms in the ns-group of the application discovery session
com.vmware.nsx.app_discovery.sessions.ns_groups_client.StubFactory(stub_config)¶com.vmware.nsx.app_discovery.sessions.ns_groups_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.cluster.backups_client.Config(config)¶com.vmware.nsx.cluster.backups_client.Config(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Get a configuration of a file server and timers for automated backup. @@ -242,9 +242,9 @@ Not Found
update(backup_configuration)¶update(backup_configuration)¶
Configure file server and timers for automated backup. If secret fields are omitted (password, passphrase) then use the previously set value.
com.vmware.nsx.cluster.backups_client.History(config)¶com.vmware.nsx.cluster.backups_client.History(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Get history of previous backup operations
@@ -327,16 +327,16 @@ Not Foundcom.vmware.nsx.cluster.backups_client.Status(config)¶com.vmware.nsx.cluster.backups_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Get status of active backup operations
@@ -372,9 +372,9 @@ Not Foundcom.vmware.nsx.cluster.nodes_client.Deployments(config)¶com.vmware.nsx.cluster.nodes_client.Deployments(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
delete(node_id, force_delete=None)¶delete(node_id, force_delete=None)¶
Attempts to unregister and undeploy a specified auto-deployed cluster node VM. If it is a member of a cluster, then the VM will be automatically detached from the cluster before being unregistered and @@ -476,9 +476,9 @@ Not Found
get(node_id)¶get(node_id)¶
Returns deployment request information for a specific attempted deployment of a cluster node VM.
list()¶Returns request information for every attempted deployment of a cluster @@ -551,30 +551,30 @@ Not Found
com.vmware.nsx.cluster.nodes_client.Status(config)¶com.vmware.nsx.cluster.nodes_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Status.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Status.get().
com.vmware.nsx.cluster.restore_client.Backuptimestamps(config)¶com.vmware.nsx.cluster.restore_client.Backuptimestamps(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶get(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns timestamps for all backup files that are available on the SFTP server.
com.vmware.nsx.cluster.restore_client.Config(config)¶com.vmware.nsx.cluster.restore_client.Config(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Get configuration information for the file server used to store @@ -767,9 +767,9 @@ Not Found
update(restore_configuration)¶update(restore_configuration)¶
Configure file server where the backed-up files used for the Restore operation are available.
com.vmware.nsx.cluster.restore_client.InstructionResources(config)¶com.vmware.nsx.cluster.restore_client.InstructionResources(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(instruction_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶get(instruction_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
For restore operations requiring user input e.g. performing an action, accepting/rejecting an action, etc. the information to be conveyed to users is provided in this call.
@@ -868,16 +868,16 @@ Not Foundcom.vmware.nsx.cluster.restore_client.Status(config)¶com.vmware.nsx.cluster.restore_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Returns status information for the specified NSX cluster restore @@ -914,9 +914,9 @@ Not Found
com.vmware.nsx.cluster.restore_client.StubFactory(stub_config)¶com.vmware.nsx.cluster.restore_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.cluster.nodes.deployments_client.Status(config)¶com.vmware.nsx.cluster.nodes.deployments_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
com.vmware.nsx.cluster.nodes.network_client.Interfaces(config)¶com.vmware.nsx.cluster.nodes.network_client.Interfaces(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Interfaces.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Interfaces.get().
LIST_SOURCE_CACHED = 'cached'¶Possible value for source of method Interfaces.list().
LIST_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Interfaces.list().
get(node_id, interface_id, source=None)¶get(node_id, interface_id, source=None)¶
Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration @@ -331,9 +331,9 @@ Not Found
com.vmware.nsx.cluster.nodes.repo_sync_client.Status(config)¶com.vmware.nsx.cluster.nodes.repo_sync_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(node_id)¶get(node_id)¶
node_id (str) – (required)
com.vmware.nsx.cluster.nodes.repo_sync_client.StubFactory(stub_config)¶com.vmware.nsx.cluster.nodes.repo_sync_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats(config)¶com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Stats.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Stats.get().
get(node_id, interface_id, source=None)¶get(node_id, interface_id, source=None)¶
On the specified interface, returns the number of received (rx), transmitted (tx), and dropped packets; the number of bytes and errors received and transmitted on the interface; and the number of detected @@ -247,9 +247,9 @@ Not Found
com.vmware.nsx.cluster.nodes.network.interfaces_client.StubFactory(stub_config)¶com.vmware.nsx.cluster.nodes.network.interfaces_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.configs.node_client.Mode(config)¶com.vmware.nsx.configs.node_client.Mode(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(switching_to_vmc_mode_parameters)¶create(switching_to_vmc_mode_parameters)¶
Currently only a switch from “VMC_LOCAL” to “VMC” is supported. Returns a new Node Mode, if the request successfuly changed it.
com.vmware.nsx.configs.node_client.StubFactory(stub_config)¶com.vmware.nsx.configs.node_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.dhcp.servers_client.IpPools(config)¶com.vmware.nsx.dhcp.servers_client.IpPools(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(server_id, dhcp_ip_pool)¶create(server_id, dhcp_ip_pool)¶
Create an ip pool for a local DHCP server
delete(server_id, pool_id)¶delete(server_id, pool_id)¶
Delete a specific ip pool of a given logical DHCP server.
get(server_id, pool_id)¶get(server_id, pool_id)¶
Return a specific ip pool of a given logical DHCP server.
list(server_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(server_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
List the ip pools of a logical DHCP server with pagination support.
update(server_id, pool_id, dhcp_ip_pool)¶update(server_id, pool_id, dhcp_ip_pool)¶
Update a specific ip pool of a given logical DHCP server.
com.vmware.nsx.dhcp.servers_client.Leases(config)¶com.vmware.nsx.dhcp.servers_client.Leases(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Leases.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Leases.get().
get(server_id, address=None, pool_id=None, source=None)¶get(server_id, address=None, pool_id=None, source=None)¶
Get specific leases of a given dhcp server. As a dhcp server could manage millions of leases, the API has to limit the number of the returned leases via two mutually-excluded request parameters, i.e. @@ -518,18 +518,18 @@ Not Found
com.vmware.nsx.dhcp.servers_client.State(config)¶com.vmware.nsx.dhcp.servers_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(server_id, barrier_id=None, request_id=None)¶get(server_id, barrier_id=None, request_id=None)¶
Return realized state information of a dhcp server. After a dhcp server is created or updated, you can invoke this API to get the realization information of the server.
@@ -572,18 +572,18 @@ Not Foundcom.vmware.nsx.dhcp.servers_client.StaticBindings(config)¶com.vmware.nsx.dhcp.servers_client.StaticBindings(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(server_id, dhcp_static_binding)¶create(server_id, dhcp_static_binding)¶
Create a static binding for a logical DHCP server.
delete(server_id, binding_id)¶delete(server_id, binding_id)¶
Delete a specific static binding of a given logical DHCP server.
get(server_id, binding_id)¶get(server_id, binding_id)¶
Return a specific static binding of a given logical DHCP server.
list(server_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(server_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Return a paginated list of a static bindings of a given logical DHCP server.
update(server_id, binding_id, dhcp_static_binding)¶update(server_id, binding_id, dhcp_static_binding)¶
Update a specific static binding of a given local DHCP server.
com.vmware.nsx.dhcp.servers_client.Statistics(config)¶com.vmware.nsx.dhcp.servers_client.Statistics(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(server_id)¶get(server_id)¶
Returns the statistics of the given dhcp server.
com.vmware.nsx.dhcp.servers_client.Status(config)¶com.vmware.nsx.dhcp.servers_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(server_id)¶get(server_id)¶
Returns the service status of the given dhcp server.
com.vmware.nsx.dhcp.servers_client.StubFactory(stub_config)¶com.vmware.nsx.dhcp.servers_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.dhcp.servers.ip_pools_client.State(config)¶com.vmware.nsx.dhcp.servers.ip_pools_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(server_id, pool_id, barrier_id=None, request_id=None)¶get(server_id, pool_id, barrier_id=None, request_id=None)¶
Return realized state information of a dhcp ip pool. After a dhcp ip pool is created or updated, you can invoke this API to get the realization information of the ip pool.
@@ -233,9 +233,9 @@ Not Foundcom.vmware.nsx.dhcp.servers.static_bindings_client.State(config)¶com.vmware.nsx.dhcp.servers.static_bindings_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(server_id, binding_id, barrier_id=None, request_id=None)¶get(server_id, binding_id, barrier_id=None, request_id=None)¶
Return realized state information of a dhcp static binding. After a dhcp static binding is created or updated, you can invoke this API to get the realization information of the static binding.
@@ -303,9 +303,9 @@ Not Foundcom.vmware.nsx.dhcp.servers.static_bindings_client.StubFactory(stub_config)¶com.vmware.nsx.dhcp.servers.static_bindings_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.directory.domains.groups_client.MemberGroups(config)¶com.vmware.nsx.directory.domains.groups_client.MemberGroups(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(domain_id, group_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(domain_id, group_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
A member group could be either direct member of the group specified by group_id or nested member of it. Both direct member groups and nested member groups are returned.
@@ -239,9 +239,9 @@ Not Foundcom.vmware.nsx.directory.domains.groups_client.StubFactory(stub_config)¶com.vmware.nsx.directory.domains.groups_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.directory.domains_client.Groups(config)¶com.vmware.nsx.directory.domains_client.Groups(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(domain_id, filter_value, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(domain_id, filter_value, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search @@ -252,24 +252,24 @@ Not Found
com.vmware.nsx.directory.domains_client.LdapServers(config)¶com.vmware.nsx.directory.domains_client.LdapServers(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
CREATE_0_ACTION_CONNECTIVITY = 'CONNECTIVITY'¶Possible value for action of method LdapServers.create_0().
create(domain_id, directory_ldap_server)¶create(domain_id, directory_ldap_server)¶
More than one LDAP server can be created and only one LDAP server is used to synchronize directory objects. If more than one LDAP server is configured, NSX will try all the servers until it is able to @@ -310,9 +310,9 @@ Not Found
create_0(domain_id, server_id, action)¶create_0(domain_id, server_id, action)¶
The API tests a LDAP server connection for an already configured domain. If the connection is successful, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and @@ -348,9 +348,9 @@ Not Found
delete(domain_id, server_id)¶delete(domain_id, server_id)¶
Delete a LDAP server for directory domain
get(domain_id, server_id)¶get(domain_id, server_id)¶
Get a specific LDAP server for a given directory domain
list(domain_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(domain_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
List all configured domain LDAP servers
update(domain_id, server_id, directory_ldap_server)¶update(domain_id, server_id, directory_ldap_server)¶
Update a LDAP server for directory domain
com.vmware.nsx.directory.domains_client.StubFactory(stub_config)¶com.vmware.nsx.directory.domains_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.directory.domains_client.SyncStats(config)¶com.vmware.nsx.directory.domains_client.SyncStats(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(domain_id)¶get(domain_id)¶
Get domain sync statistics for the given identifier
com.vmware.nsx.dns.forwarders_client.FailedQueries(config)¶com.vmware.nsx.dns.forwarders_client.FailedQueries(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(forwarder_id, count=None)¶get(forwarder_id, count=None)¶
Return the given count of recent failed DNS queries from DNS forwarder. Since the DNS forwarder is running in Acitve/Standby HA mode on transport nodes, the given count of queries will be returned from each @@ -233,18 +233,18 @@ Not Found
com.vmware.nsx.dns.forwarders_client.Nslookup(config)¶com.vmware.nsx.dns.forwarders_client.Nslookup(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(forwarder_id, address=None, server_ip=None, source_ip=None)¶get(forwarder_id, address=None, server_ip=None, source_ip=None)¶
Query the nameserver for an ip-address or a FQDN of the given an address optionally using an specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it. If the address is an @@ -289,18 +289,18 @@ Not Found
com.vmware.nsx.dns.forwarders_client.State(config)¶com.vmware.nsx.dns.forwarders_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(forwarder_id, barrier_id=None, request_id=None)¶get(forwarder_id, barrier_id=None, request_id=None)¶
Return the realized state information of a DNS forwarder. After a DNS forwarder was created or updated, you can invoke this API to check the realization state of the forwarder.
@@ -343,18 +343,18 @@ Not Foundcom.vmware.nsx.dns.forwarders_client.Statistics(config)¶com.vmware.nsx.dns.forwarders_client.Statistics(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(forwarder_id)¶get(forwarder_id)¶
Returns the statistics of the given dns forwarder specified by forwarder id.
com.vmware.nsx.dns.forwarders_client.Status(config)¶com.vmware.nsx.dns.forwarders_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(forwarder_id)¶get(forwarder_id)¶
Returns the current status of the given DNS forwarder.
com.vmware.nsx.dns.forwarders_client.StubFactory(stub_config)¶com.vmware.nsx.dns.forwarders_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces(config)¶com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(cc_ext_id)¶list(cc_ext_id)¶
Returns list of physical network interfaces for all discovered nodes in compute collection. Interface information includes PNIC name, hostswitch name it’s attached to(if any) and MAC address.
@@ -228,9 +228,9 @@ Not Foundcom.vmware.nsx.fabric.compute_collections.network_client.StubFactory(stub_config)¶com.vmware.nsx.fabric.compute_collections.network_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.fabric.compute_collections_client.MemberStatus(config)¶com.vmware.nsx.fabric.compute_collections_client.MemberStatus(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
com.vmware.nsx.fabric.compute_managers_client.State(config)¶com.vmware.nsx.fabric.compute_managers_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(compute_manager_id)¶get(compute_manager_id)¶
Get the realized state of a compute manager
com.vmware.nsx.fabric.compute_managers_client.Status(config)¶com.vmware.nsx.fabric.compute_managers_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
com.vmware.nsx.fabric.nodes_client.Capabilities(config)¶com.vmware.nsx.fabric.nodes_client.Capabilities(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(node_id)¶get(node_id)¶
Returns information about capabilities of a single fabric host node. Edge nodes do not have capabilities. This api is deprecated, use GET /transport-nodes/<transportnode-id>/capabilities if FN is converted to @@ -428,18 +428,18 @@ Not Found
com.vmware.nsx.fabric.nodes_client.Modules(config)¶com.vmware.nsx.fabric.nodes_client.Modules(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(node_id)¶get(node_id)¶
Get the module details of a Fabric Node This api is deprecated, use Transport Node API GET /transport-nodes/<transportnode-id>/modules to get fabric node modules.
@@ -478,18 +478,18 @@ Not Foundcom.vmware.nsx.fabric.nodes_client.State(config)¶com.vmware.nsx.fabric.nodes_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(node_id)¶get(node_id)¶
For edge nodes, returns the current install state when deployment is in progress, NODE_READY when deployment is complete and the failure state when deployment has failed. This api is deprecated. Please use @@ -530,30 +530,30 @@ Not Found
com.vmware.nsx.fabric.nodes_client.Status(config)¶com.vmware.nsx.fabric.nodes_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Status.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Status.get().
com.vmware.nsx.fabric.virtual_machines_client.StubFactory(stub_config)¶com.vmware.nsx.fabric.virtual_machines_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.fabric.virtual_machines_client.ToolsInfo(config)¶com.vmware.nsx.fabric.virtual_machines_client.ToolsInfo(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
This API returns the list of tools and agents installed in VMs.
com.vmware.nsx.fabric.nodes.network_client.Interfaces(config)¶com.vmware.nsx.fabric.nodes.network_client.Interfaces(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Interfaces.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Interfaces.get().
LIST_SOURCE_CACHED = 'cached'¶Possible value for source of method Interfaces.list().
LIST_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Interfaces.list().
get(node_id, interface_id, source=None)¶get(node_id, interface_id, source=None)¶
list(node_id, source=None)¶list(node_id, source=None)¶
com.vmware.nsx.fabric.nodes.network_client.StubFactory(stub_config)¶com.vmware.nsx.fabric.nodes.network_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.fabric.nodes.network.interfaces_client.Stats(config)¶com.vmware.nsx.fabric.nodes.network.interfaces_client.Stats(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Stats.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Stats.get().
get(node_id, interface_id, source=None)¶get(node_id, interface_id, source=None)¶
com.vmware.nsx.fabric.nodes.network.interfaces_client.StubFactory(stub_config)¶com.vmware.nsx.fabric.nodes.network.interfaces_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.firewall.rules_client.State(config)¶com.vmware.nsx.firewall.rules_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
com.vmware.nsx.firewall.sections_client.Rules(config)¶com.vmware.nsx.firewall.sections_client.Rules(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
CREATEMULTIPLE_OPERATION_AFTER = 'insert_after'¶Possible value for operation of method Rules.createmultiple().
CREATEMULTIPLE_OPERATION_BEFORE = 'insert_before'¶Possible value for operation of method Rules.createmultiple().
CREATEMULTIPLE_OPERATION_BOTTOM = 'insert_bottom'¶Possible value for operation of method Rules.createmultiple().
CREATEMULTIPLE_OPERATION_TOP = 'insert_top'¶Possible value for operation of method Rules.createmultiple().
CREATE_OPERATION_AFTER = 'insert_after'¶Possible value for operation of method Rules.create().
CREATE_OPERATION_BEFORE = 'insert_before'¶Possible value for operation of method Rules.create().
CREATE_OPERATION_BOTTOM = 'insert_bottom'¶Possible value for operation of method Rules.create().
CREATE_OPERATION_TOP = 'insert_top'¶Possible value for operation of method Rules.create().
LIST_FILTER_TYPE_FILTER = 'FILTER'¶Possible value for filterType of method Rules.list().
LIST_FILTER_TYPE_SEARCH = 'SEARCH'¶Possible value for filterType of method Rules.list().
REVISE_OPERATION_AFTER = 'insert_after'¶Possible value for operation of method Rules.revise().
REVISE_OPERATION_BEFORE = 'insert_before'¶Possible value for operation of method Rules.revise().
REVISE_OPERATION_BOTTOM = 'insert_bottom'¶Possible value for operation of method Rules.revise().
REVISE_OPERATION_TOP = 'insert_top'¶Possible value for operation of method Rules.revise().
create(section_id, firewall_rule, id=None, operation=None)¶create(section_id, firewall_rule, id=None, operation=None)¶
Adds a new firewall rule in existing firewall section. Adding firewall rule to a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent @@ -399,9 +399,9 @@ Not Found
createmultiple(section_id, firewall_rule_list, id=None, operation=None)¶createmultiple(section_id, firewall_rule_list, id=None, operation=None)¶
Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section. Adding multiple firewall rules in a section modifies parent section entity and simultaneous @@ -450,9 +450,9 @@ Not Found
get(section_id, rule_id)¶get(section_id, rule_id)¶
Return existing firewall rule information in a firewall section.
list(section_id, applied_tos=None, context_profiles=None, cursor=None, deep_search=None, destinations=None, extended_sources=None, filter_type=None, included_fields=None, page_size=None, search_invalid_references=None, services=None, sort_ascending=None, sort_by=None, sources=None)¶list(section_id, applied_tos=None, context_profiles=None, cursor=None, deep_search=None, destinations=None, extended_sources=None, filter_type=None, included_fields=None, page_size=None, search_invalid_references=None, services=None, sort_ascending=None, sort_by=None, sources=None)¶
Return all firewall rule(s) information for a given firewall section.
revise(section_id, rule_id, firewall_rule, id=None, operation=None)¶revise(section_id, rule_id, firewall_rule, id=None, operation=None)¶
Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section. Revising firewall rule in a section modifies parent section entity and simultaneous update @@ -645,9 +645,9 @@ Not Found
update(section_id, rule_id, firewall_rule)¶update(section_id, rule_id, firewall_rule)¶
Modifies existing firewall rule in a firewall section. Updating firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed @@ -694,18 +694,18 @@ Not Found
com.vmware.nsx.firewall.sections_client.State(config)¶com.vmware.nsx.firewall.sections_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(section_id, barrier_id=None, request_id=None)¶get(section_id, barrier_id=None, request_id=None)¶
Return realized state information of a firewall section.
com.vmware.nsx.firewall.sections_client.StubFactory(stub_config)¶com.vmware.nsx.firewall.sections_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.firewall.sections_client.Summary(config)¶com.vmware.nsx.firewall.sections_client.Summary(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Summary.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Summary.get().
get(source=None)¶get(source=None)¶
List the summary of number of sections and number of rules for each firewall category (L2DFW, L3DFW).
com.vmware.nsx.firewall.sections.rules_client.Stats(config)¶com.vmware.nsx.firewall.sections.rules_client.Stats(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_0_SOURCE_CACHED = 'cached'¶Possible value for source of method Stats.get_0().
GET_0_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Stats.get_0().
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Stats.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Stats.get().
get(section_id, source=None)¶get(section_id, source=None)¶
Get aggregated statistics for all rules for a given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, @@ -260,9 +260,9 @@ Not Found
get_0(section_id, rule_id, source=None)¶get_0(section_id, rule_id, source=None)¶
Get aggregated statistics for a rule for given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, @@ -312,9 +312,9 @@ Not Found
com.vmware.nsx.firewall.sections.rules_client.StubFactory(stub_config)¶com.vmware.nsx.firewall.sections.rules_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.aaa_client.RegistrationToken(config)¶com.vmware.nsx.aaa_client.RegistrationToken(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create()¶The privileges of the registration token will be the same as the @@ -601,9 +601,9 @@ Not Found
delete(token)¶delete(token)¶
Delete registration access token
com.vmware.nsx.aaa_client.RoleBindings(config)¶com.vmware.nsx.aaa_client.RoleBindings(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_TYPE_LOCAL_USER = 'local_user'¶Possible value for type of method RoleBindings.list().
LIST_TYPE_PRINCIPAL_IDENTITY = 'principal_identity'¶Possible value for type of method RoleBindings.list().
LIST_TYPE_REMOTE_GROUP = 'remote_group'¶Possible value for type of method RoleBindings.list().
LIST_TYPE_REMOTE_USER = 'remote_user'¶Possible value for type of method RoleBindings.list().
delete(binding_id)¶delete(binding_id)¶
Delete user/group’s roles assignment
deletestalebindings()¶Delete all stale role assignments
@@ -804,9 +804,9 @@ Not Foundget(binding_id)¶get(binding_id)¶
Get user/group’s role information
list(cursor=None, included_fields=None, name=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶list(cursor=None, included_fields=None, name=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶
Get all users and groups with their roles
update(binding_id, role_binding)¶update(binding_id, role_binding)¶
Update User or Group’s roles
com.vmware.nsx.aaa_client.Roles(config)¶com.vmware.nsx.aaa_client.Roles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list()¶Get information about all roles
@@ -1013,9 +1013,9 @@ Not Foundcom.vmware.nsx.aaa_client.StubFactory(stub_config)¶com.vmware.nsx.aaa_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.aaa_client.UserInfo(config)¶com.vmware.nsx.aaa_client.UserInfo(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Get information about logged-in user. The permissions parameter of the @@ -1074,18 +1074,18 @@ Not Found
com.vmware.nsx.administration_client.AuditLogs(config)¶com.vmware.nsx.administration_client.AuditLogs(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(audit_log_request, cursor=None, fields=None, page_size=None)¶create(audit_log_request, cursor=None, fields=None, page_size=None)¶
This API is executed on a manager node to display audit logs from all nodes inside the management plane cluster. An audit log collection will be triggered if the local master audit log is outdated.
@@ -1135,9 +1135,9 @@ Not Foundcom.vmware.nsx.administration_client.StubFactory(stub_config)¶com.vmware.nsx.administration_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.administration_client.SupportBundles(config)¶com.vmware.nsx.administration_client.SupportBundles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
collect(support_bundle_request, override_async_response=None, require_delete_or_override_async_response=None)¶collect(support_bundle_request, override_async_response=None, require_delete_or_override_async_response=None)¶
Collect support bundles from registered cluster and fabric nodes.
deleteasyncresponse()¶Delete existing support bundles waiting to be downloaded.
@@ -1240,18 +1240,18 @@ Not Foundcom.vmware.nsx.app_discovery_client.AppProfiles(config)¶com.vmware.nsx.app_discovery_client.AppProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(app_profile)¶create(app_profile)¶
Adds a new app profile
delete(app_profile_id, force=None)¶delete(app_profile_id, force=None)¶
Deletes the specified AppProfile.
get(app_profile_id)¶get(app_profile_id)¶
Returns detail of the app profile
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns list of app profile IDs created
update(app_profile_id, app_profile)¶update(app_profile_id, app_profile)¶
Update AppProfile
com.vmware.nsx.app_discovery_client.Sessions(config)¶com.vmware.nsx.app_discovery_client.Sessions(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_STATUS_FAILED = 'FAILED'¶Possible value for status of method Sessions.list().
LIST_STATUS_FINISHED = 'FINISHED'¶Possible value for status of method Sessions.list().
LIST_STATUS_RUNNING = 'RUNNING'¶Possible value for status of method Sessions.list().
LIST_STATUS_STARTING = 'STARTING'¶Possible value for status of method Sessions.list().
create(start_app_discovery_session_parameters)¶create(start_app_discovery_session_parameters)¶
Starts the discovery of application discovery session
delete(session_id)¶delete(session_id)¶
Cancel and delete the application discovery session
get(session_id)¶get(session_id)¶
Returns the status of the application discovery session and other details
list(cursor=None, group_id=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, status=None)¶list(cursor=None, group_id=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, status=None)¶
Returns the list of the application discovery sessions available
com.vmware.nsx.bridge_clusters_client.Status(config)¶com.vmware.nsx.bridge_clusters_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Status.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Status.get().
com.vmware.nsx.bridge_endpoints_client.Statistics(config)¶com.vmware.nsx.bridge_endpoints_client.Statistics(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Statistics.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Statistics.get().
get(endpoint_id, source=None)¶get(endpoint_id, source=None)¶
Get the statistics for the Bridge Endpoint of the given Endpoint id (endpoint-id)
com.vmware.nsx.bridge_endpoints_client.Status(config)¶com.vmware.nsx.bridge_endpoints_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Status.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Status.get().
com.vmware.nsx.capacity_client.StubFactory(stub_config)¶com.vmware.nsx.capacity_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.capacity_client.Threshold(config)¶com.vmware.nsx.capacity_client.Threshold(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Returns warning threshold(s) set for NSX Objects.
@@ -1926,9 +1926,9 @@ Not Foundupdate(capacity_threshold_list)¶update(capacity_threshold_list)¶
Updates the warning threshold(s) for NSX Objects specified, and returns new threshold(s). Threshold list in the request must contain value for GLOBAL_DEFAULT threshold_type which represents global thresholds.
@@ -1967,18 +1967,18 @@ Not Foundcom.vmware.nsx.capacity_client.Usage(config)¶com.vmware.nsx.capacity_client.Usage(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(category=None, cursor=None, force=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶get(category=None, cursor=None, force=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns capacity usage data for NSX objects
com.vmware.nsx.cluster_client.ApiCertificate(config)¶com.vmware.nsx.cluster_client.ApiCertificate(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
clearclustercertificate(certificate_id)¶clearclustercertificate(certificate_id)¶
Clears the certificate used for the MP cluster. This does not affect the certificate itself. This API is deprecated. Instead use the /api/v1/cluster/api-certificate?action=set_cluster_certificate API to @@ -2080,7 +2080,7 @@ Not Found
get()¶Returns the ID of the certificate that is used as the cluster @@ -2115,9 +2115,9 @@ Not Found
setclustercertificate(certificate_id)¶setclustercertificate(certificate_id)¶
Sets the certificate used for the MP cluster. Issuing this request causes the http service to restart so that the service can begin using the new certificate. When the POST request succeeds, it doesn’t return @@ -2158,16 +2158,16 @@ Not Found
com.vmware.nsx.cluster_client.ApiService(config)¶com.vmware.nsx.cluster_client.ApiService(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Read the configuration of the NSX API service.
@@ -2201,9 +2201,9 @@ Not Foundupdate(api_service_config)¶update(api_service_config)¶
Read the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a @@ -2244,16 +2244,16 @@ Not Found
com.vmware.nsx.cluster_client.ApiVirtualIp(config)¶com.vmware.nsx.cluster_client.ApiVirtualIp(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
clearvirtualip()¶Clears the cluster virtual IP address.
@@ -2287,7 +2287,7 @@ Not Foundget()¶Returns the configured cluster virtual IP address or null if not @@ -2322,9 +2322,9 @@ Not Found
setvirtualip(ip_address)¶setvirtualip(ip_address)¶
Sets the cluster virtual IP address. Note, all nodes in the management cluster must be in the same subnet. If not, a 409 CONFLICT status is returned.
@@ -2367,18 +2367,18 @@ Not Foundcom.vmware.nsx.cluster_client.Backups(config)¶com.vmware.nsx.cluster_client.Backups(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
retrievesshfingerprint(remote_server_fingerprint_request)¶retrievesshfingerprint(remote_server_fingerprint_request)¶
Get SHA256 fingerprint of ECDSA key of remote server. The caller should independently verify that the key is trusted.
com.vmware.nsx.cluster_client.Node(config)¶com.vmware.nsx.cluster_client.Node(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
reposync()¶Attempts to synchronize the repository partition on nsx manager. @@ -2458,24 +2458,24 @@ Not Found
com.vmware.nsx.cluster_client.Nodes(config)¶com.vmware.nsx.cluster_client.Nodes(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
CREATE_ACTION_NODE = 'add_cluster_node'¶Possible value for action of method Nodes.create().
delete(node_id)¶delete(node_id)¶
node_id (str) – (required)
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all NSX cluster nodes. Deprecated. Use GET /cluster to get cluster configuration.
com.vmware.nsx.cluster_client.Restore(config)¶com.vmware.nsx.cluster_client.Restore(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
advance(advance_cluster_restore_request)¶advance(advance_cluster_restore_request)¶
Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a @@ -2685,7 +2685,7 @@ Not Found
cancel()¶This operation is only valid when a restore is in suspended state. The @@ -2731,7 +2731,7 @@ Not Found
retry()¶Retry any currently in-progress, failed restore operation. Only the @@ -2773,9 +2773,9 @@ Not Found
start(initiate_cluster_restore_request)¶start(initiate_cluster_restore_request)¶
Start the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. @@ -2817,7 +2817,7 @@ Not Found
suspend()¶Suspend any currently running restore operation. The restore operation @@ -2863,16 +2863,16 @@ Not Found
com.vmware.nsx.cluster_client.Status(config)¶com.vmware.nsx.cluster_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Returns status information for the NSX cluster control role and @@ -2909,9 +2909,9 @@ Not Found
com.vmware.nsx.compute_collection_transport_node_templates_client.State(config)¶com.vmware.nsx.compute_collection_transport_node_templates_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(template_id, compute_collection_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(template_id, compute_collection_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns detailed transport node states for this compute collection Note- transport node templates APIs are deprecated and user is recommended to use transport node profiles APIs instead.
@@ -2985,9 +2985,9 @@ Not Foundcom.vmware.nsx.compute_collection_transport_node_templates_client.StubFactory(stub_config)¶com.vmware.nsx.compute_collection_transport_node_templates_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.configs_client.Inventory(config)¶com.vmware.nsx.configs_client.Inventory(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Supports retrieving following configuration of inventory module 1. Soft @@ -3046,16 +3046,16 @@ Not Found
com.vmware.nsx.configs_client.Management(config)¶com.vmware.nsx.configs_client.Management(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Returns the NSX Management nodes global configuration.
@@ -3089,9 +3089,9 @@ Not Foundcom.vmware.nsx.dhcp_client.RelayProfiles(config)¶com.vmware.nsx.dhcp_client.RelayProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(dhcp_relay_profile)¶create(dhcp_relay_profile)¶
Creates a dhcp relay profile.
delete(relay_profile_id)¶delete(relay_profile_id)¶
Deletes the specified dhcp relay profile.
get(relay_profile_id)¶get(relay_profile_id)¶
Returns information about the specified dhcp relay profile.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all dhcp relay profiles.
update(relay_profile_id, dhcp_relay_profile)¶update(relay_profile_id, dhcp_relay_profile)¶
Modifies the specified dhcp relay profile.
com.vmware.nsx.dhcp_client.Relays(config)¶com.vmware.nsx.dhcp_client.Relays(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(dhcp_relay_service)¶create(dhcp_relay_service)¶
Creates a dhcp relay service.
delete(relay_id)¶delete(relay_id)¶
Deletes the specified dhcp relay service.
get(relay_id)¶get(relay_id)¶
Returns the dhcp relay service information.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all configured dhcp relay services.
update(relay_id, dhcp_relay_service)¶update(relay_id, dhcp_relay_service)¶
Modifies the specified dhcp relay service.
com.vmware.nsx.dhcp_client.ServerProfiles(config)¶com.vmware.nsx.dhcp_client.ServerProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
delete(profile_id)¶delete(profile_id)¶
Delete a DHCP server profile specified by the profile id.
get(profile_id)¶get(profile_id)¶
Return the DHCP profile specified by the profile id.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get a paginated list of DHCP server profiles.
reallocate(server_profile_id, dhcp_profile)¶reallocate(server_profile_id, dhcp_profile)¶
As changing edge-cluster-id of a DhcpProfile by a PUT is disallowed, this re-allocate API is used to modify the edge-cluster-id and members of a given DhcpProfile. Only the edge-cluster-id and the @@ -3766,9 +3766,9 @@ Not Found
update(profile_id, dhcp_profile)¶update(profile_id, dhcp_profile)¶
Please note, the edge_cluster_id in DhcpProfile can NOT be changed by this PUT operation because all existing DHCP leases will lost. If loosing leases is not a problem, a dedicated re-allocation API is @@ -3816,18 +3816,18 @@ Not Found
com.vmware.nsx.dhcp_client.Servers(config)¶com.vmware.nsx.dhcp_client.Servers(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(logical_dhcp_server)¶create(logical_dhcp_server)¶
Create a logical DHCP server.
delete(server_id)¶delete(server_id)¶
Delete a logical DHCP server specified by server id.
get(server_id)¶get(server_id)¶
Retrieve a logical DHCP server specified by server id.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
List logical DHCP servers with pagination support.
com.vmware.nsx.directory_client.Domains(config)¶com.vmware.nsx.directory_client.Domains(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
CREATE_0_ACTION_DELTA_SYNC = 'DELTA_SYNC'¶Possible value for action of method Domains.create_0().
CREATE_0_ACTION_FULL_SYNC = 'FULL_SYNC'¶Possible value for action of method Domains.create_0().
CREATE_0_ACTION_STOP_SYNC = 'STOP_SYNC'¶Possible value for action of method Domains.create_0().
delete(domain_id, force=None)¶delete(domain_id, force=None)¶
Delete a specific domain with given identifier
get(domain_id)¶get(domain_id)¶
Get a specific domain with given identifier
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
List all configured domains
update(domain_id, directory_domain)¶update(domain_id, directory_domain)¶
Update to any field in the directory domain will trigger a full sync
com.vmware.nsx.directory_client.LdapServer(config)¶com.vmware.nsx.directory_client.LdapServer(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
CREATE_ACTION_CONNECTIVITY = 'CONNECTIVITY'¶Possible value for action of method LdapServer.create().
create(directory_ldap_server, action)¶create(directory_ldap_server, action)¶
This API tests a LDAP server connectivity before the actual domain or LDAP server is configured. If the connectivity is good, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 @@ -4365,9 +4365,9 @@ Not Found
com.vmware.nsx.dns_client.Forwarders(config)¶com.vmware.nsx.dns_client.Forwarders(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
clearcache(forwarder_id)¶clearcache(forwarder_id)¶
Clear the current cache of the DNS forwarder.
create(dns_forwarder)¶create(dns_forwarder)¶
Create a DNS forwader upon a logical router. There is only one DNS forwarder can be created upon a given logical router.
get(forwarder_id)¶get(forwarder_id)¶
Retrieve a DNS forwarder.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get a paginated list of DNS forwarders.
com.vmware.nsx.edge_clusters_client.AllocationStatus(config)¶com.vmware.nsx.edge_clusters_client.AllocationStatus(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(edge_cluster_id)¶get(edge_cluster_id)¶
Returns the allocation details of cluster and its members. Lists the edge node members, active and standby services of each node, utilization details of configured sub-pools. These allocation details @@ -4750,18 +4750,18 @@ Not Found
com.vmware.nsx.edge_clusters_client.State(config)¶com.vmware.nsx.edge_clusters_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(edge_cluster_id, barrier_id=None, request_id=None)¶get(edge_cluster_id, barrier_id=None, request_id=None)¶
Return realized state information of a edge cluster. Any configuration update that affects the edge cluster can use this API to get its realized state by passing a request_id returned by the configuration @@ -4805,30 +4805,30 @@ Not Found
com.vmware.nsx.edge_clusters_client.Status(config)¶com.vmware.nsx.edge_clusters_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Status.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Status.get().
com.vmware.nsx.eula_client.Accept(config)¶com.vmware.nsx.eula_client.Accept(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create()¶Accept end user license agreement
@@ -4924,16 +4924,16 @@ Not Foundcom.vmware.nsx.eula_client.Acceptance(config)¶com.vmware.nsx.eula_client.Acceptance(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Return the acceptance status of end user license agreement
@@ -4969,18 +4969,18 @@ Not Foundcom.vmware.nsx.eula_client.Content(config)¶com.vmware.nsx.eula_client.Content(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, value_format=None)¶get(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, value_format=None)¶
Return the content of end user license agreement in the specified format. By default, it’s pure string without line break
com.vmware.nsx.fabric_client.ComputeCollectionFabricTemplates(config)¶com.vmware.nsx.fabric_client.ComputeCollectionFabricTemplates(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(compute_collection_fabric_template)¶create(compute_collection_fabric_template)¶
Fabric templates are fabric configurations applied at the compute collection level. This configurations is used to decide what automated operations should be a run when a host membership changes.
@@ -5091,9 +5091,9 @@ Not Founddelete(fabric_template_id)¶delete(fabric_template_id)¶
Deletes compute collection fabric template for the given id
get(fabric_template_id)¶get(fabric_template_id)¶
Get compute collection fabric template for the given id
list(compute_collection_id=None)¶list(compute_collection_id=None)¶
Returns compute collection fabric templates
update(fabric_template_id, compute_collection_fabric_template)¶update(fabric_template_id, compute_collection_fabric_template)¶
Updates compute collection fabric template for the given id
com.vmware.nsx.fabric_client.ComputeCollections(config)¶com.vmware.nsx.fabric_client.ComputeCollections(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
CREATE_ACTION_NSX = 'remove_nsx'¶Possible value for action of method ComputeCollections.create().
create(cc_ext_id, action=None)¶create(cc_ext_id, action=None)¶
Perform action specific to NSX on the compute-collection. cc-ext-id should be of type VC_Cluster.
get(cc_ext_id)¶get(cc_ext_id)¶
Returns information about a specific compute collection.
list(cm_local_id=None, cursor=None, discovered_node_id=None, display_name=None, external_id=None, included_fields=None, node_id=None, origin_id=None, origin_type=None, owner_id=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cm_local_id=None, cursor=None, discovered_node_id=None, display_name=None, external_id=None, included_fields=None, node_id=None, origin_id=None, origin_type=None, owner_id=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all compute collections.
com.vmware.nsx.fabric_client.ComputeManagers(config)¶com.vmware.nsx.fabric_client.ComputeManagers(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(compute_manager)¶create(compute_manager)¶
Registers compute manager with NSX. Inventory service will collect data from the registered compute manager
delete(compute_manager_id)¶delete(compute_manager_id)¶
Unregisters a specified compute manager
get(compute_manager_id)¶get(compute_manager_id)¶
Returns information about a specific compute manager
list(cursor=None, included_fields=None, origin_type=None, page_size=None, server=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, origin_type=None, page_size=None, server=None, sort_ascending=None, sort_by=None)¶
Returns information about all compute managers.
update(compute_manager_id, compute_manager)¶update(compute_manager_id, compute_manager)¶
Updates a specified compute manager
com.vmware.nsx.fabric_client.ContainerApplicationInstances(config)¶com.vmware.nsx.fabric_client.ContainerApplicationInstances(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(container_application_instance_id)¶get(container_application_instance_id)¶
Returns information about a specific container application instance.
list(container_application_id=None, container_cluster_id=None, container_project_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(container_application_id=None, container_cluster_id=None, container_project_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all container application instance.
com.vmware.nsx.fabric_client.ContainerApplications(config)¶com.vmware.nsx.fabric_client.ContainerApplications(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(container_application_id)¶get(container_application_id)¶
Returns information about a specific Container Application within a project.
list(container_cluster_id=None, container_project_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(container_cluster_id=None, container_project_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all Container Applications.
com.vmware.nsx.fabric_client.ContainerClusterNodes(config)¶com.vmware.nsx.fabric_client.ContainerClusterNodes(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(container_cluster_node_id)¶get(container_cluster_node_id)¶
Returns information about a specific container cluster node.
list(container_cluster_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(container_cluster_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all container cluster nodes.
com.vmware.nsx.fabric_client.ContainerClusters(config)¶com.vmware.nsx.fabric_client.ContainerClusters(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_CLUSTER_TYPE_KUBERNETES = 'Kubernetes'¶Possible value for clusterType of method ContainerClusters.list().
LIST_CLUSTER_TYPE_OPENSHIFT = 'Openshift'¶Possible value for clusterType of method ContainerClusters.list().
LIST_CLUSTER_TYPE_OTHER = 'Other'¶Possible value for clusterType of method ContainerClusters.list().
LIST_CLUSTER_TYPE_PAS = 'PAS'¶Possible value for clusterType of method ContainerClusters.list().
LIST_CLUSTER_TYPE_PKS = 'PKS'¶Possible value for clusterType of method ContainerClusters.list().
LIST_CLUSTER_TYPE_WCP = 'WCP'¶Possible value for clusterType of method ContainerClusters.list().
LIST_INFRA_TYPE_AWS = 'AWS'¶Possible value for infraType of method ContainerClusters.list().
LIST_INFRA_TYPE_AZURE = 'Azure'¶Possible value for infraType of method ContainerClusters.list().
LIST_INFRA_TYPE_BAREMETAL = 'Baremetal'¶Possible value for infraType of method ContainerClusters.list().
LIST_INFRA_TYPE_KVM = 'KVM'¶Possible value for infraType of method ContainerClusters.list().
LIST_INFRA_TYPE_VMC = 'VMC'¶Possible value for infraType of method ContainerClusters.list().
LIST_INFRA_TYPE_VSPHERE = 'vSphere'¶Possible value for infraType of method ContainerClusters.list().
get(container_cluster_id)¶get(container_cluster_id)¶
Returns information about a specific container cluster
list(cluster_type=None, cursor=None, included_fields=None, infra_type=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cluster_type=None, cursor=None, included_fields=None, infra_type=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all Container Clusters.
com.vmware.nsx.fabric_client.ContainerIngressPolicies(config)¶com.vmware.nsx.fabric_client.ContainerIngressPolicies(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(ingress_policy_id)¶get(ingress_policy_id)¶
Returns information about a specific ingress policy.
list(container_cluster_id=None, container_project_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(container_cluster_id=None, container_project_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all ingress policies.
com.vmware.nsx.fabric_client.ContainerNetworkPolicies(config)¶com.vmware.nsx.fabric_client.ContainerNetworkPolicies(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(network_policy_id)¶get(network_policy_id)¶
Returns information about a specific network policy.
list(container_cluster_id=None, container_project_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(container_cluster_id=None, container_project_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all network policies.
com.vmware.nsx.fabric_client.ContainerProjects(config)¶com.vmware.nsx.fabric_client.ContainerProjects(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(container_project_id)¶get(container_project_id)¶
Returns information about a specific project
list(container_cluster_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(container_cluster_id=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all container projects
com.vmware.nsx.fabric_client.DiscoveredNodes(config)¶com.vmware.nsx.fabric_client.DiscoveredNodes(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_HAS_PARENT_FALSE = 'false'¶Possible value for hasParent of method DiscoveredNodes.list().
LIST_HAS_PARENT_TRUE = 'true'¶Possible value for hasParent of method DiscoveredNodes.list().
createtransportnode(node_ext_id, transport_node)¶createtransportnode(node_ext_id, transport_node)¶
NSX components are installaed on host and transport node is created with given configurations.
get(node_ext_id)¶get(node_ext_id)¶
Returns information about a specific discovered node.
hostprep(node_ext_id)¶hostprep(node_ext_id)¶
node_ext_id (str) – (required)
list(cm_local_id=None, cursor=None, display_name=None, external_id=None, has_parent=None, included_fields=None, ip_address=None, node_id=None, node_type=None, origin_id=None, page_size=None, parent_compute_collection=None, sort_ascending=None, sort_by=None)¶list(cm_local_id=None, cursor=None, display_name=None, external_id=None, has_parent=None, included_fields=None, ip_address=None, node_id=None, node_type=None, origin_id=None, page_size=None, parent_compute_collection=None, sort_ascending=None, sort_by=None)¶
Returns information about all discovered nodes.
reapplyclusterconfig(node_ext_id)¶reapplyclusterconfig(node_ext_id)¶
node_ext_id (str) – (required)
com.vmware.nsx.fabric_client.Nodes(config)¶com.vmware.nsx.fabric_client.Nodes(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_HYPERVISOR_OS_TYPE_CENTOSCONTAINER = 'CENTOSCONTAINER'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_HYPERVISOR_OS_TYPE_CENTOSKVM = 'CENTOSKVM'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_HYPERVISOR_OS_TYPE_CENTOSSERVER = 'CENTOSSERVER'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_HYPERVISOR_OS_TYPE_ESXI = 'ESXI'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_HYPERVISOR_OS_TYPE_HYPERV = 'HYPERV'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_HYPERVISOR_OS_TYPE_RHELCONTAINER = 'RHELCONTAINER'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_HYPERVISOR_OS_TYPE_RHELKVM = 'RHELKVM'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_HYPERVISOR_OS_TYPE_RHELSERVER = 'RHELSERVER'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_HYPERVISOR_OS_TYPE_SLESKVM = 'SLESKVM'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_HYPERVISOR_OS_TYPE_SLESSERVER = 'SLESSERVER'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_HYPERVISOR_OS_TYPE_UBUNTUKVM = 'UBUNTUKVM'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_HYPERVISOR_OS_TYPE_UBUNTUSERVER = 'UBUNTUSERVER'¶Possible value for hypervisorOsType of method Nodes.list().
LIST_RESOURCE_TYPE_EDGENODE = 'EdgeNode'¶Possible value for resourceType of method Nodes.list().
LIST_RESOURCE_TYPE_HOSTNODE = 'HostNode'¶Possible value for resourceType of method Nodes.list().
LIST_RESOURCE_TYPE_PUBLICCLOUDGATEWAYNODE = 'PublicCloudGatewayNode'¶Possible value for resourceType of method Nodes.list().
PERFORMACTION_ACTION_ENTER_MAINTENANCE_MODE = 'enter_maintenance_mode'¶Possible value for action of method Nodes.performaction().
PERFORMACTION_ACTION_EXIT_MAINTENANCE_MODE = 'exit_maintenance_mode'¶Possible value for action of method Nodes.performaction().
PERFORMACTION_ACTION_GET_MAINTENANCE_MODE_STATE = 'get_maintenance_mode_state'¶Possible value for action of method Nodes.performaction().
PERFORMACTION_VSAN_MODE_ENSURE_OBJECT_ACCESSIBILITY = 'ensure_object_accessibility'¶Possible value for vsanMode of method Nodes.performaction().
PERFORMACTION_VSAN_MODE_EVACUATE_ALL_DATA = 'evacuate_all_data'¶Possible value for vsanMode of method Nodes.performaction().
PERFORMACTION_VSAN_MODE_NO_ACTION = 'no_action'¶Possible value for vsanMode of method Nodes.performaction().
create_0(target_node_id, target_uri)¶create_0(target_node_id, target_uri)¶
Invoke POST request on target fabric node. This api is deprecated as part of FN+TN unification. Please use Transport Node API POST /transport-nodes/<transport-node-id>/<target-node-id>/<target-uri>
@@ -6806,9 +6806,9 @@ Not Founddelete(node_id, unprepare_host=None)¶delete(node_id, unprepare_host=None)¶
delete_0(target_node_id, target_uri)¶delete_0(target_node_id, target_uri)¶
Invoke DELETE request on target fabric node. This api is deprecated as part of FN+TN unification. Please use Transport Node API DELETE /transport-nodes/<transport-node-id>/<target-node-id>/<target-uri>
@@ -6880,9 +6880,9 @@ Not Foundlist(cursor=None, discovered_node_id=None, display_name=None, external_id=None, hardware_id=None, hypervisor_os_type=None, included_fields=None, ip_address=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)¶list(cursor=None, discovered_node_id=None, display_name=None, external_id=None, hardware_id=None, hypervisor_os_type=None, included_fields=None, ip_address=None, page_size=None, resource_type=None, sort_ascending=None, sort_by=None)¶
Returns information about all fabric nodes (hosts and edges). This api is deprecated as part of FN+TN unification. Please use Transport Node API GET /transport-nodes to list all fabric nodes.
@@ -7019,9 +7019,9 @@ Not Foundperformaction(node_id, action=None, evacuate_powered_off_vms=None, vsan_mode=None)¶performaction(node_id, action=None, evacuate_powered_off_vms=None, vsan_mode=None)¶
The supported fabric node actions are enter_maintenance_mode, exit_maintenance_mode for EdgeNode. This API is deprecated, please call TransportNode maintenance mode API to update maintenance mode, refer to @@ -7067,9 +7067,9 @@ Not Found
restartinventorysync(node_id)¶restartinventorysync(node_id)¶
Restart the inventory sync for the node if it is currently internally paused. After this action the next inventory sync coming from the node is processed. This api is deprecated as part of FN+TN unification. @@ -7103,9 +7103,9 @@ Not Found
update_0(target_node_id, target_uri)¶update_0(target_node_id, target_uri)¶
Invoke PUT request on target fabric node. This api is deprecated as part of FN+TN unification. Please use Transport Node API PUT /transport-nodes/<transport-node-id>/<target-node-id>/<target-uri>
@@ -7186,9 +7186,9 @@ Not Foundupgradeinfra(node_id, disable_vm_migration=None)¶upgradeinfra(node_id, disable_vm_migration=None)¶
Perform a service deployment upgrade on a host node
com.vmware.nsx.fabric_client.Ostypes(config)¶com.vmware.nsx.fabric_client.Ostypes(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Returns names of all supported host OS.
@@ -7276,9 +7276,9 @@ Not Foundcom.vmware.nsx.fabric_client.StubFactory(stub_config)¶com.vmware.nsx.fabric_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.fabric_client.Vifs(config)¶com.vmware.nsx.fabric_client.Vifs(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(cursor=None, host_id=None, included_fields=None, lport_attachment_id=None, owner_vm_id=None, page_size=None, sort_ascending=None, sort_by=None, vm_id=None)¶list(cursor=None, host_id=None, included_fields=None, lport_attachment_id=None, owner_vm_id=None, page_size=None, sort_ascending=None, sort_by=None, vm_id=None)¶
Returns information about all VIFs. A virtual network interface aggregates network interfaces into a logical interface unit that is indistinuishable from a physical network interface.
@@ -7351,18 +7351,18 @@ Not Foundcom.vmware.nsx.fabric_client.VirtualMachines(config)¶com.vmware.nsx.fabric_client.VirtualMachines(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(cursor=None, display_name=None, external_id=None, host_id=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, display_name=None, external_id=None, host_id=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns information about all virtual machines.
updatetags(virtual_machine_tag_update)¶
Update tags applied to the virtual machine. External id of the virtual machine will be specified in the request body. Request body should contain all the tags to be applied. To clear all tags, provide an empty @@ -7449,54 +7449,54 @@ Not Found
com.vmware.nsx.firewall_client.Excludelist(config)¶com.vmware.nsx.firewall_client.Excludelist(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
CHECKIFEXISTS_OBJECT_TYPE_LOGICALPORT = 'LogicalPort'¶Possible value for objectType of method Excludelist.checkifexists().
CHECKIFEXISTS_OBJECT_TYPE_LOGICALSWITCH = 'LogicalSwitch'¶Possible value for objectType of method Excludelist.checkifexists().
CHECKIFEXISTS_OBJECT_TYPE_NSGROUP = 'NSGroup'¶Possible value for objectType of method Excludelist.checkifexists().
REMOVEMEMBER_OBJECT_TYPE_LOGICALPORT = 'LogicalPort'¶Possible value for objectType of method Excludelist.removemember().
REMOVEMEMBER_OBJECT_TYPE_LOGICALSWITCH = 'LogicalSwitch'¶Possible value for objectType of method Excludelist.removemember().
REMOVEMEMBER_OBJECT_TYPE_NSGROUP = 'NSGroup'¶Possible value for objectType of method Excludelist.removemember().
removemember(object_id, deep_check=None, object_type=None)¶removemember(object_id, deep_check=None, object_type=None)¶
Remove an existing object from the exclude list
update(exclude_list)¶update(exclude_list)¶
Modify exclude list
com.vmware.nsx.firewall_client.Profiles(config)¶com.vmware.nsx.firewall_client.Profiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(base_firewall_profile)¶create(base_firewall_profile)¶
Create a firewall profile with values provided. It creates profile based resource_type in the payload.
delete(profile_id)¶delete(profile_id)¶
Deletes a firewall profile.
get(profile_id)¶get(profile_id)¶
Return firewall session timer profile.
list(resource_type, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(resource_type, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
List all the firewall profiles available by requested resource_type.
update(profile_id, base_firewall_profile)¶update(profile_id, base_firewall_profile)¶
Update user configurable properties of firewall profile.
com.vmware.nsx.firewall_client.Rules(config)¶com.vmware.nsx.firewall_client.Rules(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(rule_id)¶get(rule_id)¶
Return existing firewall rule information.
com.vmware.nsx.firewall_client.Sections(config)¶com.vmware.nsx.firewall_client.Sections(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
CREATEWITHRULES_OPERATION_AFTER = 'insert_after'¶Possible value for operation of method Sections.createwithrules().
CREATEWITHRULES_OPERATION_BEFORE = 'insert_before'¶Possible value for operation of method Sections.createwithrules().
CREATEWITHRULES_OPERATION_BOTTOM = 'insert_bottom'¶Possible value for operation of method Sections.createwithrules().
CREATEWITHRULES_OPERATION_TOP = 'insert_top'¶Possible value for operation of method Sections.createwithrules().
CREATE_OPERATION_AFTER = 'insert_after'¶Possible value for operation of method Sections.create().
CREATE_OPERATION_BEFORE = 'insert_before'¶Possible value for operation of method Sections.create().
CREATE_OPERATION_BOTTOM = 'insert_bottom'¶Possible value for operation of method Sections.create().
CREATE_OPERATION_TOP = 'insert_top'¶Possible value for operation of method Sections.create().
LIST_ENFORCED_ON_BRIDGEENDPOINT = 'BRIDGEENDPOINT'¶Possible value for enforcedOn of method Sections.list().
LIST_ENFORCED_ON_DHCP_SERVICE = 'DHCP_SERVICE'¶Possible value for enforcedOn of method Sections.list().
LIST_ENFORCED_ON_L2VPN_SESSION = 'L2VPN_SESSION'¶Possible value for enforcedOn of method Sections.list().
LIST_ENFORCED_ON_LOGICALROUTER = 'LOGICALROUTER'¶Possible value for enforcedOn of method Sections.list().
LIST_ENFORCED_ON_METADATA_PROXY = 'METADATA_PROXY'¶Possible value for enforcedOn of method Sections.list().
LIST_ENFORCED_ON_NONE = 'NONE'¶Possible value for enforcedOn of method Sections.list().
LIST_ENFORCED_ON_VIF = 'VIF'¶Possible value for enforcedOn of method Sections.list().
LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALPORT = 'LogicalPort'¶Possible value for excludeAppliedToType of method Sections.list().
LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALROUTER = 'LogicalRouter'¶Possible value for excludeAppliedToType of method Sections.list().
LIST_EXCLUDE_APPLIED_TO_TYPE_LOGICALSWITCH = 'LogicalSwitch'¶Possible value for excludeAppliedToType of method Sections.list().
LIST_EXCLUDE_APPLIED_TO_TYPE_NSGROUP = 'NSGroup'¶Possible value for excludeAppliedToType of method Sections.list().
LIST_FILTER_TYPE_FILTER = 'FILTER'¶Possible value for filterType of method Sections.list().
LIST_FILTER_TYPE_SEARCH = 'SEARCH'¶Possible value for filterType of method Sections.list().
LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALPORT = 'LogicalPort'¶Possible value for includeAppliedToType of method Sections.list().
LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALROUTER = 'LogicalRouter'¶Possible value for includeAppliedToType of method Sections.list().
LIST_INCLUDE_APPLIED_TO_TYPE_LOGICALSWITCH = 'LogicalSwitch'¶Possible value for includeAppliedToType of method Sections.list().
LIST_INCLUDE_APPLIED_TO_TYPE_NSGROUP = 'NSGroup'¶Possible value for includeAppliedToType of method Sections.list().
LIST_TYPE_LAYER2 = 'LAYER2'¶Possible value for type of method Sections.list().
LIST_TYPE_LAYER3 = 'LAYER3'¶Possible value for type of method Sections.list().
REVISEWITHRULES_OPERATION_AFTER = 'insert_after'¶Possible value for operation of method Sections.revisewithrules().
REVISEWITHRULES_OPERATION_BEFORE = 'insert_before'¶Possible value for operation of method Sections.revisewithrules().
REVISEWITHRULES_OPERATION_BOTTOM = 'insert_bottom'¶Possible value for operation of method Sections.revisewithrules().
REVISEWITHRULES_OPERATION_TOP = 'insert_top'¶Possible value for operation of method Sections.revisewithrules().
REVISE_OPERATION_AFTER = 'insert_after'¶Possible value for operation of method Sections.revise().
REVISE_OPERATION_BEFORE = 'insert_before'¶Possible value for operation of method Sections.revise().
REVISE_OPERATION_BOTTOM = 'insert_bottom'¶Possible value for operation of method Sections.revise().
REVISE_OPERATION_TOP = 'insert_top'¶Possible value for operation of method Sections.revise().
create(firewall_section, id=None, operation=None)¶create(firewall_section, id=None, operation=None)¶
Creates new empty firewall section in the system.
createwithrules(firewall_section_rule_list, id=None, operation=None)¶createwithrules(firewall_section_rule_list, id=None, operation=None)¶
Creates a new firewall section with rules. The limit on the number of rules is defined by maxItems in collection types for FirewallRule (FirewallRuleXXXList types). When invoked on a section with a large @@ -8262,9 +8262,9 @@ Not Found
delete(section_id, cascade=None)¶delete(section_id, cascade=None)¶
Removes firewall section from the system. Firewall section with rules can only be deleted by passing “cascade=true” parameter.
get(section_id)¶get(section_id)¶
Returns information about firewall section for the identifier.
list(applied_tos=None, context_profiles=None, cursor=None, deep_search=None, destinations=None, enforced_on=None, exclude_applied_to_type=None, extended_sources=None, filter_type=None, include_applied_to_type=None, included_fields=None, locked=None, page_size=None, search_invalid_references=None, search_scope=None, services=None, sort_ascending=None, sort_by=None, sources=None, type=None)¶list(applied_tos=None, context_profiles=None, cursor=None, deep_search=None, destinations=None, enforced_on=None, exclude_applied_to_type=None, extended_sources=None, filter_type=None, include_applied_to_type=None, included_fields=None, locked=None, page_size=None, search_invalid_references=None, search_scope=None, services=None, sort_ascending=None, sort_by=None, sources=None, type=None)¶
List all firewall section in paginated form. A default page size is limited to 1000 firewall sections. By default list of section is filtered by LAYER3 type.
@@ -8407,9 +8407,9 @@ Not Foundlock(section_id, firewall_section_lock)¶lock(section_id, firewall_section_lock)¶
Lock a section
revise(section_id, firewall_section, id=None, operation=None)¶revise(section_id, firewall_section, id=None, operation=None)¶
Modifies an existing firewall section along with its relative position among other firewall sections in the system. Simultaneous update (modify) operations on same section are not allowed to prevent @@ -8546,9 +8546,9 @@ Not Found
revisewithrules(section_id, firewall_section_rule_list, id=None, operation=None)¶revisewithrules(section_id, firewall_section_rule_list, id=None, operation=None)¶
Modifies an existing firewall section along with its relative position among other firewall sections with rules. When invoked on a large number of rules, this API is supported only at low rates of invocation @@ -8603,9 +8603,9 @@ Not Found
unlock(section_id, firewall_section_lock)¶unlock(section_id, firewall_section_lock)¶
Unlock a section
update(section_id, firewall_section)¶update(section_id, firewall_section)¶
Modifies the specified section, but does not modify the section’s associated rules. Simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to @@ -8693,9 +8693,9 @@ Not Found
updatewithrules(section_id, firewall_section_rule_list)¶updatewithrules(section_id, firewall_section_rule_list)¶
Modifies existing firewall section along with its association with rules. When invoked on a large number of rules, this API is supported only at low rates of invocation (not more than 2 times per minute). The @@ -8746,36 +8746,36 @@ Not Found
com.vmware.nsx.firewall_client.Stats(config)¶com.vmware.nsx.firewall_client.Stats(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
RESET_CATEGORY_L3BRIDGEPORT = 'L3BRIDGEPORT'¶Possible value for category of method Stats.reset().
RESET_CATEGORY_L3DFW = 'L3DFW'¶Possible value for category of method Stats.reset().
RESET_CATEGORY_L3EDGE = 'L3EDGE'¶Possible value for category of method Stats.reset().
reset(category)¶reset(category)¶
Sets firewall rule statistics counter to zero. This operation is supported for given category, for example: L3DFW i.e. for all layer3 firewall (transport nodes only) rules or L3EDGE i.e. for all layer3 @@ -8810,18 +8810,18 @@ Not Found
com.vmware.nsx.firewall_client.Status(config)¶com.vmware.nsx.firewall_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
disablefirewall(context_type, id)¶disablefirewall(context_type, id)¶
Disable firewall on target resource in dfw context
com.vmware.nsx.hpm_client.Alarms(config)¶com.vmware.nsx.hpm_client.Alarms(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(cursor=None, fields=None, page_size=None)¶list(cursor=None, fields=None, page_size=None)¶
This API is executed on a manager node to return current alarms from all NSX nodes.
com.vmware.nsx.hpm_client.Features(config)¶com.vmware.nsx.hpm_client.Features(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
resetcollectionfrequency(feature_stack_name)¶resetcollectionfrequency(feature_stack_name)¶
Reset the data collection frequency configuration setting to the default values
update(feature_stack_name, feature_stack_collection_configuration)¶update(feature_stack_name, feature_stack_collection_configuration)¶
Apply the data collection configuration for the specified feature stack.
com.vmware.nsx.hpm_client.GlobalConfig(config)¶com.vmware.nsx.hpm_client.GlobalConfig(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Read global health performance monitoring configuration
@@ -9327,9 +9327,9 @@ Not Foundcom.vmware.nsx.idfw_client.IdfwComputeCollections(config)¶com.vmware.nsx.idfw_client.IdfwComputeCollections(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(cc_ext_id)¶get(cc_ext_id)¶
Get enable/disable status of individual compute collections for IDFW.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
List all Identity firewall compute collections.
update(cc_ext_id, idfw_enabled_compute_collection)¶update(cc_ext_id, idfw_enabled_compute_collection)¶
Enable/disable individual compute collections for IDFW.
com.vmware.nsx.idfw_client.MasterSwitchSetting(config)¶com.vmware.nsx.idfw_client.MasterSwitchSetting(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Fetches IDFW master switch setting to check whether master switch is @@ -9560,9 +9560,9 @@ Not Found
update(idfw_master_switch_setting)¶update(idfw_master_switch_setting)¶
Update Identity Firewall master switch setting (true=enabled / false=disabled). Identity Firewall master switch setting enables or disables Identity Firewall feature across the system. It affects @@ -9603,18 +9603,18 @@ Not Found
com.vmware.nsx.idfw_client.NsgroupVmDetails(config)¶com.vmware.nsx.idfw_client.NsgroupVmDetails(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(group_id)¶list(group_id)¶
Get all Identity Firewall NSGroup VM details for a given NSGroup.
com.vmware.nsx.idfw_client.StandaloneHostSwitchSetting(config)¶com.vmware.nsx.idfw_client.StandaloneHostSwitchSetting(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Fetches IDFW standalone hosts switch setting to check whether @@ -9695,9 +9695,9 @@ Not Found
update(idfw_standalone_hosts_switch_setting)¶update(idfw_standalone_hosts_switch_setting)¶
Update Identity Firewall standalone hosts switch setting (true=enabled / false=disabled).
com.vmware.nsx.idfw_client.StubFactory(stub_config)¶com.vmware.nsx.idfw_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.idfw_client.SystemStats(config)¶com.vmware.nsx.idfw_client.SystemStats(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Get IDFW system statistics data.
@@ -9792,16 +9792,16 @@ Not Foundcom.vmware.nsx.idfw_client.UserSessionData(config)¶com.vmware.nsx.idfw_client.UserSessionData(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Get user session data.
@@ -9837,18 +9837,18 @@ Not Foundcom.vmware.nsx.idfw_client.UserStats(config)¶com.vmware.nsx.idfw_client.UserStats(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(user_id)¶get(user_id)¶
Get IDFW user login events for a given user (all active plus up to 5 most recent archived entries).
com.vmware.nsx.intelligence_client.HostConfig(config)¶com.vmware.nsx.intelligence_client.HostConfig(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Get the current NSX-Intelligence host configuration.
@@ -9981,9 +9981,9 @@ Not Foundpatch(intelligence_host_configuration_info)¶patch(intelligence_host_configuration_info)¶
Patch the current NSX-Intelligence host configuration. Return error if NSX-Intelligence is not registered with NSX.
reset()¶Reset NSX-Intelligence host configuration to the default setting. Clear @@ -10058,9 +10058,9 @@ Not Found
com.vmware.nsx.ip_sets_client.Members(config)¶com.vmware.nsx.ip_sets_client.Members(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
com.vmware.nsx.ipfix_client.Collectorconfigs(config)¶com.vmware.nsx.ipfix_client.Collectorconfigs(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(ipfix_collector_config)¶create(ipfix_collector_config)¶
Create a new IPFIX collector configuration
delete(collector_config_id)¶delete(collector_config_id)¶
Delete an existing IPFIX collector configuration
get(collector_config_id)¶get(collector_config_id)¶
Get an existing IPFIX collector configuration
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
List IPFIX collector configurations
update(collector_config_id, ipfix_collector_config)¶update(collector_config_id, ipfix_collector_config)¶
Update an existing IPFIX collector configuration
com.vmware.nsx.ipfix_client.Configs(config)¶com.vmware.nsx.ipfix_client.Configs(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_IPFIX_CONFIG_TYPE_IPFIXDFWCONFIG = 'IpfixDfwConfig'¶Possible value for ipfixConfigType of method Configs.list().
LIST_IPFIX_CONFIG_TYPE_IPFIXSWITCHCONFIG = 'IpfixSwitchConfig'¶Possible value for ipfixConfigType of method Configs.list().
create(ipfix_config)¶create(ipfix_config)¶
Create a new IPFIX configuration
delete(config_id)¶delete(config_id)¶
Delete an existing IPFIX configuration
get(config_id)¶get(config_id)¶
Get an existing IPFIX configuration
list(applied_to=None, cursor=None, included_fields=None, ipfix_config_type=None, page_size=None, sort_ascending=None, sort_by=None)¶list(applied_to=None, cursor=None, included_fields=None, ipfix_config_type=None, page_size=None, sort_ascending=None, sort_by=None)¶
List IPFIX configuration
com.vmware.nsx.ipfix_obs_points_client.StubFactory(stub_config)¶com.vmware.nsx.ipfix_obs_points_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.ipfix_obs_points_client.SwitchGlobal(config)¶com.vmware.nsx.ipfix_obs_points_client.SwitchGlobal(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶update(ipfix_obs_point_config)¶update(ipfix_obs_point_config)¶
ipfix_obs_point_config (com.vmware.nsx.model_client.IpfixObsPointConfig) – (required)
com.vmware.nsx.ipv6_client.DadProfiles(config)¶com.vmware.nsx.ipv6_client.DadProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(d_ad_profile)¶create(d_ad_profile)¶
Adds a new DADProfile
delete(dad_profile_id)¶delete(dad_profile_id)¶
Delete DADProfile
get(dad_profile_id)¶get(dad_profile_id)¶
Returns information about specified IPv6 DADProfile.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns all IPv6 DADProfiles.
update(dad_profile_id, d_ad_profile)¶update(dad_profile_id, d_ad_profile)¶
Update DADProfile.
com.vmware.nsx.ipv6_client.NdRaProfiles(config)¶com.vmware.nsx.ipv6_client.NdRaProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(n_dra_profile)¶create(n_dra_profile)¶
Adds a new NDRAProfile
delete(nd_ra_profile_id)¶delete(nd_ra_profile_id)¶
Delete NDRAProfile
get(nd_ra_profile_id)¶get(nd_ra_profile_id)¶
Returns information about specified IPv6 NDRA Profile.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Returns all IPv6 NDRA Profiles.
com.vmware.nsx.licenses_client.LicensesUsage(config)¶com.vmware.nsx.licenses_client.LicensesUsage(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Returns usage report of all registered modules
@@ -11138,9 +11138,9 @@ Not Foundcom.vmware.nsx.loadbalancer_client.ApplicationProfiles(config)¶com.vmware.nsx.loadbalancer_client.ApplicationProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_TYPE_LBFASTTCPPROFILE = 'LbFastTcpProfile'¶Possible value for type of method ApplicationProfiles.list().
LIST_TYPE_LBFASTUDPPROFILE = 'LbFastUdpProfile'¶Possible value for type of method ApplicationProfiles.list().
LIST_TYPE_LBHTTPPROFILE = 'LbHttpProfile'¶Possible value for type of method ApplicationProfiles.list().
create(lb_app_profile)¶create(lb_app_profile)¶
Create a load balancer application profile.
delete(application_profile_id)¶delete(application_profile_id)¶
Delete a load balancer application profile.
get(application_profile_id)¶get(application_profile_id)¶
Retrieve a load balancer application profile.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶
Retrieve a paginated list of load balancer application profiles.
update(application_profile_id, lb_app_profile)¶update(application_profile_id, lb_app_profile)¶
Update a load balancer application profile.
com.vmware.nsx.loadbalancer_client.ClientSslProfiles(config)¶com.vmware.nsx.loadbalancer_client.ClientSslProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(lb_client_ssl_profile)¶create(lb_client_ssl_profile)¶
Create a load balancer client-ssl profile.
delete(client_ssl_profile_id)¶delete(client_ssl_profile_id)¶
Delete a load balancer client-ssl profile.
get(client_ssl_profile_id)¶get(client_ssl_profile_id)¶
Retrieve a load balancer client-ssl profile.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Retrieve a paginated list of load balancer client-ssl profiles.
update(client_ssl_profile_id, lb_client_ssl_profile)¶update(client_ssl_profile_id, lb_client_ssl_profile)¶
Update a load balancer client-ssl profile.
com.vmware.nsx.loadbalancer_client.Monitors(config)¶com.vmware.nsx.loadbalancer_client.Monitors(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_TYPE_LBACTIVEMONITOR = 'LbActiveMonitor'¶Possible value for type of method Monitors.list().
LIST_TYPE_LBHTTPMONITOR = 'LbHttpMonitor'¶Possible value for type of method Monitors.list().
LIST_TYPE_LBHTTPSMONITOR = 'LbHttpsMonitor'¶Possible value for type of method Monitors.list().
LIST_TYPE_LBICMPMONITOR = 'LbIcmpMonitor'¶Possible value for type of method Monitors.list().
LIST_TYPE_LBPASSIVEMONITOR = 'LbPassiveMonitor'¶Possible value for type of method Monitors.list().
LIST_TYPE_LBTCPMONITOR = 'LbTcpMonitor'¶Possible value for type of method Monitors.list().
LIST_TYPE_LBUDPMONITOR = 'LbUdpMonitor'¶Possible value for type of method Monitors.list().
create(lb_monitor)¶create(lb_monitor)¶
Create a load balancer monitor.
delete(monitor_id)¶delete(monitor_id)¶
Delete a load balancer monitor.
get(monitor_id)¶get(monitor_id)¶
Retrieve a load balancer monitor.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶
Retrieve a paginated list of load balancer monitors.
update(monitor_id, lb_monitor)¶update(monitor_id, lb_monitor)¶
Update a load balancer monitor.
com.vmware.nsx.loadbalancer_client.NodeUsageSummary(config)¶com.vmware.nsx.loadbalancer_client.NodeUsageSummary(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(include_usages=None)¶get(include_usages=None)¶
API is used to retrieve the load balancer node usage summary for all nodes.
com.vmware.nsx.loadbalancer_client.PersistenceProfiles(config)¶com.vmware.nsx.loadbalancer_client.PersistenceProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_TYPE_LBCOOKIEPERSISTENCEPROFILE = 'LbCookiePersistenceProfile'¶Possible value for type of method PersistenceProfiles.list().
LIST_TYPE_LBGENERICPERSISTENCEPROFILE = 'LbGenericPersistenceProfile'¶Possible value for type of method PersistenceProfiles.list().
LIST_TYPE_LBSOURCEIPPERSISTENCEPROFILE = 'LbSourceIpPersistenceProfile'¶Possible value for type of method PersistenceProfiles.list().
create(lb_persistence_profile)¶create(lb_persistence_profile)¶
Create a load balancer persistence profile.
delete(persistence_profile_id)¶delete(persistence_profile_id)¶
Delete a load balancer persistence profile.
get(persistence_profile_id)¶get(persistence_profile_id)¶
Retrieve a load balancer persistence profile.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶
Retrieve a paginated list of load balancer persistence profiles.
update(persistence_profile_id, lb_persistence_profile)¶update(persistence_profile_id, lb_persistence_profile)¶
Update a load balancer persistence profile.
com.vmware.nsx.loadbalancer_client.Pools(config)¶com.vmware.nsx.loadbalancer_client.Pools(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
CREATE_0_ACTION_ADD_MEMBERS = 'ADD_MEMBERS'¶Possible value for action of method Pools.create_0().
CREATE_0_ACTION_REMOVE_MEMBERS = 'REMOVE_MEMBERS'¶Possible value for action of method Pools.create_0().
CREATE_0_ACTION_UPDATE_MEMBERS = 'UPDATE_MEMBERS'¶Possible value for action of method Pools.create_0().
create(lb_pool)¶create(lb_pool)¶
Create a load balancer pool.
create_0(pool_id, pool_member_setting_list, action)¶create_0(pool_id, pool_member_setting_list, action)¶
For ADD_MEMBERS, pool members will be created and added to load balancer pool. This action is only valid for static pool members. For REMOVE_MEMBERS, pool members will be removed from load balancer pool @@ -12233,9 +12233,9 @@ Not Found
delete(pool_id)¶delete(pool_id)¶
Delete a load balancer pool.
get(pool_id)¶get(pool_id)¶
Retrieve a load balancer pool.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Retrieve a paginated list of load balancer pools.
update(pool_id, lb_pool)¶update(pool_id, lb_pool)¶
Update a load balancer pool.
com.vmware.nsx.loadbalancer_client.Rules(config)¶com.vmware.nsx.loadbalancer_client.Rules(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(lb_rule)¶create(lb_rule)¶
Create a load balancer rule.
delete(rule_id)¶delete(rule_id)¶
Delete a load balancer rule.
get(rule_id)¶get(rule_id)¶
Retrieve a load balancer rule.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Retrieve a paginated list of load balancer rules.
update(rule_id, lb_rule)¶update(rule_id, lb_rule)¶
Update a load balancer rule.
com.vmware.nsx.loadbalancer_client.ServerSslProfiles(config)¶com.vmware.nsx.loadbalancer_client.ServerSslProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(lb_server_ssl_profile)¶create(lb_server_ssl_profile)¶
Create a load balancer server-ssl profile.
delete(server_ssl_profile_id)¶delete(server_ssl_profile_id)¶
Delete a load balancer server-ssl profile.
get(server_ssl_profile_id)¶get(server_ssl_profile_id)¶
Retrieve a load balancer server-ssl profile.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Retrieve a paginated list of load balancer server-ssl profiles.
update(server_ssl_profile_id, lb_server_ssl_profile)¶update(server_ssl_profile_id, lb_server_ssl_profile)¶
Update a load balancer server-ssl profile.
com.vmware.nsx.loadbalancer_client.Services(config)¶com.vmware.nsx.loadbalancer_client.Services(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(lb_service)¶create(lb_service)¶
Create a load balancer service.
delete(service_id)¶delete(service_id)¶
Delete a load balancer service.
get(service_id)¶get(service_id)¶
Retrieve a load balancer service.
list(cursor=None, included_fields=None, logical_router_id=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, logical_router_id=None, page_size=None, sort_ascending=None, sort_by=None)¶
Retrieve a paginated list of load balancer services. When logical_router_id is specified in request parameters, the associated load balancer services which are related to the given logical router @@ -12957,9 +12957,9 @@ Not Found
update(service_id, lb_service)¶update(service_id, lb_service)¶
Update a load balancer service.
com.vmware.nsx.loadbalancer_client.StubFactory(stub_config)¶com.vmware.nsx.loadbalancer_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.loadbalancer_client.TcpProfiles(config)¶com.vmware.nsx.loadbalancer_client.TcpProfiles(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(lb_tcp_profile)¶create(lb_tcp_profile)¶
Create a load balancer TCP profile.
delete(tcp_profile_id)¶delete(tcp_profile_id)¶
Delete a load balancer TCP profile.
get(tcp_profile_id)¶get(tcp_profile_id)¶
Retrieve a load balancer TCP profile.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Retrieve a paginated list of load balancer TCP profiles.
update(tcp_profile_id, lb_tcp_profile)¶update(tcp_profile_id, lb_tcp_profile)¶
Update a load balancer TCP profile.
com.vmware.nsx.loadbalancer_client.UsagePerNode(config)¶com.vmware.nsx.loadbalancer_client.UsagePerNode(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(node_id)¶get(node_id)¶
API is used to retrieve the usage of load balancer entities which include current number and remaining number of credits, virtual Servers, pools, pool Members and different size of LB services from the @@ -13266,18 +13266,18 @@ Not Found
com.vmware.nsx.loadbalancer_client.VirtualServers(config)¶com.vmware.nsx.loadbalancer_client.VirtualServers(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(lb_virtual_server)¶create(lb_virtual_server)¶
Create a load balancer virtual server.
createwithrules(lb_virtual_server_with_rule)¶createwithrules(lb_virtual_server_with_rule)¶
It is used to create virtual servers, the associated rules and bind the rules to the virtual server. To add new rules, make sure the rules which have no identifier specified, the new rules are automatically @@ -13354,9 +13354,9 @@ Not Found
delete(virtual_server_id, delete_associated_rules=None)¶delete(virtual_server_id, delete_associated_rules=None)¶
Delete a load balancer virtual server.
get(virtual_server_id)¶get(virtual_server_id)¶
Retrieve a load balancer virtual server.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Retrieve a paginated list of load balancer virtual servers.
update(virtual_server_id, lb_virtual_server)¶update(virtual_server_id, lb_virtual_server)¶
Update a load balancer virtual server.
updatewithrules(virtual_server_id, lb_virtual_server_with_rule)¶updatewithrules(virtual_server_id, lb_virtual_server_with_rule)¶
It is used to update virtual servers, the associated rules and update the binding of virtual server and rules. To add new rules, make sure the rules which have no identifier specified, the new rules are @@ -13565,18 +13565,18 @@ Not Found
com.vmware.nsx.logical_ports_client.ForwardingPath(config)¶com.vmware.nsx.logical_ports_client.ForwardingPath(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(lport_id, peer_port_id)¶get(lport_id, peer_port_id)¶
Get networking entities between two logical ports with VIF attachment
com.vmware.nsx.logical_ports_client.MacTable(config)¶com.vmware.nsx.logical_ports_client.MacTable(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_SOURCE_CACHED = 'cached'¶Possible value for source of method MacTable.list().
LIST_SOURCE_REALTIME = 'realtime'¶Possible value for source of method MacTable.list().
list(lport_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)¶list(lport_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)¶
Returns MAC table of a specified logical port. If the target transport node id is not provided, the NSX manager will ask the controller for the transport node where the logical port is located. The query @@ -13692,18 +13692,18 @@ Not Found
com.vmware.nsx.logical_ports_client.State(config)¶com.vmware.nsx.logical_ports_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(lport_id)¶get(lport_id)¶
Returns transport node id for a specified logical port. Also returns information about all address bindings of the specified logical port. This includes address bindings discovered via various snooping methods @@ -13744,30 +13744,30 @@ Not Found
com.vmware.nsx.logical_ports_client.Statistics(config)¶com.vmware.nsx.logical_ports_client.Statistics(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Statistics.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Statistics.get().
get(lport_id, source=None)¶get(lport_id, source=None)¶
Returns statistics of a specified logical port. If the logical port is attached to a logical router port, query parameter “source=realtime” is not supported.
@@ -13809,84 +13809,84 @@ Not Foundcom.vmware.nsx.logical_ports_client.Status(config)¶com.vmware.nsx.logical_ports_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GETALL_ATTACHMENT_TYPE_BRIDGEENDPOINT = 'BRIDGEENDPOINT'¶Possible value for attachmentType of method Status.getall().
GETALL_ATTACHMENT_TYPE_DHCP_SERVICE = 'DHCP_SERVICE'¶Possible value for attachmentType of method Status.getall().
GETALL_ATTACHMENT_TYPE_L2VPN_SESSION = 'L2VPN_SESSION'¶Possible value for attachmentType of method Status.getall().
GETALL_ATTACHMENT_TYPE_LOGICALROUTER = 'LOGICALROUTER'¶Possible value for attachmentType of method Status.getall().
GETALL_ATTACHMENT_TYPE_METADATA_PROXY = 'METADATA_PROXY'¶Possible value for attachmentType of method Status.getall().
GETALL_ATTACHMENT_TYPE_NONE = 'NONE'¶Possible value for attachmentType of method Status.getall().
GETALL_ATTACHMENT_TYPE_VIF = 'VIF'¶Possible value for attachmentType of method Status.getall().
GETALL_SOURCE_CACHED = 'cached'¶Possible value for source of method Status.getall().
GETALL_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Status.getall().
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Status.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Status.get().
get(lport_id, source=None)¶get(lport_id, source=None)¶
Returns operational status of a specified logical port.
getall(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, source=None, switching_profile_id=None, transport_node_id=None, transport_zone_id=None)¶getall(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, source=None, switching_profile_id=None, transport_node_id=None, transport_zone_id=None)¶
Returns operational status of all logical ports. The query parameter “source=realtime” is not supported.
com.vmware.nsx.logical_router_ports_client.ArpTable(config)¶com.vmware.nsx.logical_router_ports_client.ArpTable(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_SOURCE_CACHED = 'cached'¶Possible value for source of method ArpTable.list().
LIST_SOURCE_REALTIME = 'realtime'¶Possible value for source of method ArpTable.list().
list(logical_router_port_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)¶list(logical_router_port_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)¶
com.vmware.nsx.logical_router_ports_client.State(config)¶com.vmware.nsx.logical_router_ports_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(logical_router_port_id, barrier_id=None, request_id=None)¶get(logical_router_port_id, barrier_id=None, request_id=None)¶
Return realized state information of a logical router port. Any configuration update that affects the logical router port can use this API to get its realized state by passing a request_id returned by the @@ -14128,30 +14128,30 @@ Not Found
com.vmware.nsx.logical_router_ports_client.Statistics(config)¶com.vmware.nsx.logical_router_ports_client.Statistics(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Statistics.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Statistics.get().
com.vmware.nsx.logical_routers_client.Routing(config)¶com.vmware.nsx.logical_routers_client.Routing(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(logical_router_id)¶get(logical_router_id)¶
Returns the routing configuration for a specified logical router.
update(logical_router_id, routing_config)¶update(logical_router_id, routing_config)¶
Modifies the routing configuration for a specified logical router.
com.vmware.nsx.logical_routers_client.State(config)¶com.vmware.nsx.logical_routers_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(logical_router_id, barrier_id=None, request_id=None)¶get(logical_router_id, barrier_id=None, request_id=None)¶
Return realized state information of a logical router. Any configuration update that affects the logical router can use this API to get its realized state by passing a request_id returned by the @@ -14350,30 +14350,30 @@ Not Found
com.vmware.nsx.logical_routers_client.Status(config)¶com.vmware.nsx.logical_routers_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Status.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Status.get().
com.vmware.nsx.logical_switches_client.MacTable(config)¶com.vmware.nsx.logical_switches_client.MacTable(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_SOURCE_CACHED = 'cached'¶Possible value for source of method MacTable.list().
LIST_SOURCE_REALTIME = 'realtime'¶Possible value for source of method MacTable.list().
list(lswitch_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)¶list(lswitch_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)¶
Returns MAC table of a specified logical switch from the given transport node if a transport node id is given in the query parameter from the Central Controller Plane. The query parameter @@ -14503,42 +14503,42 @@ Not Found
com.vmware.nsx.logical_switches_client.State(config)¶com.vmware.nsx.logical_switches_client.State(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_STATUS_IN_PROGRESS = 'IN_PROGRESS'¶Possible value for status of method State.list().
LIST_STATUS_PARTIAL_SUCCESS = 'PARTIAL_SUCCESS'¶Possible value for status of method State.list().
LIST_STATUS_PENDING = 'PENDING'¶Possible value for status of method State.list().
LIST_STATUS_SUCCESS = 'SUCCESS'¶Possible value for status of method State.list().
get(lswitch_id)¶get(lswitch_id)¶
Returns current state of the logical switch configuration and details of only out-of-sync transport nodes.
list(status=None)¶list(status=None)¶
Returns a list of logical switches states that have realized state as provided as query parameter.
com.vmware.nsx.logical_switches_client.Statistics(config)¶com.vmware.nsx.logical_switches_client.Statistics(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Statistics.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Statistics.get().
get(lswitch_id, source=None)¶get(lswitch_id, source=None)¶
Returns statistics of a specified logical switch. The query parameter “source=realtime” is not supported.
com.vmware.nsx.logical_switches_client.Status(config)¶com.vmware.nsx.logical_switches_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Status.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Status.get().
GET_TRANSPORT_TYPE_OVERLAY = 'OVERLAY'¶Possible value for transportType of method Status.get().
GET_TRANSPORT_TYPE_VLAN = 'VLAN'¶Possible value for transportType of method Status.get().
get(cursor=None, diagnostic=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, switching_profile_id=None, transport_type=None, transport_zone_id=None, uplink_teaming_policy_name=None, vlan=None, vni=None)¶get(cursor=None, diagnostic=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, switching_profile_id=None, transport_type=None, transport_zone_id=None, uplink_teaming_policy_name=None, vlan=None, vni=None)¶
Returns Operational status of all logical switches. The query parameter “source=realtime” is not supported.
com.vmware.nsx.logical_switches_client.StubFactory(stub_config)¶com.vmware.nsx.logical_switches_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.logical_switches_client.Summary(config)¶com.vmware.nsx.logical_switches_client.Summary(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(lswitch_id)¶get(lswitch_id)¶
Returns the number of ports assigned to a logical switch.
com.vmware.nsx.logical_switches_client.VtepTable(config)¶com.vmware.nsx.logical_switches_client.VtepTable(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_SOURCE_CACHED = 'cached'¶Possible value for source of method VtepTable.list().
LIST_SOURCE_REALTIME = 'realtime'¶Possible value for source of method VtepTable.list().
list(lswitch_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)¶list(lswitch_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, source=None, transport_node_id=None)¶
Returns the virtual tunnel endpoint table of a specified logical switch from the given transport node if a transport node id is given in the query parameter, from the Central Controller Plane. The query parameter @@ -14908,18 +14908,18 @@ Not Found
com.vmware.nsx.mac_sets_client.Members(config)¶com.vmware.nsx.mac_sets_client.Members(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
create(mac_set_id, m_ac_address_element)¶create(mac_set_id, m_ac_address_element)¶
Add an individual MAC address to a MACSet
com.vmware.nsx.md_proxies_client.Statistics(config)¶com.vmware.nsx.md_proxies_client.Statistics(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
GET_SOURCE_CACHED = 'cached'¶Possible value for source of method Statistics.get().
GET_SOURCE_REALTIME = 'realtime'¶Possible value for source of method Statistics.get().
get(proxy_id, logical_switch_id=None, source=None)¶get(proxy_id, logical_switch_id=None, source=None)¶
Returns the statistics of the given metatada proxy. If no logical switch is provided, all staticstics of all the logical switches the proxy was attached will be returned.
@@ -15111,18 +15111,18 @@ Not Foundcom.vmware.nsx.md_proxies_client.Status(config)¶com.vmware.nsx.md_proxies_client.Status(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
com.vmware.nsx.migration_client.DiscoveredSwitches(config)¶com.vmware.nsx.migration_client.DiscoveredSwitches(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get the list of discovered switches (DVS, VSS) for the selected VC.
com.vmware.nsx.migration_client.FeedbackRequests(config)¶com.vmware.nsx.migration_client.FeedbackRequests(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_STATE_ALL = 'ALL'¶Possible value for state of method FeedbackRequests.list().
LIST_STATE_RESOLVED = 'RESOLVED'¶Possible value for state of method FeedbackRequests.list().
LIST_STATE_UNRESOLVED = 'UNRESOLVED'¶Possible value for state of method FeedbackRequests.list().
list(category=None, cursor=None, hash=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, state=None, sub_category=None)¶list(category=None, cursor=None, hash=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, state=None, sub_category=None)¶
Get feedback details of NSX-V to be migrated.
com.vmware.nsx.migration_client.FeedbackResponse(config)¶com.vmware.nsx.migration_client.FeedbackResponse(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
acceptrecommended()¶Pick default resolution for all feedback items.
@@ -15365,9 +15365,9 @@ Unauthorizedupdate(migration_feedback_response_list)¶update(migration_feedback_response_list)¶
Provide response for feedback queries needed for migration.
com.vmware.nsx.migration_client.FeedbackSummary(config)¶com.vmware.nsx.migration_client.FeedbackSummary(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get feedback summary of NSX-V to be migrated.
com.vmware.nsx.migration_client.GroupedFeedbackRequests(config)¶com.vmware.nsx.migration_client.GroupedFeedbackRequests(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
LIST_STATE_ALL = 'ALL'¶Possible value for state of method GroupedFeedbackRequests.list().
LIST_STATE_RESOLVED = 'RESOLVED'¶Possible value for state of method GroupedFeedbackRequests.list().
LIST_STATE_UNRESOLVED = 'UNRESOLVED'¶Possible value for state of method GroupedFeedbackRequests.list().
list(category=None, cursor=None, hash=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, state=None, sub_category=None)¶list(category=None, cursor=None, hash=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, state=None, sub_category=None)¶
Get feedback details of NSX-V to be migrated, grouped by feedback type.
com.vmware.nsx.migration_client.MigratedSwitches(config)¶com.vmware.nsx.migration_client.MigratedSwitches(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get the list of migrated switches (DVS, VSS) for the selected VC.
com.vmware.nsx.migration_client.MigrationUnitGroups(config)¶com.vmware.nsx.migration_client.MigrationUnitGroups(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
addmigrationunits(group_id, migration_unit_list)¶addmigrationunits(group_id, migration_unit_list)¶
Add migration units to specified migration unit group. The migration units will be added at the end of the migration unit list.
get(group_id, summary=None)¶get(group_id, summary=None)¶
Returns information about a specific migration unit group in the migration plan. If request parameter summary is set to true, then only count of migration units will be returned, migration units list will be @@ -15773,9 +15773,9 @@ Not Found
list(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, summary=None, sync=None)¶list(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, summary=None, sync=None)¶
Return information of all migration unit groups in the migration plan. If request parameter summary is set to true, then only count of migration units will be returned, migration units list will be empty. @@ -15829,9 +15829,9 @@ Not Found
reorder(group_id, reorder_migration_request)¶reorder(group_id, reorder_migration_request)¶
Reorder an migration unit group by placing it before/after the specified migration unit group.
update(group_id, migration_unit_group)¶update(group_id, migration_unit_group)¶
Update the specified migration unit group. Removal of migration units from the group using this is not allowed. An error will be returned in that case.
@@ -15908,18 +15908,18 @@ Not Foundcom.vmware.nsx.migration_client.MigrationUnitGroupsStatus(config)¶com.vmware.nsx.migration_client.MigrationUnitGroupsStatus(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
getall(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶getall(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get migration status for migration unit groups
com.vmware.nsx.migration_client.MigrationUnits(config)¶com.vmware.nsx.migration_client.MigrationUnits(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(migration_unit_id)¶get(migration_unit_id)¶
Get a specific migration unit
list(component_type=None, current_version=None, cursor=None, group_id=None, has_warnings=None, included_fields=None, metadata=None, migration_unit_type=None, page_size=None, sort_ascending=None, sort_by=None)¶list(component_type=None, current_version=None, cursor=None, group_id=None, has_warnings=None, included_fields=None, metadata=None, migration_unit_type=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get migration units
com.vmware.nsx.migration_client.MigrationUnitsStats(config)¶com.vmware.nsx.migration_client.MigrationUnitsStats(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, sync=None)¶list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, sync=None)¶
Get migration units stats
com.vmware.nsx.migration_client.Nodes(config)¶com.vmware.nsx.migration_client.Nodes(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
list(component_type=None, component_version=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶list(component_type=None, component_version=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶
Get list of nodes. If request parameter component type is specified, then all nodes for that component will be returned. If request parameter component version is specified, then all nodes at that @@ -16193,16 +16193,16 @@ Not Found
com.vmware.nsx.migration_client.NodesSummary(config)¶com.vmware.nsx.migration_client.NodesSummary(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Get summary of nodes, which includes node count for each type and @@ -16239,16 +16239,16 @@ Not Found
com.vmware.nsx.migration_client.Plan(config)¶com.vmware.nsx.migration_client.Plan(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
abort()¶Resets all migration steps done so far, so that migration can be @@ -16277,9 +16277,9 @@ Not Found
pause()¶Pause the migration. Migration will be paused after migration of all @@ -16382,9 +16382,9 @@ Not Found
rollback()¶Roll back the migration. Changes applied to target NSX will be @@ -16445,7 +16445,7 @@ Not Found
start()¶Start the migration. Migration will start as per the migration plan.
@@ -16475,16 +16475,16 @@ Not Foundcom.vmware.nsx.migration_client.Setup(config)¶com.vmware.nsx.migration_client.Setup(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Get setup details of NSX-V to be migrated.
@@ -16522,9 +16522,9 @@ Unauthorizedupdate(migration_setup_info)¶update(migration_setup_info)¶
Provide setup details of NSX-V to be migrated.
com.vmware.nsx.migration_client.StatusSummary(config)¶com.vmware.nsx.migration_client.StatusSummary(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get(component_type=None)¶get(component_type=None)¶
Get migration status summary
com.vmware.nsx.migration_client.StubFactory(stub_config)¶com.vmware.nsx.migration_client.StubFactory(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
com.vmware.nsx.migration_client.Summary(config)¶com.vmware.nsx.migration_client.Summary(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶Get migration summary
@@ -16671,16 +16671,16 @@ Not Foundcom.vmware.nsx.migration_client.Switch(config)¶com.vmware.nsx.migration_client.Switch(config)¶
Bases: vmware.vapi.bindings.stub.VapiInterface
config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
get()¶The user is returned the switch (DVS/VSS) set as current scope of @@ -16719,9 +16719,9 @@ Unauthorized
com.vmware.nsx.model_client.ALGTypeNSService(alg=None, destination_ports=None, source_ports=None, resource_type='ALGTypeNSService')¶com.vmware.nsx.model_client.ALGTypeNSService(alg=None, destination_ports=None, source_ports=None, resource_type='ALGTypeNSService')¶
Bases: vmware.vapi.bindings.struct.VapiStruct
An NSService element that represents an ALG protocol
ALG_FTP = 'FTP'¶ALG_MS_RPC_TCP = 'MS_RPC_TCP'¶ALG_MS_RPC_UDP = 'MS_RPC_UDP'¶ALG_NBDG_BROADCAST = 'NBDG_BROADCAST'¶ALG_NBNS_BROADCAST = 'NBNS_BROADCAST'¶ALG_ORACLE_TNS = 'ORACLE_TNS'¶ALG_SUN_RPC_TCP = 'SUN_RPC_TCP'¶ALG_SUN_RPC_UDP = 'SUN_RPC_UDP'¶ALG_TFTP = 'TFTP'¶resource_type¶Return the discriminator value
@@ -16866,9 +16866,9 @@ format: port-or-rangecom.vmware.nsx.model_client.AcceptableComponentVersion(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, acceptable_versions=None, component_type=None)¶com.vmware.nsx.model_client.AcceptableComponentVersion(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, acceptable_versions=None, component_type=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -16936,31 +16936,31 @@ it is present in a request to server it will be ignored. -COMPONENT_TYPE_CCP = 'CCP'¶COMPONENT_TYPE_EDGE = 'EDGE'¶COMPONENT_TYPE_HOST = 'HOST'¶COMPONENT_TYPE_MP = 'MP'¶com.vmware.nsx.model_client.AcceptableComponentVersionList(results=None)¶com.vmware.nsx.model_client.AcceptableComponentVersionList(results=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -16974,9 +16974,9 @@ names. -com.vmware.nsx.model_client.ActionableResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ip_address=None)¶com.vmware.nsx.model_client.ActionableResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ip_address=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Resources managed during restore process
com.vmware.nsx.model_client.ActionableResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶com.vmware.nsx.model_client.ActionableResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17077,9 +17077,9 @@ it is present in a request to server it will be ignored. -com.vmware.nsx.model_client.AddClusterNodeSpec(controller_role_config=None, display_name=None, external_id=None, mgr_role_config=None)¶com.vmware.nsx.model_client.AddClusterNodeSpec(controller_role_config=None, display_name=None, external_id=None, mgr_role_config=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17098,9 +17098,9 @@ names. -com.vmware.nsx.model_client.AddClusterNodeVMInfo(clustering_config=None, deployment_requests=None)¶com.vmware.nsx.model_client.AddClusterNodeVMInfo(clustering_config=None, deployment_requests=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Contains a list of cluster node VM deployment requests and optionally a clustering configuration.
@@ -17125,9 +17125,9 @@ attributes defined in +com.vmware.nsx.model_client.AddControllerNodeSpec(clustering_params=None, control_plane_server_certificate=None, host_msg_client_info=None, mpa_msg_client_info=None, node_id=None, type=None)¶com.vmware.nsx.model_client.AddControllerNodeSpec(clustering_params=None, control_plane_server_certificate=None, host_msg_client_info=None, mpa_msg_client_info=None, node_id=None, type=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17158,16 +17158,16 @@ specified, then the node_id will be set to a random id. -TYPE_ADDCONTROLLERNODESPEC = 'AddControllerNodeSpec'¶com.vmware.nsx.model_client.AddIntelligenceClusterNodeVMInfo(deployment_requests=None)¶com.vmware.nsx.model_client.AddIntelligenceClusterNodeVMInfo(deployment_requests=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Contains a list of NSX-Intelligence cluster node VM deployment requests and optionally a clustering configuration.
@@ -17184,9 +17184,9 @@ NSX.com.vmware.nsx.model_client.AddManagementNodeSpec(cert_thumbprint=None, mpa_msg_client_info=None, password=None, remote_address=None, type=None, user_name=None)¶com.vmware.nsx.model_client.AddManagementNodeSpec(cert_thumbprint=None, mpa_msg_client_info=None, password=None, remote_address=None, type=None, user_name=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17213,16 +17213,16 @@ request. format: ip -TYPE_ADDMANAGEMENTNODESPEC = 'AddManagementNodeSpec'¶com.vmware.nsx.model_client.AddressBindingEntry(binding=None, binding_timestamp=None, source=None)¶com.vmware.nsx.model_client.AddressBindingEntry(binding=None, binding_timestamp=None, source=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
An address binding entry is a combination of the IP-MAC-VLAN binding for a logical port. The address bindings can be obtained via various methods like @@ -17257,56 +17257,56 @@ manually specified by the user format: int64
SOURCE_ARP_SNOOPING = 'ARP_SNOOPING'¶SOURCE_DHCPV6_SNOOPING = 'DHCPV6_SNOOPING'¶SOURCE_DHCP_SNOOPING = 'DHCP_SNOOPING'¶SOURCE_INVALID = 'INVALID'¶SOURCE_ND_SNOOPING = 'ND_SNOOPING'¶SOURCE_UNKNOWN = 'UNKNOWN'¶SOURCE_USER_DEFINED = 'USER_DEFINED'¶SOURCE_VM_TOOLS = 'VM_TOOLS'¶SOURCE_VM_TOOLS_V6 = 'VM_TOOLS_V6'¶com.vmware.nsx.model_client.AdvanceClusterRestoreInput(id=None, resources=None)¶com.vmware.nsx.model_client.AdvanceClusterRestoreInput(id=None, resources=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17326,9 +17326,9 @@ it is present in a request to server it will be ignored. -com.vmware.nsx.model_client.AdvanceClusterRestoreRequest(data=None)¶com.vmware.nsx.model_client.AdvanceClusterRestoreRequest(data=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17342,9 +17342,9 @@ names. -com.vmware.nsx.model_client.AdvertiseRule(action=None, description=None, display_name=None, networks=None, rule_filter=None)¶com.vmware.nsx.model_client.AdvertiseRule(action=None, description=None, display_name=None, networks=None, rule_filter=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17369,21 +17369,21 @@ advertisement of a filtered routes to the connected TIER0 router. -ACTION_ALLOW = 'ALLOW'¶ACTION_DENY = 'DENY'¶com.vmware.nsx.model_client.AdvertiseRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, rules=None)¶com.vmware.nsx.model_client.AdvertiseRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, rules=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17445,9 +17445,9 @@ it is present in a request to server it will be ignored. -com.vmware.nsx.model_client.AdvertisementConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, advertise_dns_forwarder=None, advertise_ipsec_local_ip=None, advertise_lb_snat_ip=None, advertise_lb_vip=None, advertise_nat_routes=None, advertise_nsx_connected_routes=None, advertise_static_routes=None, enabled=None, logical_router_id=None)¶com.vmware.nsx.model_client.AdvertisementConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, advertise_dns_forwarder=None, advertise_ipsec_local_ip=None, advertise_lb_snat_ip=None, advertise_lb_vip=None, advertise_nat_routes=None, advertise_nsx_connected_routes=None, advertise_static_routes=None, enabled=None, logical_router_id=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Advertisement config for different types of routes which need to be advertised from TIER1 logical router to the linked TIER0 logical router
@@ -17520,9 +17520,9 @@ it is present in a request to server it will be ignored.com.vmware.nsx.model_client.AdvertisementRuleFilter(match_route_types=None, prefix_operator=None)¶com.vmware.nsx.model_client.AdvertisementRuleFilter(match_route_types=None, prefix_operator=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
To filter the routes advertised by the TIER1 LR to TIER0 LR. Filtering will be based on the type of route and the prefix operator configured.
@@ -17565,71 +17565,71 @@ network configured in Advertise rule.MATCH_ROUTE_TYPES_ANY = 'ANY'¶MATCH_ROUTE_TYPES_NSX_CONNECTED = 'NSX_CONNECTED'¶MATCH_ROUTE_TYPES_STATIC = 'STATIC'¶MATCH_ROUTE_TYPES_T1_CONNECTED = 'T1_CONNECTED'¶MATCH_ROUTE_TYPES_T1_DNSFORWARDER = 'T1_DNSFORWARDER'¶MATCH_ROUTE_TYPES_T1_IPSEC_LOCAL_IP = 'T1_IPSEC_LOCAL_IP'¶MATCH_ROUTE_TYPES_T1_LB_SNAT = 'T1_LB_SNAT'¶MATCH_ROUTE_TYPES_T1_LB_VIP = 'T1_LB_VIP'¶MATCH_ROUTE_TYPES_T1_NAT = 'T1_NAT'¶MATCH_ROUTE_TYPES_T1_STATIC = 'T1_STATIC'¶PREFIX_OPERATOR_EQ = 'EQ'¶PREFIX_OPERATOR_GE = 'GE'¶com.vmware.nsx.model_client.AgentStatus(name=None, status=None)¶com.vmware.nsx.model_client.AgentStatus(name=None, status=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17663,46 +17663,46 @@ names. -NAME_AGENT = 'NSX_AGENT'¶NAME_CFGAGENT = 'NSX_CFGAGENT'¶NAME_NESTDB = 'NSX_NESTDB'¶NAME_OPSAGENT = 'NSX_OPSAGENT'¶STATUS_DOWN = 'DOWN'¶STATUS_UNKNOWN = 'UNKNOWN'¶STATUS_UP = 'UP'¶com.vmware.nsx.model_client.AgentStatusCount(agents=None, down_count=None, status=None, up_count=None)¶com.vmware.nsx.model_client.AgentStatusCount(agents=None, down_count=None, status=None, up_count=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17728,26 +17728,26 @@ names. -STATUS_DOWN = 'DOWN'¶STATUS_UNKNOWN = 'UNKNOWN'¶STATUS_UP = 'UP'¶com.vmware.nsx.model_client.AggregatedDataCounter(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None)¶com.vmware.nsx.model_client.AggregatedDataCounter(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17766,9 +17766,9 @@ names. -com.vmware.nsx.model_client.AggregatedDataCounterEx(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None)¶com.vmware.nsx.model_client.AggregatedDataCounterEx(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17789,9 +17789,9 @@ names. -com.vmware.nsx.model_client.AggregatedLogicalRouterPortCounters(last_update_timestamp=None, rx=None, tx=None)¶com.vmware.nsx.model_client.AggregatedLogicalRouterPortCounters(last_update_timestamp=None, rx=None, tx=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -17812,9 +17812,9 @@ it is present in a request to server it will be ignored. -com.vmware.nsx.model_client.Alarm(id=None, message=None, severity=None, source_comp=None, source_comp_id=None, source_subcomp=None, sources=None, state=None, timestamp=None)¶com.vmware.nsx.model_client.Alarm(id=None, message=None, severity=None, source_comp=None, source_comp_id=None, source_subcomp=None, sources=None, state=None, timestamp=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Alarm in NSX that needs users’ attention
SEVERITY_CRITICAL = 'CRITICAL'¶SEVERITY_MAJOR = 'MAJOR'¶SEVERITY_MINOR = 'MINOR'¶SEVERITY_UNKNOWN = 'UNKNOWN'¶STATE_ACKNOWLEDGED = 'ACKNOWLEDGED'¶STATE_ACTIVE = 'ACTIVE'¶STATE_RESOLVED = 'RESOLVED'¶STATE_UNKNOWN = 'UNKNOWN'¶com.vmware.nsx.model_client.AlarmListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶com.vmware.nsx.model_client.AlarmListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Alarm collection results
com.vmware.nsx.model_client.AlarmSource(id=None, interface_name=None, ip_address=None, ip_address_type=None, local_ip=None, mount=None, peer_ip=None, process_name=None, quiesce_blocked_time=None, thread_id=None)¶com.vmware.nsx.model_client.AlarmSource(id=None, interface_name=None, ip_address=None, ip_address_type=None, local_ip=None, mount=None, peer_ip=None, process_name=None, quiesce_blocked_time=None, thread_id=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Source of the Alarm
IP_ADDRESS_TYPE_IPV4 = 'IPV4'¶IP_ADDRESS_TYPE_IPV6 = 'IPV6'¶com.vmware.nsx.model_client.AllClusterGroupStatus(cluster_id=None, groups=None, overall_status=None)¶com.vmware.nsx.model_client.AllClusterGroupStatus(cluster_id=None, groups=None, overall_status=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
A list of the statuses of all the groups in the cluster.
OVERALL_STATUS_DEGRADED = 'DEGRADED'¶OVERALL_STATUS_STABLE = 'STABLE'¶OVERALL_STATUS_UNAVAILABLE = 'UNAVAILABLE'¶com.vmware.nsx.model_client.AllocatedService(allocation_details=None, high_availability_status=None, service_reference=None)¶com.vmware.nsx.model_client.AllocatedService(allocation_details=None, high_availability_status=None, service_reference=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -18102,36 +18102,36 @@ it is present in a request to server it will be ignored. -HIGH_AVAILABILITY_STATUS_ACTIVE = 'ACTIVE'¶HIGH_AVAILABILITY_STATUS_DOWN = 'DOWN'¶HIGH_AVAILABILITY_STATUS_STANDBY = 'STANDBY'¶HIGH_AVAILABILITY_STATUS_SYNC = 'SYNC'¶HIGH_AVAILABILITY_STATUS_UNKNOWN = 'UNKNOWN'¶com.vmware.nsx.model_client.AllocationBasedOnFailureDomain(enabled=None, action_type='AllocationBasedOnFailureDomain')¶com.vmware.nsx.model_client.AllocationBasedOnFailureDomain(enabled=None, action_type='AllocationBasedOnFailureDomain')¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Auto place TIER1 logical routers, DHCP and MDProxy contexts on two edge nodes (active and standby) from different failure domains.
@@ -18156,7 +18156,7 @@ in auto placement.action_type¶Return the discriminator value
@@ -18164,9 +18164,9 @@ in auto placement.com.vmware.nsx.model_client.AllocationIpAddress(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, allocation_id=None)¶com.vmware.nsx.model_client.AllocationIpAddress(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, allocation_id=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Allocation parameters for the IP address (e.g. specific IP address) can be specified. Tags, display_name and description attributes are not supported @@ -18230,9 +18230,9 @@ it is present in a request to server it will be ignored.
com.vmware.nsx.model_client.AllocationIpAddressListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶com.vmware.nsx.model_client.AllocationIpAddressListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -18270,9 +18270,9 @@ it is present in a request to server it will be ignored. -com.vmware.nsx.model_client.AllocationPool(active_service_count=None, standby_service_count=None, sub_pools=None)¶com.vmware.nsx.model_client.AllocationPool(active_service_count=None, standby_service_count=None, sub_pools=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -18296,9 +18296,9 @@ it is present in a request to server it will be ignored. -com.vmware.nsx.model_client.AllocationRule(action=None)¶com.vmware.nsx.model_client.AllocationRule(action=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Allocation rule on edge cluster which will be considered in auto placement of TIER1 logical routers, DHCP and MDProxy.
@@ -18319,9 +18319,9 @@ attributes defined in +com.vmware.nsx.model_client.AllocationRuleAction(action_type='AllocationRuleAction')¶com.vmware.nsx.model_client.AllocationRuleAction(action_type='AllocationRuleAction')¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Define action for each allocation rule which added on edge cluster.
ACTION_TYPE_ALLOCATIONBASEDONFAILUREDOMAIN = 'AllocationBasedOnFailureDomain'¶action_type¶Return the discriminator value
@@ -18353,9 +18353,9 @@ in auto placement.com.vmware.nsx.model_client.ApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)¶com.vmware.nsx.model_client.ApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Detailed information about an API Error
com.vmware.nsx.model_client.ApiServiceConfig(cipher_suites=None, client_api_concurrency_limit=None, client_api_rate_limit=None, connection_timeout=None, global_api_concurrency_limit=None, lockout_immune_addresses=None, protocol_versions=None, redirect_host=None, session_timeout=None)¶com.vmware.nsx.model_client.ApiServiceConfig(cipher_suites=None, client_api_concurrency_limit=None, client_api_rate_limit=None, connection_timeout=None, global_api_concurrency_limit=None, lockout_immune_addresses=None, protocol_versions=None, redirect_host=None, session_timeout=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Properties that affect the configuration of the NSX API service.
com.vmware.nsx.model_client.AppDiscoveryAppProfileResultSummary(app_profile_id=None, display_name=None, installed_apps_count=None)¶com.vmware.nsx.model_client.AppDiscoveryAppProfileResultSummary(app_profile_id=None, display_name=None, installed_apps_count=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Contains the application discovery result summary of the App Profile
com.vmware.nsx.model_client.AppDiscoverySession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, end_timestamp=None, failed_reason=None, reclassification=None, start_timestamp=None, status=None)¶com.vmware.nsx.model_client.AppDiscoverySession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, end_timestamp=None, failed_reason=None, reclassification=None, start_timestamp=None, status=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Contains the details of an application discovery session
RECLASSIFICATION_NOT_REQUIRED = 'NOT_REQUIRED'¶RECLASSIFICATION_REQUIRED = 'REQUIRED'¶STATUS_FAILED = 'FAILED'¶STATUS_FINISHED = 'FINISHED'¶STATUS_RUNNING = 'RUNNING'¶com.vmware.nsx.model_client.AppDiscoverySessionResultSummary(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, end_timestamp=None, failed_reason=None, reclassification=None, start_timestamp=None, status=None, app_profile_summary_list=None, app_profiles=None, ns_groups=None)¶com.vmware.nsx.model_client.AppDiscoverySessionResultSummary(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, end_timestamp=None, failed_reason=None, reclassification=None, start_timestamp=None, status=None, app_profile_summary_list=None, app_profiles=None, ns_groups=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Contains the summary of the results of an application discovery session
RECLASSIFICATION_NOT_REQUIRED = 'NOT_REQUIRED'¶RECLASSIFICATION_REQUIRED = 'REQUIRED'¶STATUS_FAILED = 'FAILED'¶STATUS_FINISHED = 'FINISHED'¶STATUS_RUNNING = 'RUNNING'¶com.vmware.nsx.model_client.AppDiscoverySessionsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶com.vmware.nsx.model_client.AppDiscoverySessionsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Application discovery sessions list
com.vmware.nsx.model_client.AppDiscoveryVmInfo(links=None, schema=None, self_=None, os_properties=None, os_type=None, vm_external_id=None, vm_name=None)¶com.vmware.nsx.model_client.AppDiscoveryVmInfo(links=None, schema=None, self_=None, os_properties=None, os_type=None, vm_external_id=None, vm_name=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
AppDiscoveryVmInfo details
OS_TYPE_INVALID = 'INVALID'¶OS_TYPE_LINUX = 'LINUX'¶OS_TYPE_WINDOWS = 'WINDOWS'¶com.vmware.nsx.model_client.AppDiscoveryVmInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶com.vmware.nsx.model_client.AppDiscoveryVmInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
AppDiscoveryVmInfo list
com.vmware.nsx.model_client.AppInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, manufacturer=None, name=None, os_type=None, version=None, vm_ids=None)¶com.vmware.nsx.model_client.AppInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, manufacturer=None, name=None, os_type=None, version=None, vm_ids=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
AppInfo details
OS_TYPE_INVALID = 'INVALID'¶OS_TYPE_LINUX = 'LINUX'¶OS_TYPE_WINDOWS = 'WINDOWS'¶com.vmware.nsx.model_client.AppInfoHostVmCsvRecord(display_name=None, host_vms=None, id=None, manufacturer=None, os_type=None, version=None)¶com.vmware.nsx.model_client.AppInfoHostVmCsvRecord(display_name=None, host_vms=None, id=None, manufacturer=None, os_type=None, version=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -18926,26 +18926,26 @@ it is present in a request to server it will be ignored. -OS_TYPE_INVALID = 'INVALID'¶OS_TYPE_LINUX = 'LINUX'¶OS_TYPE_WINDOWS = 'WINDOWS'¶com.vmware.nsx.model_client.AppInfoHostVmListInCsvFormat(file_name=None, results=None)¶com.vmware.nsx.model_client.AppInfoHostVmListInCsvFormat(file_name=None, results=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -18963,9 +18963,9 @@ session -com.vmware.nsx.model_client.AppInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶com.vmware.nsx.model_client.AppInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
AppInfo Sessions list results
com.vmware.nsx.model_client.AppProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, app_profile_category=None, app_profile_criteria=None, default_app_profile=None)¶com.vmware.nsx.model_client.AppProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, app_profile_category=None, app_profile_criteria=None, default_app_profile=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
AppProfile details
com.vmware.nsx.model_client.AppProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶com.vmware.nsx.model_client.AppProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
App Profile ID list
com.vmware.nsx.model_client.AppProfileMemberAppsCsvRecord(app_profile_category=None, app_profile_criteria=None, description=None, display_name=None, member_apps=None)¶com.vmware.nsx.model_client.AppProfileMemberAppsCsvRecord(app_profile_category=None, app_profile_criteria=None, description=None, display_name=None, member_apps=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -19146,9 +19146,9 @@ it is present in a request to server it will be ignored. -com.vmware.nsx.model_client.AppProfileMemberAppsListInCsvFormat(file_name=None, results=None)¶com.vmware.nsx.model_client.AppProfileMemberAppsListInCsvFormat(file_name=None, results=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Tip
@@ -19165,9 +19165,9 @@ names. -com.vmware.nsx.model_client.AppProfileMetaInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, app_profile_category=None, app_profile_id=None, app_profile_name=None)¶com.vmware.nsx.model_client.AppProfileMetaInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, app_profile_category=None, app_profile_id=None, app_profile_name=None)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Contains the metadata of an App Profile
com.vmware.nsx.model_client.ApplianceManagementTaskListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶com.vmware.nsx.model_client.ApplianceManagementTaskListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶
Bases: