REST API - update

vcenter nsx edge clusters: update

Update NSX Edge capabilities of an existing NSX Edge cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/api/vcenter/nsx/edge-clusters/{cluster}

?action=update

{
    "edge_nodes_to_add" : [
        {
            "password" : "secret string",
            "hostname" : "string",
            "datastore" : "obj-103",
            "name" : "string",
            "management_ip_address" : "string"
        },
        {
            "password" : "secret string",
            "hostname" : "string",
            "datastore" : "obj-103",
            "name" : "string",
            "management_ip_address" : "string"
        }
    ]
}

Path Parameters

Name	Type	Description
Required
cluster	string	Identifier for the compute resource associated with the NSX Edge node(s).

Body Parameters:

Name	Type	Description
bold = required
-	edge_cluster_update_spec	Specification for updating the NSX Edge node(s) on the NSX Edge cluster.
-.edge_nodes_to_add	node_spec[]	List of specifications for the NSX Edge node(s) to be added to the existing NSX Edge cluster. If present, this list must have two elements. 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. Optional. If unset, no NSX edge node(s) will be added to the cluster.
-.edge_nodes_to_add[].name	string	Name of the virtual machine for the NSX Edge node. 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. Optional. This field is currently required. It is optional for future development.
-.edge_nodes_to_add[].password	secret	Password of the virtual machine for the NSX Edge node. 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. Optional. This field is currently required. It is optional for future development.
-.edge_nodes_to_add[].hostname	string	A fully qualified domain name (FQDN) for the NSX Edge node. 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. Optional. This field is currently required. It is optional for future development.
-.edge_nodes_to_add[].management_ip_address	string	IP address for the interface on the management network. 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.
-.edge_nodes_to_add[].datastore	string	Identifier for the datastore associated with the NSX Edge node. 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: `Datastore`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore`.

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

Errors:

HTTP Status Code	Type	Description
400	invalid_argument	if `spec` contain any errors.
400	not_allowed_in_current_state	if NSX Edge capabilities are not currently enabled on this vSphere cluster or another conflicting operation is in progress.
404	not_found	if vcenter.nsx.node_spec.datastore or `cluster` could not be located.
400	already_exists	if a VM with name vcenter.nsx.node_spec.name already exists in the datacenter.
400	unsupported	if the cluster has DRS disabled.
500	error	if the system reports an error while responding to the request.