Add Cluster Node

Add Cluster Node

Adds a new management node or controller node to the NSX cluster. A single node can perform one role, either management or control, not both.

Request
URI
POST
https://nsxmanager.your.domain/api/v1/cluster/nodes
COPY
Query Parameters
string
action
Required

action

Request Body
AddClusterNodeSpec of type(s) application/json
Required 
{
    "external_id": "string",
    "controller_role_config": {
        "mpa_msg_client_info": {
            "account_name": "string",
            "certificate": "string",
            "shared_secret": "string"
        },
        "host_msg_client_info": {
            "account_name": "string",
            "certificate": "string",
            "shared_secret": "string"
        },
        "control_plane_server_certificate": "string",
        "type": "string"
    },
    "display_name": "string",
    "mgr_role_config": {
        "mpa_msg_client_info": {
            "account_name": "string",
            "certificate": "string",
            "shared_secret": "string"
        },
        "type": "string",
        "password": "string",
        "user_name": "string",
        "remote_address": "string",
        "cert_thumbprint": "string"
    }
}
string
external_id
Optional

external_id

AddControllerNodeSpec
controller_role_config
Optional

controller_role_config

string
display_name
Optional

display_name

AddManagementNodeSpec
mgr_role_config
Optional

mgr_role_config

Authentication
This operation uses the following authentication methods.
Responses
201

Resource created successfully

Returns ClusterNodeConfig of type(s) application/json
This response body class contains all of the following: ManagedResource , InlineClusterNodeConfig1 
{
    "_self": {
        "rel": "string"
    },
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_revision": 0,
    "_create_user": "string",
    "_schema": "string",
    "_create_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "manager_role": {
        "mgmt_cluster_listen_addr": {
            "certificate_sha256_thumbprint": "string",
            "ip_address": "string",
            "port": 0,
            "certificate": "string"
        },
        "mpa_msg_client_info": {
            "account_name": "string",
            "certificate": "string",
            "shared_secret": "string"
        },
        "api_listen_addr": {
            "certificate_sha256_thumbprint": "string",
            "ip_address": "string",
            "port": 0,
            "certificate": "string"
        },
        "mgmt_plane_listen_addr": {
            "certificate_sha256_thumbprint": "string",
            "ip_address": "string",
            "port": 0,
            "certificate": "string"
        }
    },
    "controller_role": {
        "mpa_msg_client_info": {
            "account_name": "string",
            "certificate": "string",
            "shared_secret": "string"
        },
        "host_msg_client_info": {
            "account_name": "string",
            "certificate": "string",
            "shared_secret": "string"
        },
        "control_plane_listen_addr": {
            "certificate_sha256_thumbprint": "string",
            "ip_address": "string",
            "port": 0,
            "certificate": "string"
        },
        "control_cluster_listen_addr": {
            "certificate_sha256_thumbprint": "string",
            "ip_address": "string",
            "port": 0,
            "certificate": "string"
        }
    },
    "external_id": "string",
    "appliance_mgmt_listen_addr": "string"
}

