List Tunnel

List Tunnel 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

Request Headers:

n/a

Query Parameters:

PolicyTunnelListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	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
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

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-0s//locale-services//tunnels

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyTunnelListResult+

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
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Policy Tunnel list results	array of Tunnel (Abstract type: pass one of the following concrete types) GreTunnel Tunnel	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "results": [ { "destination_address": "44.44.44.10", "tunnel_keepalive": { "enabled": false, "enable_keepalive_ack": true, "keepalive_interval": 10, "dead_time_multiplier": 3 }, "resource_type": "GreTunnel", "id": "aa-gre-1", "display_name": "aa-gre-1", "path": "/infra/tier-0s/Tier0-LR1-AA/locale-services/T0-LR1-LocaleService-1/tunnels/aa-gre-1", "relative_path": "aa-gre-1", "parent_path": "/infra/tier-0s/Tier0-LR1-AA/locale-services/T0-LR1-LocaleService-1", "remote_path": "", "unique_id": "05919494-a00e-4e7b-abb8-daea2f15820d", "realization_id": "05919494-a00e-4e7b-abb8-daea2f15820d", "owner_id": "04e3159d-9c1a-464b-889e-3f52427f1098", "marked_for_delete": false, "overridden": false, "enabled": true, "tunnel_address": [ { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/0", "tunnel_interface_subnet": [ { "ip_addresses": [ "192.168.10.2" ], "prefix_len": 24 } ], "source_address": "40.40.40.1" }, { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/1", "tunnel_interface_subnet": [ { "ip_addresses": [ "192.168.20.2" ], "prefix_len": 24 } ], "source_address": "40.40.40.2" } ], "mtu": 1476, "_create_time": 1689587127380, "_create_user": "admin", "_last_modified_time": 1689587127380, "_last_modified_user": "admin", "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "destination_address": "44.44.44.11", "tunnel_keepalive": { "enabled": false, "enable_keepalive_ack": true, "keepalive_interval": 10, "dead_time_multiplier": 3 }, "resource_type": "GreTunnel", "id": "aa-gre-10-new", "display_name": "aa-gre-1", "path": "/infra/tier-0s/Tier0-LR1-AA/locale-services/T0-LR1-LocaleService-1/tunnels/aa-gre-10-new", "relative_path": "aa-gre-10-new", "parent_path": "/infra/tier-0s/Tier0-LR1-AA/locale-services/T0-LR1-LocaleService-1", "remote_path": "", "unique_id": "d22a618d-d8c0-4be0-a2b4-94e9485d1f25", "realization_id": "d22a618d-d8c0-4be0-a2b4-94e9485d1f25", "owner_id": "04e3159d-9c1a-464b-889e-3f52427f1098", "marked_for_delete": false, "overridden": false, "enabled": true, "tunnel_address": [ { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/0", "tunnel_interface_subnet": [ { "ip_addresses": [ "192.168.30.2" ], "prefix_len": 24 } ], "source_address": "40.40.40.1" }, { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/1", "tunnel_interface_subnet": [ { "ip_addresses": [ "192.168.40.2" ], "prefix_len": 24 } ], "source_address": "40.40.40.2" } ], "mtu": 1476, "_create_time": 1689828248560, "_create_user": "admin", "_last_modified_time": 1689828248560, "_last_modified_user": "admin", "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "destination_address": "44.44.44.12", "tunnel_keepalive": { "enabled": false, "enable_keepalive_ack": true, "keepalive_interval": 10, "dead_time_multiplier": 3 }, "resource_type": "GreTunnel", "id": "aa-gre-10-new-1", "display_name": "aa-gre-10-new-1-display-name", "path": "/infra/tier-0s/Tier0-LR1-AA/locale-services/T0-LR1-LocaleService-1/tunnels/aa-gre-10-new-1", "relative_path": "aa-gre-10-new-1", "parent_path": "/infra/tier-0s/Tier0-LR1-AA/locale-services/T0-LR1-LocaleService-1", "remote_path": "", "unique_id": "e8eca44c-965d-4f7e-8886-38304ca5be47", "realization_id": "e8eca44c-965d-4f7e-8886-38304ca5be47", "owner_id": "04e3159d-9c1a-464b-889e-3f52427f1098", "marked_for_delete": false, "overridden": false, "enabled": true, "tunnel_address": [ { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/0", "tunnel_interface_subnet": [ { "ip_addresses": [ "192.168.50.2" ], "prefix_len": 24 } ], "source_address": "40.40.40.1" }, { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/172c9d22-5257-4e9c-af85-4a652d8f2b05/edge-nodes/1", "tunnel_interface_subnet": [ { "ip_addresses": [ "192.168.60.2" ], "prefix_len": 24 } ], "source_address": "40.40.40.2" } ], "mtu": 1476, "_create_time": 1689828527066, "_create_user": "admin", "_last_modified_time": 1689828527066, "_last_modified_user": "admin", "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } ], "result_count": 3, "sort_by": "display_name", "sort_ascending": true }

List Tunnel

Request:

PolicyTunnelListRequestParameters (schema)

Example Request:

Successful Response:

PolicyTunnelListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: