NSX-T Data Center REST API

Get a Policy Edge Cluster State info under an Enforcement Point

Returns information about the current state of the edge cluster.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/state

Request Headers:

n/a

Query Parameters:

RealizationStateQueryParameters+

Name	Description	Type	Notes
barrier_id	The system checks to ensure that the logical entity is realized or not at least at the given barrier number. This parameter has been deprecated. Please use request_id instead.	integer	Deprecated Minimum: 0
request_id	Realization request ID Passing a request_id allows you to check if the changes to a logical entity made in a particular API request have been realized or not. The request_id is returned from each API request in the X-NSX-REQUESTID header. For example, to check if a change to a firewall rule has been realized, save the X-NSX-REQUESTID header value returned from the PUT /api/v1/firewall/sections//rules/ call, then add ?request_id= to the GET /api/v1/firewall/rules//state API call.	string

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-clusters/my-edge-cluster-id/state

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyEdgeClusterState+

PolicyEdgeClusterState (schema)

Name	Description	Type	Notes
details	Array of configuration state of various sub systems	array of PolicyEdgeClusterMemberState	Readonly
edge_cluster_name	Display name of the edge cluster Display name of the edge cluster whose status is being reported.	string	Readonly
failure_code	Error code	integer	Readonly
failure_message	Error message in case of failure	string	Readonly
pending_change_list	List of pending changes Request identifier of the API which modified the entity.	array of string	Readonly
state	Overall state of desired configuration Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. "in_sync" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to "success". Please note, failed state is deprecated.	string	Required Readonly Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown, error, in_sync, NOT_AVAILABLE, VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, VM_DEPLOYMENT_FAILED, VM_POWER_ON_IN_PROGRESS, VM_POWER_ON_FAILED, REGISTRATION_PENDING, NODE_NOT_READY, NODE_READY, VM_POWER_OFF_IN_PROGRESS, VM_POWER_OFF_FAILED, VM_UNDEPLOY_IN_PROGRESS, VM_UNDEPLOY_FAILED, VM_UNDEPLOY_SUCCESSFUL, EDGE_CONFIG_ERROR, VM_DEPLOYMENT_RESTARTED, REGISTRATION_FAILED, TRANSPORT_NODE_SYNC_PENDING, TRANSPORT_NODE_CONFIGURATION_MISSING, EDGE_HARDWARE_NOT_SUPPORTED, MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED, TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER, VC_VCP_ACTION_PENDING, VC_VCP_ACTION_FAILED, TZ_ENDPOINTS_NOT_SPECIFIED, NO_PNIC_PREPARED_IN_EDGE, APPLIANCE_INTERNAL_ERROR, VTEP_DHCP_NOT_SUPPORTED, UNSUPPORTED_HOST_SWITCH_PROFILE, UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED, HOSTSWITCH_PROFILE_NOT_FOUND, LLDP_SEND_ENABLED_NOT_SUPPORTED, UNSUPPORTED_NAMED_TEAMING_POLICY, LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM, LACP_NOT_SUPPORTED_FOR_EDGE_VM, STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM, MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE, UNSUPPORTED_LACP_LB_ALGO_FOR_NODE, EDGE_NODE_VERSION_NOT_SUPPORTED, NO_PNIC_SPECIFIED_IN_TN, INVALID_PNIC_DEVICE_NAME, TRANSPORT_NODE_READY, VM_NETWORK_EDIT_PENDING, UNSUPPORTED_DEFAULT_TEAMING_POLICY, MPA_DISCONNECTED, VM_RENAME_PENDING, VM_CONFIG_EDIT_PENDING, VM_NETWORK_EDIT_FAILED, VM_RENAME_FAILED, VM_CONFIG_EDIT_FAILED, VM_CONFIG_DISCREPANCY, VM_NODE_REFRESH_FAILED, VM_PLACEMENT_REFRESH_FAILED, REGISTRATION_TIMEDOUT, REPLACE_FAILED, UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED, LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING, DELETE_VM_IN_REDEPLOY_FAILED, DEPLOY_VM_IN_REDEPLOY_FAILED, INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE, VM_RESOURCE_RESERVATION_FAILED, DUPLICATE_PNICS_IN_TEAMINGS_WITH_MULTIPLE_UPLINKS_AND_FAILOVER_ORDER, DUPLICATE_VLANS_SHARING_SAME_PNICMULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING, EDGE_NODE_SETTINGS_MISMATCH_RESOLVE, EDGE_VM_VSPHERE_SETTINGS_MISMATCH_RESOLVE, EDGE_NODE_SETTINGS_AND_VSPHERE_SETTINGS_ARE_CHANGED_RESOLVE, EDGE_VSPHERE_LOCATION_MISMATCH_RESOLVE, COMPUTE_MANAGER_NOT_FOUND, DELETE_IN_PROGRESS, ADVANCED_CONFIG_EDIT_FAILED, UPT_MODE_REALIZATION_POLL_TIMED_OUT, DATAPATH_CONFIGURATION_EDIT_FAILED, MAINTENANCE_MODE_ENABLED, ERROR_IN_ENABLE_MAINTENANCE_MODE, ERROR_IN_DISABLE_MAINTENANCE_MODE, CONFIGURE_UPT_ON_VM_FAILED, VM_VERSION_IS_UPT_INCOMPATIBLE, DELETE_FAILED_FOR_DIFFERENT_MOREF_ID, DELETE_FAILED_ON_VM_NOT_FOUND, DELETE_FAILED_FOR_NON_LCM_EDGE, ADVANCED_CONFIG_EDIT_PENDING, DUPLICATE_VLANS_SHARING_SAME_PNIC, MULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING, REDEPLOY_ACTIVITY_FAILED, REDEPLOY_ACTIVITY_IN_PROGRESS, REDEPLOY_ACTIVITY_SCHEDULED, REDEPLOY_ACTIVITY_SUCCESSFUL, REPLACE_ACTIVITY_FAILED, REPLACE_ACTIVITY_IN_PROGRESS, REPLACE_ACTIVITY_SCHEDULED, REPLACE_ACTIVITY_SUCCESSFUL, REPLACED_RPC_CLIENT_OF_TN, RETRYING_REPLACE, UNABLE_TO_DELETE_EDGE_NODE_VM_INTERNAL_ERROR, VM_REDEPLOY_FAILED, VM_RESOURCE_RESERVATION_EDIT_PENDING, REDEPLOYED_VM_REGISTRATION_PENDING

