REST API - get

vcenter nsx ip pools: get

Read the NSX IP pool. 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/ip-pools/{ipPool}

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "ip_range" : {
        "size_specifier" : "ENDING_ADDRESS",
        "ending_address" : "string",
        "subnet_mask" : "string",
        "starting_address" : "string",
        "address_count" : 1
    },
    "vlan" : 1,
    "notation" : "CIDR",
    "cidr" : {
        "address" : "string",
        "prefix" : 1
    },
    "gateway" : "string"
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	vcenter.nsx.ip_pools.info NSX IP pool information for the IP pool specified by `ip_pool`.
-.vlan	long	The VLAN ID 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.
-.notation	string	The format for IP pool 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.
-.cidr	ipv4_cidr	The IPv4 CIDR. 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.
-.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.
-.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.
-.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.
-.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.
-.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.
-.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.
-.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.
-.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.
-.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	if the NSX IP pool identified by `ip_pool` is not found.
500	error	if the system reports an error while responding to the request.