REST API - get

vcenter nsx edge clusters: get

Return information about NSX Edge cluster 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/edge-clusters/{cluster}

Path Parameters

Name	Type	Description
Required
cluster	string	Identifier for the compute resource associated with the NSX Edge node(s).

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "uplink_edge_nodes" : [
        {
            "hostname" : "string",
            "datastore" : "obj-103",
            "name" : "string",
            "uplink_ip_address" : "string",
            "management_ip_address" : "string",
            "id" : "obj-103",
            "datastore_name" : "string"
        },
        {
            "hostname" : "string",
            "datastore" : "obj-103",
            "name" : "string",
            "uplink_ip_address" : "string",
            "management_ip_address" : "string",
            "id" : "obj-103",
            "datastore_name" : "string"
        }
    ],
    "management_network_info" : {
        "network_name" : "string",
        "subnet_mask" : "string",
        "gateway" : "string",
        "network" : "obj-103"
    },
    "uplink_network_info" : {
        "vlan" : 1,
        "subnet_mask" : "string",
        "gateway" : "string"
    },
    "overlay_network_info" : {
        "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
    },
    "placement_info" : {
        "resource_pool_name" : "string",
        "resource_pool" : "obj-103"
    },
    "edge_nodes" : [
        {
            "hostname" : "string",
            "datastore" : "obj-103",
            "name" : "string",
            "management_ip_address" : "string",
            "id" : "obj-103",
            "datastore_name" : "string"
        },
        {
            "hostname" : "string",
            "datastore" : "obj-103",
            "name" : "string",
            "management_ip_address" : "string",
            "id" : "obj-103",
            "datastore_name" : "string"
        }
    ]
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Information about the NSX Edge cluster specification enabled on the cluster corresponding to the given cluster ID.
-.uplink_edge_nodes	uplink_node_info[]	List of specifications of the two NSX Edge node(s) when NSX was enabled. 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.
-.uplink_edge_nodes[].uplink_ip_address	string	IP address of the interface on the uplink 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.
-.uplink_edge_nodes[].id	string	ID of the virtual machine for the NSX Edge node. 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 when ID is not present.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `VirtualMachine`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `VirtualMachine`.
-.uplink_edge_nodes[].name	string	Name of the virtual machine for the NSX Edge node. 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.
-.uplink_edge_nodes[].hostname	string	A fully qualified domain name (FQDN) for the NSX Edge node. 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.
-.uplink_edge_nodes[].management_ip_address	string	IP address of the interface on the management 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.
-.uplink_edge_nodes[].datastore	string	Identifier of the datastore associated with the NSX Edge node. 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: `Datastore`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore`.
-.uplink_edge_nodes[].datastore_name	string	Name of the the datastore associated with the NSX Edge node. 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 when name of vcenter.nsx.edge_clusters.node_info.datastore could not be fetched.
-.edge_nodes	node_info[]	List of specifications of remaining NSX Edge node(s) in the Edge Cluster. 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.
-.placement_info	placement_info	Specification of the placement associated with the NSX Edge node(s). 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.
-.placement_info.resource_pool	string	Identifier of the resource pool associated with the NSX Edge node(s). 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 when resource pool doesn't exist.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `ResourcePool`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `ResourcePool`.
-.placement_info.resource_pool_name	string	Name of the resource pool associated with the NSX Edge node(s). 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 when resource pool doesn't exist.
-.management_network_info	management_network_info	Specification of the management network of the NSX Edge node(s). 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.
-.management_network_info.network	string	Identifier for the 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. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `DistributedVirtualPortgroup`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `DistributedVirtualPortgroup`.
-.management_network_info.network_name	string	Name of the 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. Optional. To be unset when name of vcenter.nsx.edge_clusters.management_network_info.network could not be fetched.
-.management_network_info.subnet_mask	string	Subnet mask for the interface on the 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.
-.management_network_info.gateway	string	Gateway IP address for the interface on the 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.
-.uplink_network_info	uplink_network_info	Specification of the uplink network of the NSX Edge node(s). 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.
-.uplink_network_info.vlan	long	The VLAN identifier for the 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.
-.uplink_network_info.subnet_mask	string	Subnet mask for the interface on the 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.
-.uplink_network_info.gateway	string	Gateway IP address for the interface on the 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	edge_overlay_network_info	Specification of the overlay network of the NSX Edge node(s). 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.ip_pool_info	ip_pool_info	The specification of the NSX IP pool created and used for the network interface. 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.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.