Example Response:

Example 1: ---------- # Below Example for policy api created edge cluster GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-clusters/my-edge-cluster-id/state { "edge_cluster_name": "my-edge-cluster-id", "state": "unknown", "details": [ { "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/my-edge-tn-id", "policy_edge_node_path": "/infra/sites/default/enforcement-points/nsxt-ep/edge-clusters/ec/edge-nodes/en-1", "state": "in_sync" }, { "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/7c0733a6-8e40-4c22-9199-dda7f4813ae1", "policy_edge_node_path": "/infra/sites/default/enforcement-points/nsxt-ep/edge-clusters/ec/edge-nodes/en", "state": "unknown" } ], "failure_message": "Unable to collect status for '2' transport nodes." } Example 2: ---------- # Below Example for mp api created edge cluster GET https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-clusters/8511f1ff-240c-4ca6-b070-e18ef8e69653/state { "edge_cluster_name": "EDGECLUSTER1", "details": [ { "policy_edge_node_path": "/infra/sites/default/enforcement-points/default/edge-clusters/8511f1ff-240c-4ca6-b070-e18ef8e69653/edge-nodes/0", "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/17365d30-0782-11ef-b9db-020017197055", "state": "in_sync" }, { "policy_edge_node_path": "/infra/sites/default/enforcement-points/default/edge-clusters/8511f1ff-240c-4ca6-b070-e18ef8e69653/edge-nodes/1", "edge_transport_node_path": "/infra/sites/default/enforcement-points/default/edge-transport-nodes/1a1a61cc-0782-11ef-a114-020017606fb0", "state": "in_sync" } ], "state": "in_sync" }

NSX-T Data Center REST API

Get a Policy Edge Cluster State info under an Enforcement Point

Request:

RealizationStateQueryParameters (schema)

Example Request:

Successful Response:

PolicyEdgeClusterState (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: