JoinClusterParameters (schema)

Parameters needed for this node to join the NSX cluster

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.
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