Read Cluster Node VM Deployment Request

Read Cluster Node VM Deployment Request

Returns deployment request information for a specific attempted deployment of a cluster node VM.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/cluster/nodes/deployments/{node-id}
COPY
Path Parameters
string
node-id
Required

node-id

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ClusterNodeVMDeploymentRequest of type(s) application/json 
{
    "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"
}
ClusterNodeVMDeploymentConfig
deployment_config
Required

deployment_config

string
vm_id
Optional

ID of the VM maintained internally and used to recognize it. Note: This is automatically generated and cannot be modified.

NodeUserSettings
user_settings
Optional

user_settings

array of string
roles
Required

List of cluster node role (or roles) which the VM should take on. They specify what type (or types) of cluster node which the new VM should act as.

Possible values are : CONTROLLER, MANAGER,
string
form_factor
Optional

Specifies the desired "size" of the VM Note: MEDIUM is currently the only supported size for controllers.

Possible values are : SMALL, MEDIUM, MEDIUM_LARGE, LARGE,

400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page
Cluster Operations
POST
Add Cluster Node VM
POST
Delete Auto Deployed Cluster Node VM Delete
GET
Get Repo Sync Status
GET
List Cluster Node VM Deployment Requests
POST
Perform Repo Sync Repo Sync
GET
Read Cluster Node VM Deployment Request
GET
Read Cluster Node VM Deployment Status