Get Tier1 state

Returns

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tier-1s/{tier-1-id}/state
/policy/api/v1/global-infra/tier-1s/{tier-1-id}/state
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/state

Request Headers:

n/a

Query Parameters:

Tier1StateRequestParameters+

Tier1StateRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
interface_path	Interface path for interface specific state such as IPv6 DAD state String Path of interface on current Tier1 gateway for interface specified state such as IPv6 DAD state. When not specified, IPv6 NDRA state from from all interfaces is returned.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
type	Returns specific information based on the value specified. Returns specific information based on the value specified. When not specified response include gateway state, status and DAD status from interfaces.	string	Enum: GATEWAY_STATE, GATEWAY_STATUS, IPV6_STATUS

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/cgw/state

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

Tier1GatewayState+

Name	Description	Type
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.	string
ipv6_status	IPv6 DAD status for Tier1 interfaces IPv6 DAD status for interfaces configured on Tier1	array of IPv6Status
tier1_state	Tier1 state Detailed realized state information for Tier1	LogicalRouterState
tier1_status	Tier1 status Detailed realized status information for Tier1	LogicalRouterStatus
transport_zone	Transport Zone Information Transport Zone information which got configured on Gateway.	PolicyTransportZone

Example Response:

{ "tier1_state": { "state": "in_sync", "details": [ { "sub_system_id": "9d09f56c-6bd2-11e9-ac02-000c294188d6", "sub_system_type": "TransportNode", "state": "in_sync" }, { "sub_system_id": "96e40830-6bd2-11e9-a190-000c2985db32", "sub_system_type": "TransportNode", "state": "in_sync" } ] }, "tier1_status": { "logical_router_id": "db481db6-2759-4769-b6f4-71cef0b5ef07", "last_update_timestamp": 1557467728692, "per_node_status": [ { "transport_node_id": "9d09f56c-6bd2-11e9-ac02-000c294188d6", "service_router_id": "6456b7c0-a50f-46cb-86e2-4094812bdd6d", "high_availability_status": "STANDBY" }, { "transport_node_id": "96e40830-6bd2-11e9-a190-000c2985db32", "service_router_id": "c4ac6edb-bca7-45ba-b888-29594201f15c", "high_availability_status": "ACTIVE" } ] }, "ipv6_status": [ { "interface_id": "/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-197/interfaces/1-policyconnectivity-350", "dad_statuses": [] }, { "interface_id": "/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-197/interfaces/1-policyconnectivity-270", "dad_statuses": [] }, { "interface_id": "/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-197/interfaces/1-policyconnectivity-185", "dad_statuses": [ { "ip_address": "fe80::50:56ff:fe56:4452", "status": "NOT_APPLICABLE" }, { "ip_address": "fcf8:9c18:67c6::1", "status": "NOT_APPLICABLE" } ] }, { "interface_id": "/infra/tier-0s/pepsi/locale-services/1-policyconnectivity-197/interfaces/1-policyconnectivity-12", "dad_statuses": [ { "ip_address": "fe80::50:56ff:fe56:4452", "status": "NOT_APPLICABLE" }, { "ip_address": "fcf8:9c18:67c6:1::1", "status": "NOT_APPLICABLE" } ] } ] }

Get Tier1 state

Request:

Tier1StateRequestParameters (schema)

Example Request:

Successful Response:

Tier1GatewayState (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: