[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Get State
DescriptionReturns
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/state
Path Parameters
Path Parameters
string
tier-0-id
Required
Query Parameters
Query Parameters
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
enforcement_point_path
Optional
Enforcement point path
string
included_fields
Optional
Comma separated list of fields that should be included in query result
string
interface_path
Optional
Interface path for interface specific state such as IPv6 DAD state
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
boolean
sort_ascending
Optional
string
sort_by
Optional
Field by which records are sorted
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
Tier0GatewayState
of type(s) application/json
{
"enforcement_point_path": "string",
"ipv6_status": [
{
"dad_statuses": [
{
"ip_address": "string",
"status": "DUPLICATED",
"transport_node": [
{
"is_valid": false,
"target_display_name": "string",
"target_id": "string",
"target_type": "string"
}
]
}
],
"interface_id": "string"
}
],
"tier0_state": {
"details": [
{
"failure_code": 0,
"failure_message": "string",
"state": "in_progress",
"sub_system_address": "string",
"sub_system_id": "string",
"sub_system_type": "string"
}
],
"failure_code": 0,
"failure_message": "string",
"state": "pending"
},
"tier0_status": {
"last_update_timestamp": 0,
"logical_router_id": "string",
"per_node_status": [
{
"high_availability_status": "ACTIVE",
"service_router_id": "string",
"transport_node_id": "string"
}
]
}
}
string
enforcement_point_path
Optional
String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
404
Not Found
ApiError
412
Precondition Failed
ApiError
500
Internal Server Error
ApiError
503
Service Unavailable
Code Samples
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/state
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get-state
x-vmw-nsx-module: PolicyConnectivityStatistics
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 0s Operations
get
