NSX Autonomous Edge REST API

Create new VPN session

Create new VPN session.

Request:

Method:
POST
URI Path(s):
/vpn/ipsec/sessions
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
PolicyBasedIPSecVPNSession+
RouteBasedIPSecVPNSession+

Example Request:

{ "resource_type": "PolicyBasedIPSecVPNSession", "display_name": "PBS 12", "enabled": true, "policy_rules": [ { "sources": [ { "subnet": "1.1.2.0/24" } ], "destinations": [ { "subnet": "2.1.4.0/24" } ], "action": "PROTECT" } ], "local_endpoint": { "local_address": "2.2.2.2", "local_id": "2.2.2.2" }, "peer_id": "4.4.4.1", "peer_address": "4.4.4.1", "psk": "TESTPSK", "connection_initiation_mode": "ON_DEMAND", "authentication_mode": "PSK" }

Successful Response:

Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
PolicyBasedIPSecVPNSession+
RouteBasedIPSecVPNSession+

Example Response:

{ "display_name": "PBS 12", "enabled": true, "id": "e23554c3-a4f7-4144-8bbc-1daf88106b7e", "local_endpoint": { "local_address": "2.2.2.2", "local_id": "2.2.2.2" }, "authentication_mode": "PSK", "connection_initiation_mode": "ON_DEMAND", "peer_address": "4.4.4.1", "peer_id": "4.4.4.1", "policy_rules": [ { "action": "PROTECT", "destinations": [ { "subnet": "2.1.4.0/24" } ], "id": "1026", "sources": [ { "subnet": "1.1.2.0/24" } ] } ], "resource_type": "PolicyBasedIPSecVPNSession" }

Required Permissions:

crud

Feature:

vpn

Additional Errors: