Tunnel properties

This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/tunnels/<tunnel-name>

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/TN1/tunnels/stt3232299620

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TunnelProperties+

TunnelProperties (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
bfd	Detailed information about BFD configured on interface	BFDProperties	Readonly
egress_interface	Name of local transport interface carrying tunnel traffic Corresponds to the interface where local_ip_address is routed.	string	Readonly
encap	Tunnel encap	string	Readonly Enum: STT, VXLAN, GENEVE, NONE, UNKNOWN_ENCAP
last_updated_time	Time at which the Tunnel status has been fetched last time.	EpochMsTimestamp	Readonly
latency_type	Latency type Latency type.	string	Readonly Enum: UNKNOWN_LATENCY, VALID, NOT_READY, TIMEOUT
latency_value	Latency value The latency value is set only when latency_type is VALID.	integer	Readonly
local_ip	Local IP address of tunnel	string	Readonly Format: ip
name	Name of tunnel	string	Readonly
remote_ip	Remote IP address of tunnel	string	Readonly Format: ip
remote_node_display_name	Display name of the remote transport node Represents the display name of the remote transport node at the other end of the tunnel.	string	Readonly
remote_node_id	UUID of the remote transport node	string	Readonly
status	Status of tunnel	string	Readonly Enum: UP, DOWN, UNKNOWN

Example Response:

{ "local_ip": "192.168.250.101", "bfd": { "remote_state": "DOWN", "remote_diagnostic": "CONTROL_DETECTION_TIME_EXPIRED", "active": true, "state": "INIT", "forwarding": false, "diagnostic": "NEIGHBOR_SIGNALED_SESSION_DOWN" }, "remote_ip": "192.168.250.100", "egress_interface": "vmk10", "name": "stt3232299620", "encap": "STT", "status": "DOWN", "remote_node_id": "4fa0d456-627d-4b62-9bfe-585d585dab1a" }

Tunnel properties

Request:

DataSourceParameters (schema)

Example Request:

Successful Response:

TunnelProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: