REST API - get

vcenter nsx clusters: get

Returns information about NSX networking specification on a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/vcenter/nsx/clusters/{cluster}

Path Parameters

Name	Type	Description
Required
cluster	string	Identifier for the vSphere cluster on which NSX networking is enabled.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "dv_switch" : "obj-103",
    "overlay_network_info" : {
        "mode" : "DHCP",
        "ip_pool_info" : {
            "ip_range" : {
                "size_specifier" : "ENDING_ADDRESS",
                "ending_address" : "string",
                "subnet_mask" : "string",
                "starting_address" : "string",
                "address_count" : 1
            },
            "notation" : "CIDR",
            "name" : "obj-103",
            "cidr" : {
                "address" : "string",
                "prefix" : 1
            },
            "gateway" : "string"
        },
        "vlan" : 1
    },
    "dv_switch_name" : "string"
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Information about the NSX networking specification enabled on the cluster corresponding to the given cluster ID.
-.dv_switch	string	The vSphere Distributed Switch (VDS) used for hosts' transport node configuration. All the hosts in the vSphere cluster would be connected to this VDS. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `DistributedVirtualSwitch`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `DistributedVirtualSwitch`.
-.dv_switch_name	string	The name of the vSphere Distributed Switch. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. To be unset or empty when the name of vcenter.nsx.clusters.info.dv_switch could not be fetched.
-.overlay_network_info	cluster_overlay_network_info	The network specification of the hosts' transport node configuration. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.overlay_network_info.vlan	long	The VLAN identifier for this network. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.overlay_network_info.mode	string	The IP address allocation mode. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Defines different address allocation modes. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: DHCP: The address is automatically assigned by a DHCP server. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. IP_POOL: The address is assigned from an NSX IP pool. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.overlay_network_info.ip_pool_info	ip_pool_info	NSX IP pool information. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. It is only relevant when mode has value IP_POOL. This field is optional and it is only relevant when the value of `mode` is IP_POOL.
-.overlay_network_info.ip_pool_info.name	string	The ID(Name) of the IP Pool. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.nsx.pools.ip_pool`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.nsx.pools.ip_pool`.
-.overlay_network_info.ip_pool_info.notation	string	The format for IP range specification. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Defines different notations used to represent range of IP addresses. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: CIDR: The IPv4 addresses are represented as a CIDR. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. IP_RANGE: The IPv4 addresses are represented as a range of IP addresses. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.overlay_network_info.ip_pool_info.cidr	ipv4_cidr	The CIDR string denoting the range of IP addresses and the prefix. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. It is only relevant when notation has value CIDR. This field is optional and it is only relevant when the value of `notation` is CIDR.
-.overlay_network_info.ip_pool_info.cidr.address	string	The IPv4 address. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.overlay_network_info.ip_pool_info.cidr.prefix	long	The prefix length in the IPv4 CIDR notation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.overlay_network_info.ip_pool_info.ip_range	ipv4_range	The IPv4 address range. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. It is only relevant when notation has value IP_RANGE. This field is optional and it is only relevant when the value of `notation` is IP_RANGE.
-.overlay_network_info.ip_pool_info.ip_range.starting_address	string	The IPv4 address denoting the start of the range. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.overlay_network_info.ip_pool_info.ip_range.size_specifier	string	The size specification used for the range. This field must be set to ENDING_ADDRESS. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Defines the ways to specify the ending address in an IPv4 address range. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: ENDING_ADDRESS: The end address of the IPv4 address range is specified by providing the IPv4 end address. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. ADDRESS_COUNT: The end address of the IPv4 address range is derived from the specified starting address and address count. This option is for future use. It is not supported yet. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.overlay_network_info.ip_pool_info.ip_range.ending_address	string	The IPv4 address denoting the end of the range. The range includes the vcenter.nsx.ipv4_range.ending_address. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. It is only relevant when size_specifier has value ENDING_ADDRESS. This field is optional and it is only relevant when the value of `size_specifier` is ENDING_ADDRESS.
-.overlay_network_info.ip_pool_info.ip_range.address_count	long	A positive number denoting the number of IP addresses in the range. Addresses are derived by incrementing vcenter.nsx.ipv4_range.starting_address. This field is for future use. It is not supported yet. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. It is only relevant when size_specifier has value ADDRESS_COUNT. This field is optional and it is only relevant when the value of `size_specifier` is ADDRESS_COUNT.
-.overlay_network_info.ip_pool_info.ip_range.subnet_mask	string	The subnet mask to be set. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.overlay_network_info.ip_pool_info.gateway	string	The IPv4 address of the gateway associated with the NSX IP pool. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Errors:

HTTP Status Code	Type	Description
404	not_found	NSX specification could not be located.
500	error	if the system reports an error while responding to the request.