[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Get State

Description

Returns

Request

Request

URL

URL


get
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/state
Copy

Path Parameters

Path Parameters

string
tier-1-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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns Tier1GatewayState 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"
		}
	],
	"tier1_state": {},
	"tier1_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.


array of IPv6Status
ipv6_status Optional

IPv6 DAD status for interfaces configured on Tier1


tier1_state Optional

Detailed realized state information for Tier1


tier1_status Optional

Detailed realized status information for Tier1

Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-GetTier1State -tier1Id -cursor -enforcementPointPath -includedFields -interfacePath -pageSize -sortAscending -sortBy -type

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/state
Vendor Extensions

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
Feedback

Was this page helpful?