NSX-T Data Center REST API
EdgeCluster (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ManagedResource"
},
"id": "EdgeCluster",
"module_id": "EdgeClusters",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp",
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp",
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink"
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"computed": true,
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink",
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"allocation_rules": {
"description": "Set of allocation rules and respected action for auto placement of logical router, DHCP and MDProxy on edge cluster members.",
"items": {
"$ref": "AllocationRule"
},
"required": false,
"title": "Allocation rules for auto placement",
"type": "array"
},
"cluster_profile_bindings": {
"items": {
"$ref": "ClusterProfileTypeIdEntry"
},
"required": false,
"title": "Edge cluster profile bindings",
"type": "array"
},
"core_allocation_profile": {
"$ref": "CoreAllocationProfile",
"description": "The Core Allocation Profile attribute defines the core allocation for edge transport nodes within a cluster, and any new or redeployed edge will utilize this profile. It can be updated to another supported profile, which subsequently updates the core profile on all edges in the cluster. Note that a manual reboot is required for the new profile to be applied to the edge appliance. To verify the current profile applied to cluster members, use the Edge Cluster State API. <br>https://<nsx-mgr>/api/v1/edge-clusters/<edge-cluster-id>/state</br>",
"nsx_feature": "ConfigureEdgeCoreAllocationProfiles",
"required": false,
"title": "Core allocation profile to be set on cluster members"
},
"deployment_type": {
"$ref": "EdgeDeploymentType",
"description": "This field is a readonly field which shows the deployment_type of members. It returns UNKNOWN if there are no members, and returns VIRTUAL_MACHINE| PHYSICAL_MACHINE if all edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE. It returns HYBRID if the cluster contains edge members of both types VIRTUAL_MACHINE and PHYSICAL_MACHINE.",
"readonly": true,
"required": false,
"title": "Edge cluster deployment type"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"computed": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"enable_inter_site_forwarding": {
"description": "Flag should be only use in federation for inter site l2 and l3 forwarding. Before enabling this flag, all the edge cluster members must have remote tunnel endpoint configured. TIER0/TIER1 logical routers managed by GM must be associated with edge cluster which has inter-site forwarding enabled.",
"readonly": true,
"title": "Flag to enable inter site forwarding",
"type": "boolean"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"member_node_type": {
"$ref": "EdgeClusterNodeType",
"description": "Edge cluster is homogenous collection of transport nodes. Hence all transport nodes of the cluster must be of same type. This readonly field shows the type of transport nodes.",
"readonly": true,
"required": false,
"title": "Node type of the cluster members"
},
"members": {
"description": "EdgeCluster only supports homogeneous members. These member should be backed by either EdgeNode or PublicCloudGatewayNode. TransportNode type of these nodes should be the same. DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is recommended to be the same. EdgeCluster supports members of different deployment types.",
"items": {
"$ref": "EdgeClusterMember"
},
"required": false,
"title": "Edge cluster members",
"type": "array"
},
"node_rtep_ips": {
"description": "List of remote tunnel endpoint ipaddress configured on edge cluster for each transport node.",
"items": {
"$ref": "NodeRtepIpsConfig"
},
"readonly": true,
"required": false,
"title": "Remote tunnel endpoint ip address.",
"type": "array"
},
"password_managed_by_vcf": {
"default": false,
"description": "Setting to true enables VCF password management for all edge nodes in the cluster.",
"readonly": false,
"title": "VCF managed password flag",
"type": "boolean"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag"
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"type": "object"
}