Edit IPSec VPN session

Edit IPSec VPN session.

Request:

Method:

PUT

URI Path(s):

/api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

PolicyBasedIPSecVPNSession+

PolicyBasedIPSecVPNSession (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable/Disable IPSec VPN session Enable/Disable IPSec VPN session.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ipsec_vpn_service_id	IPSec VPN service identifier Identifier of VPN Service linked with local endpoint.	string	Readonly
local_endpoint_id	Local endpoint identifier Local endpoint identifier.	string	Required
peer_endpoint_id	Peer endpoint identifier Peer endpoint identifier.	string	Required
policy_rules	Policy rules	array of IPSecVPNPolicyRule	Required
resource_type	Must be set to the value PolicyBasedIPSecVPNSession	IPSecVPNSessionResourceType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_mss_clamping		TcpMssClamping

RouteBasedIPSecVPNSession+

RouteBasedIPSecVPNSession (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable/Disable IPSec VPN session Enable/Disable IPSec VPN session.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ipsec_vpn_service_id	IPSec VPN service identifier Identifier of VPN Service linked with local endpoint.	string	Readonly
local_endpoint_id	Local endpoint identifier Local endpoint identifier.	string	Required
peer_endpoint_id	Peer endpoint identifier Peer endpoint identifier.	string	Required
resource_type	Must be set to the value RouteBasedIPSecVPNSession	IPSecVPNSessionResourceType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_mss_clamping		TcpMssClamping
tunnel_ports	IP Tunnel ports IP Tunnel ports.	array of TunnelPortConfig	Required Minimum items: 1 Maximum items: 1

Example Request:

PUT https://<nsx-mgr>/api/v1/vpn/ipsec/sessions/ee4f7777-f837-4dbb-9a03-eeb9beb52b09 { "resource_type": "PolicyBasedIPSecVPNSession", "id": "ee4f7777-f837-4dbb-9a03-eeb9beb52b09", "display_name": "PBS 12", "ipsec_vpn_service_id": "f770a847-a6c9-4bc0-94cb-1dd1d5ae622a", "peer_endpoint_id": "f0cb1b37-d618-4406-94eb-b4099418a165", "local_endpoint_id": "c99d8ed0-195b-46b0-8474-664b55cfb176", "enabled": true, "policy_rules": [ { "id": "1026", "sources": [ { "subnet": "1.1.1.0/24" } ], "logged": true, "destinations": [ { "subnet": "2.1.4.0/24" } ], "action": "PROTECT", "enabled": true, "_revision": 0 } ], "_create_time": 1517293798690, "_last_modified_user": "admin", "_last_modified_time": 1517293798690, "_system_owned": false, "_create_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyBasedIPSecVPNSession+

PolicyBasedIPSecVPNSession (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable/Disable IPSec VPN session Enable/Disable IPSec VPN session.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ipsec_vpn_service_id	IPSec VPN service identifier Identifier of VPN Service linked with local endpoint.	string	Readonly
local_endpoint_id	Local endpoint identifier Local endpoint identifier.	string	Required
peer_endpoint_id	Peer endpoint identifier Peer endpoint identifier.	string	Required
policy_rules	Policy rules	array of IPSecVPNPolicyRule	Required
resource_type	Must be set to the value PolicyBasedIPSecVPNSession	IPSecVPNSessionResourceType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_mss_clamping		TcpMssClamping

RouteBasedIPSecVPNSession+

RouteBasedIPSecVPNSession (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable/Disable IPSec VPN session Enable/Disable IPSec VPN session.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ipsec_vpn_service_id	IPSec VPN service identifier Identifier of VPN Service linked with local endpoint.	string	Readonly
local_endpoint_id	Local endpoint identifier Local endpoint identifier.	string	Required
peer_endpoint_id	Peer endpoint identifier Peer endpoint identifier.	string	Required
resource_type	Must be set to the value RouteBasedIPSecVPNSession	IPSecVPNSessionResourceType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_mss_clamping		TcpMssClamping
tunnel_ports	IP Tunnel ports IP Tunnel ports.	array of TunnelPortConfig	Required Minimum items: 1 Maximum items: 1

Example Response:

{ "resource_type": "PolicyBasedIPSecVPNSession", "id": "ee4f7777-f837-4dbb-9a03-eeb9beb52b09", "display_name": "PBS 12", "ipsec_vpn_service_id": "f770a847-a6c9-4bc0-94cb-1dd1d5ae622a", "peer_endpoint_id": "f0cb1b37-d618-4406-94eb-b4099418a165", "local_endpoint_id": "c99d8ed0-195b-46b0-8474-664b55cfb176", "enabled": true, "policy_rules": [ { "id": "1026", "sources": [ { "subnet": "1.1.1.0/24" } ], "logged": true, "destinations": [ { "subnet": "2.1.4.0/24" } ], "action": "PROTECT", "enabled": true, "_revision": 0 } ], "_create_time": 1517293798690, "_last_modified_user": "admin", "_last_modified_time": 1517293798690, "_system_owned": false, "_create_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 1 }

Edit IPSec VPN session

Request:

PolicyBasedIPSecVPNSession (schema)

RouteBasedIPSecVPNSession (schema)

Example Request:

Successful Response:

PolicyBasedIPSecVPNSession (schema)

RouteBasedIPSecVPNSession (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: