NSX-T Data Center REST API

Get IPSec VPN sessions list result

Get paginated list of all IPSec VPN sessions
for a given ipsec vpn service under Tier-0.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions
Request Headers:
n/a
Query Parameters:
IPSecVpnSessionListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/ext_net/ipsec-vpn-services/default/sessions

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
IPSecVpnSessionListResult+

Example Response:

{ "result_count" : 1, "results" : [ { "resource_type": "RouteBasedIPSecVpnSession", "display_name" : "rbs-1", "description" : "Route based vpn session 1", "path": "/infra/tier-0s/ext_net/ipsec-vpn-services/default/sessions/rbs-1", "parent_path": "/infra/tier-0s/ext_net/ipsec-vpn-services/default", "relative_path": "rbs-1", "enabled" : true, "connection_initiation_mode" : "INITIATOR", "authentication_mode" : "PSK", "tunnel_profile_path" : "/infra/ipsec-vpn-tunnel-profiles/custom-tunnel-profile", "dpd_profile_path" : "/infra/ipsec-vpn-dpd-profiles/custom-dpd-profile", "ike_profile_path" : "/infra/ipsec-vpn-ike-profiles/custom-ike-profile", "local_endpoint_path" : "/infra/tier-0s/ext_net/ipsec-vpn-services/default/local-endpoints/default-le", "peer_address" : "2.1.4.1", "peer_id" : "2.1.4.1", "tunnel_interfaces" : [ { "resource_type" : "IPSecVpnTunnelInterface", "path": "/infra/tier-0s/ext_net/ipsec-vpn-services/default/sessions/rbs-1/interfaces/default-tunnel-interface", "parent_path": "/infra/tier-0s/ext_net/ipsec-vpn-services/default/sessions/rbs-1", "relative_path": "default-tunnel-interface", "ip_subnets" : [ { "ip_addresses" : [ "169.90.50.1" ], "prefix_length" : 30 } ], "_create_user": "admin", "_create_time": 1516385949942, "_last_modified_user": "admin", "_last_modified_time": 1516385949942, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision" : 2, } ], "_create_user": "admin", "_create_time": 1516385949942, "_last_modified_user": "admin", "_last_modified_time": 1516385949942, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision" : 0 } ] }

Required Permissions:

read

Feature:

policy_vpn

Additional Errors: