Get Fabric Node State

Get Fabric Node State

Get the Realized State of a Fabric Node

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

Success

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,
array of ConfigurationStateElement
details
Optional

details

integer As int64 As int64
failure_code
Optional

failure_code

string
failure_message
Optional

failure_message


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
Fabric Operations
POST
Add Node
DELETE
Delete Node
GET
Get Fabric Node Modules
GET
Get Fabric Node State
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
POST
Perform Node Action
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
PUT
Update Node
POST
Update Virtual Machine Tags