Update Edge Cluster

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 should be same.

Request
URI
PUT
https://nsxmanager.your.domain/api/v1/edge-clusters/{edge-cluster-id}
COPY
Path Parameters
string
edge-cluster-id
Required

edge-cluster-id

Request Body
EdgeCluster of type(s) application/json
Optional
This request body class requires all of the following: ManagedResource , InlineEdgeCluster1 
{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_revision": 0,
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_create_user": "string",
    "_protection": "string",
    "_create_time": 0,
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "member_node_type": "string",
    "cluster_profile_bindings": [
        {
            "profile_id": "string",
            "resource_type": "string"
        }
    ],
    "members": [
        {
            "member_index": 0,
            "display_name": "string",
            "description": "string",
            "transport_node_id": "string"
        }
    ],
    "deployment_type": "string"
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeCluster of type(s) application/json
This response body class contains all of the following: ManagedResource , InlineEdgeCluster1 
{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_revision": 0,
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_create_user": "string",
    "_protection": "string",
    "_create_time": 0,
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "member_node_type": "string",
    "cluster_profile_bindings": [
        {
            "profile_id": "string",
            "resource_type": "string"
        }
    ],
    "members": [
        {
            "member_index": 0,
            "display_name": "string",
            "description": "string",
            "transport_node_id": "string"
        }
    ],
    "deployment_type": "string"
}

400
Returns BadRequest of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


403
Returns Forbidden of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


404
Returns NotFound of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


412
Returns PreconditionFailed of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


500
Returns InternalServerError of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


503
Returns ServiceUnavailable of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


On This Page
Network Transport Operations
POST
Create Bridge Cluster
POST
Create Bridge Endpoint
POST
Create Bridge Endpoint Profile
POST
Create Cluster Profile
POST
Create Compute Collection Transport Node Template
POST
Create Edge Cluster
POST
Create Host Switch Profile
POST
Create Network Migration Spec
POST
Create Transport Node
POST
Create Transport Zone
POST
Create Transport Zone Profile
DELETE
Delete Bridge Cluster
DELETE
Delete Bridge Endpoint
DELETE
Delete Bridge Endpoint Profile
DELETE
Delete Cluster Profile
DELETE
Delete Compute Collection Transport Node Template
DELETE
Delete Edge Cluster
DELETE
Delete Host Switch Profile
DELETE
Delete Network Migration Spec
DELETE
Delete Transport Node
DELETE
Delete Transport Zone
DELETE
Delete Transport Zone Profile
GET
Get Bridge Cluster
GET
Get Bridge Cluster Status
GET
Get Bridge Endpoint
GET
Get Bridge Endpoint Profile
GET
Get Bridge Endpoint Statistics
GET
Get Bridge Endpoint Status
GET
Get Cluster Profile
GET
Get Compute Collection Transport Node Template
GET
Get Compute Collection Transport Node Template State
GET
Get Host Switch Profile
GET
Get Network Migration Spec
GET
Get Transport Node
GET
Get Transport Node State
GET
Get Transport Zone
GET
Get Transport Zone Profile
GET
Get Transport Zone Status
GET
List Bridge Clusters
GET
List Bridge Endpoint Profiles
GET
List Bridge Endpoints
GET
List Cluster Profiles
GET
List Compute Collection Transport Node Templates
GET
List Edge Clusters
GET
List Host Switch Profiles
GET
List Neighbor Properties
GET
List Network Migration Specs
GET
List Transport Nodes
GET
List Transport Nodes By State
GET
List Transport Zone Profiles
GET
List Transport Zones
GET
Read Edge Cluster
GET
Read Neighbor Properties
POST
Replace Edge Cluster Member Transport Node Replace Transport Node
POST
Resync Transport Node Resync Host Config
PUT
Update Bridge Cluster
PUT
Update Bridge Endpoint
PUT
Update Bridge Endpoint Profile
PUT
Update Cluster Profile
PUT
Update Compute Collection Transport Node Template
PUT
Update Edge Cluster
PUT
Update Host Switch Profile
PUT
Update Network Migration Spec
PUT
Update Transport Node
POST
Update Transport Node Maintenance Mode
PUT
Update Transport Zone
PUT
Update Transport Zone Profile