[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

NsxTEdgeCluster

Information about a configured edge cluster on an NSX-T manager. An Edge cluster is a group of edge transport nodes.


Properties

deploymentType Optional

Deployment type for transport nodes in the edge cluster. The nodes in the edge cluster may have different deployment types. This field has been deprecated.


string
description Optional

Description of the edge cluster.


string
id Optional

The unique id of the edge cluster on the NSX-T manager.


string
name Optional

Name of edge cluster.


integer
nodeCount Optional

Number of edge transport nodes in the edge cluster. If this information is not available, nodeCount will be set to -1. This field has been deprecated.


nodeType Optional

Type of transport nodes in the edge cluster. All the nodes in the edge cluster are of same type.

JSON Example

{
	"deploymentType": "enum",
	"description": "string",
	"id": "string",
	"name": "string",
	"nodeCount": 0,
	"nodeType": "enum"
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-cross-references:
    - cross-reference:
        alias: orgVdcId
        referenced-property: id
        referenced-type: ./networking/vdcs.yaml#/definitions/OrgVdc
    - cross-reference:
        alias: vdcGroupId
        referenced-property: id
        referenced-type: ./networking/vdcGroups.yaml#/definitions/VdcGroup
    - cross-reference:
        alias: pvdcId
        referenced-property: id
        referenced-type: ./pvdc/pvdc.yaml#/definitions/ProviderVdc
x-vcloud-property-annotations:
    deploymentType:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
        x-vcloud-deprecated-alternative: No alternative, this will be set to UNKNOWN starting API version 37.1
        x-vcloud-deprecated-in: "37.1"
    description:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    id:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    name:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
    nodeCount:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
        x-vcloud-deprecated-alternative: No alternative, this will be set to (-1) starting API version 37.1
        x-vcloud-deprecated-in: "37.1"
    nodeType:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 34.0
Property Of

NsxTEdgeClusters

Feedback

Was this page helpful?