Add Cluster Node VM | NSX-T Data Center REST API

Add Cluster Node VM

Deploys a cluster node VM as specified by the deployment config. Once the VM is deployed, if its role is that of a controller node, it will automatically register itself with the Manager that deployed it.

Request

URI

POST

https://nsxmanager.your.domain/api/v1/cluster/nodes/deployments

COPY

Request Body

AddClusterNodeVMInfo of type(s) application/json

Required

{
    "deployment_requests": [
        {
            "deployment_config": {
                "placement_type": "string"
            },
            "vm_id": "string",
            "user_settings": {
                "cli_username": "string",
                "audit_username": "string",
                "root_password": "string",
                "cli_password": "string",
                "audit_password": "string"
            },
            "roles": [
                "string"
            ],
            "form_factor": "string"
        }
    ],
    "clustering_config": {
        "clustering_type": "string"
    }
}

array of ClusterNodeVMDeploymentRequest

deployment_requests

Required

Cluster node VM deployment requests to be deployed by the Manager.

ClusteringConfig

clustering_config

Required

clustering_config

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

201

Created

Returns ClusterNodeVMDeploymentRequestList of type(s) application/json

This response body class contains all of the following: ListResult , InlineClusterNodeVMDeploymentRequestList1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "deployment_config": {
                "placement_type": "string"
            },
            "vm_id": "string",
            "user_settings": {
                "cli_username": "string",
                "audit_username": "string",
                "root_password": "string",
                "cli_password": "string",
                "audit_password": "string"
            },
            "roles": [
                "string"
            ],
            "form_factor": "string"
        }
    ]
}

400

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

403

Returns Forbidden of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

404

Returns NotFound of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

412

Returns PreconditionFailed of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

500

Returns InternalServerError of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

503

Returns ServiceUnavailable of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error