JoinClusterParameters

To join a new node to the NSX cluster, issue a JoinCluster API on the new node. The JoinCluster API takes this object as a parameter. Provide the ID of the NSX cluster you want the new node to join and the IP address of one of the nodes already in that cluster. The Cluster Boot Manager running on the new node will then add the new node to the NSX cluster by making a AttachClusterNode REST API call on the node that is already part of the cluster. In order to make a REST API call to the node in the cluster, the Cluster Boot Manager will need username and password of a priviledged user on the node in the cluster. In place of a username and password, Cluster Boot Manager could also use a OAuth token provided. The Cluster Boot Manager needs either the username and password or the OAuth token to make the REST call but not both.

JSON Example

{
    "certficate_sha256_thumbprint": "string",
    "certificate_sha256_thumbprint": "string",
    "cluster_id": "string",
    "ip_address": "string",
    "password": "string",
    "port": 0,
    "token": "string",
    "username": "string"
}

string

certficate_sha256_thumbprint

Optional

SHA256 Thumbprint of the API certificate of the cluster node.

string

certificate_sha256_thumbprint

Optional

SHA256 Thumbprint of the API certificate of the cluster node.

string

cluster_id

Required

UUID of the cluster to join.

string

ip_address

Required

IP address of a node already part of the cluster to join.

string

password

Optional

Password of the user on the cluster node.

integer As int64 As int64

port

Optional

Constraints: minimum: 1 maximum: 65535 default: 443

API port on the cluster node.

string

token

Optional

Limited time OAuth token instead of the username/password.

string

username

Optional

Username on the cluster node.

Parameter To

Join Cluster