Nsx APIs
The vcenter nsx package provides services for configuration of NSX capabilities on VC clusters.
The Clusters service provides operations to configure NSX networking on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The Edge-clusters service provides operations to configure NSX Edge capabilities on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The IpPools service provides operations to read NSX IP pools used on NSX enabled vSphere clusters. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The ManagementNetworkCompatibility service provides operations to get compatibility information for distributed port groups (DVPG) and their associated VMKernel NICs. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The Recovery service represents all the operations of NSXi Infrastructure Recovery for vSphere clusters. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The Configuration service provides operations to configure NSX networking on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This service is restricted for VMware internal use only.
The NetworkingStatus service provides operations to query the networking status of a vSphere cluster on which NSX networking is enabled. Networking status is comprised of the overall configuration status of the cluster, status of the vSphere Distributed Switch (VDS) which was used for the overlay network configuration of the cluster, configuration status and health status of NSX Edge node(s) in the cluster, configuration status and health status of ESXi hosts in the cluster and information about the logical router in the NSX Edge node(s). Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The Status service provides operations to get the status of configuration of NSX networking on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This service is restricted for VMware internal use only.
The Validation service provides operations to validate a specification that can be used to enable NSX networking with transport node configuration on all the hosts in a vSphere cluster and enable NSX Edge nodes in a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The Compatibility service provides compatibility information between current vCenter server version and currently installed NSX version. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The Configuration service contains the information about currently deployed NSX. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The Install service provides operations to create, query and delete an NSX appliance attached to the vCenter. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The InstallRecommendations service defines the resource requirements for various NSX appliance sizes and recommends an NSX size based on the vCenter size. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The License service provides operations to query, validate and apply license to the NSX Manager Appliance attached to the vCenter. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The SoftwarePackage service contains operations related to staging NSX integrated binaries needed to install and manage NSX integrated functionality. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The SupportedVersion service provides information about the supported NSX version for vCenter server. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The Upgrade service represents all the operations of NSX Upgrade from vCenter server. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
The UpgradeStatus service represents the status with respect to current NSX upgrade. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This service is restricted for VMware internal use only.
The Configuration service provides operations to set up and tear down NSX Edge capabilities on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This service is restricted for VMware internal use only.
The Status service provides operations to get the status of configuration of NSX Edge capabilities on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Note: This service is restricted for VMware internal use only.