Get Fabric Node State

Get Fabric Node State

For edge nodes, returns the current install state when deployment is in progress, NODE_READY when deployment is complete and the failure state when deployment has failed.

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

node-id

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ConfigurationState of type(s) application/json 
{
    "state": "string",
    "details": [
        {
            "sub_system_address": "string",
            "state": "string",
            "sub_system_type": "string",
            "failure_message": "string",
            "failure_code": 0,
            "sub_system_id": "string"
        }
    ],
    "failure_code": 0,
    "failure_message": "string"
}
string
state
Optional

Gives details of state of desired configuration

Possible values are : pending, in_progress, success, failed, partial_success, orphaned, unknown,
array of ConfigurationStateElement
details
Optional

Array of configuration state of various sub systems

integer As int64 As int64
failure_code
Optional

Error code

string
failure_message
Optional

Error message in case of failure


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

Not Found

Operation doesn't return any data structure

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

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


On This Page
Fabric Operations
POST
Add Compute Manager
POST
Add Node
POST
Create Compute Collection Fabric Template
DELETE
Delete Compute Collection Fabric Template
DELETE
Delete Compute Manager
DELETE
Delete Node
GET
Get Compute Collection Fabric Template
GET
Get Compute Manager State
GET
Get Fabric Node Modules
GET
Get Fabric Node State
POST
Host Prep Discovered Node Hostprep
GET
List Compute Collection Fabric Templates
GET
List Compute Collections
GET
List Compute Managers
GET
List Discovered Nodes
GET
List Fabric Node Interfaces
GET
List Node Capabilities
GET
List Nodes
GET
List Vifs
GET
List Virtual Machines
POST
Perform Host Node Upgrade Action Upgrade Infra
POST
Perform Node Action
GET
Read Compute Collection
GET
Read Compute Manager
GET
Read Compute Manager Status
GET
Read Discovered Node
GET
Read Fabric Node Interface
GET
Read Fabric Node Interface Statistics
GET
Read Node
GET
Read Nodes Status
GET
Read Node Status
POST
Restart Inventory Sync Restart Inventory Sync
PUT
Update Compute Collection Fabric Template
PUT
Update Compute Manager
PUT
Update Node
POST
Update Virtual Machine Tags Update Tags