default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Nsx Component Administration Operations
POST
Add Certificate
POST
Add Cluster Node
POST
Add Crl
POST
Cancel Task
POST
Collect Support Bundles
POST
Copy From Remote File
POST
Copy To Remote File
POST
Create Appliance Management Service Action
POST
Create File
POST
Create Node Network Route
POST
Create NSX Message Bus Service Action
POST
Create NSX Message Bus Service Action
POST
Create NSX Message Bus Service Action
POST
Create Nsx Upgrade Agent Service Action
POST
Create Nsx Upgrade Agent Service Action
POST
Create Nsx Upgrade Agent Service Action
POST
Create NTP Service Action
POST
Create NTP Service Action
POST
Create NTP Service Action
POST
Create Proton Service Action
POST
Create Proton Service Action
POST
Create Proton Service Action
POST
Create Proxy Service Action
POST
Create Proxy Service Action
POST
Create Proxy Service Action
POST
Create Proxy Service Apply Certificate Action
POST
Create Rabbit MQ Service Action
POST
Create Rabbit MQ Service Action
POST
Create Rabbit MQ Service Action
POST
Create Remote Directory
POST
Create Repository Service Action
POST
Create Repository Service Action
POST
Create Repository Service Action
POST
Create SNMP Service Action
POST
Create SNMP Service Action
POST
Create SNMP Service Action
POST
Create SSH Service Action
POST
Create SSH Service Action
POST
Create SSH Service Action
POST
Create SSH Service Remove Host Fingerprint Action
POST
Create Syslog Service Action
POST
Create Syslog Service Action
POST
Create Syslog Service Action
DELETE
Delete Certificate
DELETE
Delete Cluster Node Config
DELETE
Delete Crl
DELETE
Delete Csr
DELETE
Delete File
DELETE
Delete Node Network Route
DELETE
Delete Node Syslog Exporter
DELETE
Delete Task
POST
Generate Csr
GET
Get Certificate
GET
Get Certificates
GET
Get Crl
GET
Get Crls
GET
Get Csr
GET
Get Csr Pem
GET
Get Csrs
GET
Get Node Mandatory Access Control
GET
Get Node Mandatory Access Control Report
GET
Get Trust Objects
POST
Import Certificate
GET
List Cluster Node Configs
GET
List Cluster Node Interfaces
GET
List Files
GET
List Node Interfaces
GET
List Node Network Routes
GET
List Node Processes
GET
List Node Services
GET
List Node Syslog Exporters
GET
List Node Users
POST
Post Node Syslog Exporter
GET
Read Appliance Management Service
GET
Read Appliance Management Service Status
GET
Read Asnyc Task Response
GET
Read Cluster Config
GET
Read Cluster Node Config
GET
Read Cluster Node Interface
GET
Read Cluster Node Interface Statistics
GET
Read Cluster Nodes Aggregate Status
GET
Read Cluster Node Status
GET
Read Cluster Status
GET
Read File
GET
Read File Properties
GET
Read File Thumbprint
GET
Read Network Interface Statistics
GET
Read Network Properties
GET
Read Node Interface
GET
Read Node Name Servers
GET
Read Node Network Route
GET
Read Node Process
GET
Read Node Properties
GET
Read Node Search Domains
GET
Read Node Support Bundle
GET
Read Node Syslog Exporter
GET
Read Node User
GET
Read NSX Message Bus Service
GET
Read NSX Message Bus Service Status
GET
Read Nsx Upgrade Agent Service
GET
Read Nsx Upgrade Agent Service Status
GET
Read NTP Service
GET
Read NTP Service Status
GET
Read Proton Service
GET
Read Proton Service Status
GET
Read Proxy Service
GET
Read Proxy Service Status
GET
Read Rabbit MQ Service
GET
Read Rabbit MQ Service Status
GET
Read Repository Service
GET
Read Repository Service Status
GET
Read SNMP Service
GET
Read SNMP Service Status
GET
Read SSH Service
GET
Read SSH Service Status
GET
Read Syslog Service
GET
Read Syslog Service Status
POST
Reset Proton Service Logging Level Action
POST
Restart Or Shutdown Node
POST
Restart Or Shutdown Node
POST
Revoke Missing Cluster Node Config
POST
Self Sign Certificate
PUT
Set Node Mandatory Access Control
PUT
Update Crl
PUT
Update File
PUT
Update Node Interface
PUT
Update Node Name Servers
PUT
Update Node Properties
PUT
Update Node Search Domains
PUT
Update Node User
PUT
Update NTP Service
PUT
Update Proton Service
PUT
Update Proxy Service
PUT
Update Repository Service
PUT
Update SNMP Service
PUT
Update SSH Service
POST
Upload CA Signed Cert