Add a controller to the cluster (Deprecated)

Add a new controller to the NSX cluster.
Deprecated. Use POST /cluster?action=join_cluster to join a node to cluster.
The controller comes with the new node.

Request:

Method:

POST

URI Path(s):

/api/v1/cluster/nodes

Request Headers:

n/a

Query Parameters:

AddClusterNodeAction+

Name	Description	Type	Notes
action		string	Required Enum: add_cluster_node

Request Body:

AddClusterNodeSpec+

Name	Description	Type
controller_role_config		AddControllerNodeSpec
display_name	Display name for the node	string
external_id	External identifier of the node	string
mgr_role_config		AddManagementNodeSpec

Example Request:

Controller Node POST https://<nsx-mgr>/api/v1/cluster/nodes?action=add_cluster_node { "external_id": "4c539859-1451-439a-a920-f64492863b16", "controller_role_config": { "type": "AddControllerNodeSpec", "host_msg_client_info": { "shared_secret": "secret1" }, "mpa_msg_client_info": { "shared_secret": "secret1" } } }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

ClusterNodeConfig+

ClusterNodeConfig (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
appliance_mgmt_listen_addr	The IP and port for the appliance management API service on this node	string	Readonly
controller_role		ControllerClusterRoleConfig
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
external_id	Internal identifier provided by the node	string	Readonly
id	Unique identifier of this resource	string	Sortable
manager_role		ManagementClusterRoleConfig
resource_type	Must be set to the value ClusterNodeConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

Controller Node { "_revision": 0, "id": "7e36956a-85c4-4c3e-a883-8d26592146f1", "resource_type": "ClusterNodeConfig", "external_id": "4c539859-1451-439a-a920-f64492863b16", "controller_role": { "type": "ControllerClusterRoleConfig", "host_msg_client_info": { "account_name": "cvn-ccp-7e36956a-85c4-4c3e-a883-8d26592146f1" }, "mpa_msg_client_info": { "account_name": "cvn-ccp-mpa-abcdef12-85c4-4c3e-a883-8d26592146f1" }, "control_cluster_listen_addr": { "port": 0 }, "control_plane_listen_addr": { "port": 0 } }, "_create_time": 1416221408704, "_create_user": "system", "_last_modified_user": "system", "_last_modified_time": 1416221408704 }

Add a controller to the cluster (Deprecated)

Request:

AddClusterNodeAction (schema)

AddClusterNodeSpec (schema)

Example Request:

Successful Response:

ClusterNodeConfig (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: