Update Edge Cluster

Modifies the specified edge cluster. Modifiable parameters include the
description, display_name, transport-node-id. If the optional
fabric_profile_binding is included, resource_type and profile_id are required.
User should do a GET on the edge-cluster and obtain the payload and retain the
member_index of the existing members as returning in the GET output. For new member
additions, the member_index cannot be defined by the user, user can read the system
allocated index to the new member in the output of this API call or by doing a GET call.
User cannot use this PUT api to replace the transport_node of an existing member because
this is a disruption action, we have exposed a explicit API for doing so, refer to
"ReplaceEdgeClusterMemberTransportNode"
EdgeCluster only supports homogeneous members. The TransportNodes backed by EdgeNode are
only allowed in cluster members. DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these
EdgeNodes is recommended to be the same. EdgeCluster supports members of different
deployment types.

Request:

Method:

PUT

URI Path(s):

/api/v1/edge-clusters/{edge-cluster-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

EdgeCluster+

EdgeCluster (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource 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.	string	Readonly
_revision	Generation of this resource config 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
allocation_rules	Allocation rules for auto placement Set of allocation rules and respected action for auto placement of logical router, DHCP and MDProxy on edge cluster members.	array of AllocationRule
cluster_profile_bindings	Edge cluster profile bindings	array of ClusterProfileTypeIdEntry
deployment_type	Edge cluster deployment type 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.	EdgeDeploymentType	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_inter_site_forwarding	Flag to enable inter site forwarding 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.	boolean	Readonly
id	Unique identifier of this resource	string	Sortable
member_node_type	Node type of the cluster members 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.	EdgeClusterNodeType	Readonly
members	Edge cluster members 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.	array of EdgeClusterMember
node_rtep_ips	Remote tunnel endpoint ip address. List of remote tunnel endpoint ipaddress configured on edge cluster for each transport node.	array of NodeRtepIpsConfig	Readonly
resource_type	Must be set to the value EdgeCluster	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/edge-clusters/bf8d4daf-93f6-4c23-af38-63f6d372e14e { "resource_type": "EdgeCluster", "id": "ba009179-4cc7-40d0-9149-6242d2838bab", "display_name": "comp2-edge-cluster", "deployment_type": "VIRTUAL_MACHINE", "members": [ { "member_index": 0, "transport_node_id": "4fa0d456-627d-4b62-9bfe-585d585dab1a" } ], "cluster_profile_bindings": [ { "profile_id": "91bcaa06-47a1-11e4-8316-17ffc770799b", "resource_type": "EdgeHighAvailabilityProfile" } ], "_revision": 1 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

EdgeCluster+

EdgeCluster (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource 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.	string	Readonly
_revision	Generation of this resource config 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
allocation_rules	Allocation rules for auto placement Set of allocation rules and respected action for auto placement of logical router, DHCP and MDProxy on edge cluster members.	array of AllocationRule
cluster_profile_bindings	Edge cluster profile bindings	array of ClusterProfileTypeIdEntry
deployment_type	Edge cluster deployment type 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.	EdgeDeploymentType	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_inter_site_forwarding	Flag to enable inter site forwarding 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.	boolean	Readonly
id	Unique identifier of this resource	string	Sortable
member_node_type	Node type of the cluster members 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.	EdgeClusterNodeType	Readonly
members	Edge cluster members 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.	array of EdgeClusterMember
node_rtep_ips	Remote tunnel endpoint ip address. List of remote tunnel endpoint ipaddress configured on edge cluster for each transport node.	array of NodeRtepIpsConfig	Readonly
resource_type	Must be set to the value EdgeCluster	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "EdgeCluster", "id": "ba009179-4cc7-40d0-9149-6242d2838bab", "display_name": "comp2-edge-cluster", "deployment_type": "VIRTUAL_MACHINE", "members": [ { "member_index": 0, "transport_node_id": "4fa0d456-627d-4b62-9bfe-585d585dab1a" } ], "cluster_profile_bindings": [ { "profile_id": "91bcaa06-47a1-11e4-8316-17ffc770799b", "resource_type": "EdgeHighAvailabilityProfile" } ], "_last_modified_time": 1458858792864, "_create_time": 1457984401856, "_last_modified_user": "admin", "_system_owned": false, "_create_user": "admin", "_revision": 2 }

Update Edge Cluster

Request:

EdgeCluster (schema)

Example Request:

Successful Response:

EdgeCluster (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: