NSX-T Data Center REST API

Get policy Tunnel(GRE as of now) status for given tunnel-id

Get policy Tunnel(GRE as of now) status for given tunnel-id This API is only available when using VMware NSX.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/status

Request Headers:

n/a

Query Parameters:

L2L3RuntimeRequestParameters+

L2L3RuntimeRequestParameters (schema)

Name	Description	Type	Notes
bgp_neighbor_type	Bgp neighbor type Bgp neighbor type that can be used as filter for T0 bgp neighbor status filter.	string	Enum: INTER_SR, USER
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
edge_path	Policy path of edge node Policy path of edge node. Edge should be member of enforcement point.	string
enforcement_point_path	String Path of the enforcement point Enforcement point path.	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
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
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
source	Source of statistics data The data source can be either realtime or cached. If not provided, cached data is returned.	DataSourceType	Experimental
stats_type	Segment statistics type This indicates the type of statistics being requested. We support statistics from the data plane.	string	Experimental Enum: DATAPATH_STATS
transport_node_id	Transport Node Id Identifer of the transport node. This is a UUID.	string	Experimental

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

GreTunnelStatus+

GreTunnelStatus (schema)

Name	Description	Type	Notes
destination	Tunnel destination address Tunnel destination address	IPAddress	Readonly
endpoint_status_per_edge_node		array of GreTunnelEndpointStatusPerEdgeNode	Readonly Minimum items: 1 Maximum items: 8
resource_type	Must be set to the value GreTunnelStatus	string	Required Enum: GreTunnelStatus

TunnelStatus+

TunnelStatus (schema)

Name	Description	Type	Notes
resource_type	resource type Indicates Resource type of TunnelStatus, GreTunnelStatus - Resource type as GreTunnelStatus will be used to populate P2P GRE Tunnel status	string	Required Enum: GreTunnelStatus

Example Response:

{ "destination": "44.44.44.10", "endpoint_status_per_edge_node": [ { "last_update_timestamp": 1689829155850, "source": "40.40.40.1", "tunnel_port_id": "4aaaf496-e99d-41f6-8d67-f9a919210eb6", "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/0", "runtime_status": "UP", "tunnel_up_count": 0, "tunnel_last_up_time": 0, "tunnel_down_count": 0, "tunnel_last_down_time": 0, "keepalive_status": "KEEPALIVE_STATUS_DISABLED", "keepalive_interval": 10, "keepalive_dead_multiplier": 3, "keepalive_tx_count": 0, "keepalive_last_tx_time": 0, "keepalive_rx_count": 0, "keepalive_last_rx_time": 0, "keepalive_ack": "KEEPALIVE_STATUS_ENABLED", "keepalive_ack_sent_count": 0, "keepalive_last_ack_time": 0, "keepalive_admin_state": "DISABLED" }, { "last_update_timestamp": 1689829155915, "source": "40.40.40.2", "tunnel_port_id": "418c4d6f-9061-4460-b374-f9a7a74c94de", "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/1", "runtime_status": "UP", "tunnel_up_count": 0, "tunnel_last_up_time": 0, "tunnel_down_count": 0, "tunnel_last_down_time": 0, "keepalive_status": "KEEPALIVE_STATUS_DISABLED", "keepalive_interval": 10, "keepalive_dead_multiplier": 3, "keepalive_tx_count": 0, "keepalive_last_tx_time": 0, "keepalive_rx_count": 0, "keepalive_last_rx_time": 0, "keepalive_ack": "KEEPALIVE_STATUS_ENABLED", "keepalive_ack_sent_count": 0, "keepalive_last_ack_time": 0, "keepalive_admin_state": "DISABLED" } ], "resource_type": "TUNNEL" }

Required Permissions:

read

Feature:

policy_t0

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable