NSX-T Data Center REST API

Join this node to a NSX Cluster

Request:

Method:

POST

URI Path(s):

/api/v1/cluster?action=join_cluster

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

JoinClusterParameters+

JoinClusterParameters (schema)

Name	Description	Type	Notes
certficate_sha256_thumbprint	SHA256 Thumbprint of the API certificate of the cluster node	string	Required
cluster_id	UUID of the cluster to join	string	Required
ip_address	IP address of a node already part of the cluster to join	string	Required
password	Password of the user on the cluster node	string
port	API port on the cluster node	integer	Minimum: 1 Maximum: 65535 Default: "443"
token	Limited time OAuth token instead of the username/password	string
username	Username on the cluster node	string

Example Request:

POST https://<nsx-mgr>/api/v1/cluster?action=join_cluster { "cluster_id": "066a0a85-9bd9-483d-8622-936aa9dffdbe", "ip_address": "10.145.162.255", "username": "admin", "password": "password1", "certficate_sha256_thumbprint": "f656452785a13d8e1431984a0a5137f1e27cdfa43e1cb08f46051a66733ca1b8" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ClusterConfiguration+

ClusterConfiguration (schema)

Name	Description	Type	Notes
cluster_id	UUID of the cluster	string	Readonly
config_version	Cluster configuration version	integer	Readonly
nodes	Nodes in the cluster configuration	array of ClusterNode	Readonly

Required Permissions:

crud

Feature:

cluster_management

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable