Nsx_Clusters_Info

Nsx_Clusters_Info
Nsx_Clusters_Info

The Clusters.Info structure contains the specification of NSX networking with transport node configuration on all the hosts in a vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

JSON Example
{
    "dv_switch": "string",
    "dv_switch_name": "string",
    "overlay_network_info": {
        "vlan": 0,
        "mode": "string",
        "ip_pool_info": {
            "name": "string",
            "notation": "string",
            "cidr": {
                "address": "string",
                "prefix": 0
            },
            "ip_range": {
                "starting_address": "string",
                "size_specifier": "string",
                "ending_address": "string",
                "address_count": 0,
                "subnet_mask": "string"
            },
            "gateway": "string"
        }
    }
}
string
dv_switch
Required

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.

string
dv_switch_name
Optional

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. To be unset or empty when the name of Clusters.Info.dv-switch could not be fetched.

overlay_network_info
Required

The Clusters.ClusterOverlayNetworkInfo contains information related to network configuration for the Tunnel Endpoints (TEPs) on the hosts in the vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.