Edit custom IPSecPeerEndpoint

Edit custom IPSec peer endpoint. System owned endpoints are non editable.

Request:

Method:

PUT

URI Path(s):

/api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

IPSecVPNPeerEndpoint+

IPSecVPNPeerEndpoint (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
authentication_mode	Authentication Mode Authentication mode used for the peer authentication. For PSK (Pre Shared Key) authentication mode, 'psk' property is mandatory and for the CERTIFICATE authentication mode, 'peer_id' property is mandatory.	string	Enum: PSK, CERTIFICATE Default: "PSK"
connection_initiation_mode	Connection initiation mode Connection initiation mode used by local endpoint to establish ike connection with peer endpoint. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.	string	Enum: INITIATOR, RESPOND_ONLY, ON_DEMAND Default: "INITIATOR"
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
dpd_profile_id	Dead peer detection (DPD) profile id Dead peer detection (DPD) profile id. Default will be set according to system default policy.	string
id	Unique identifier of this resource	string	Sortable
ike_profile_id	Internet key exchange (IKE) profile id IKE profile id to be used. Default will be set according to system default policy.	string
ipsec_tunnel_profile_id	IPSec tunnel profile id Tunnel profile id to be used. By default it will point to system default profile.	string
peer_address	IPV4 address of peer endpoint on remote site. IPV4 address of peer endpoint on remote site.	string	Required
peer_id	Peer id Peer identifier.	string	Required
psk	Pre-shared key IPSec Pre-shared key. Maximum length of this field is 128 characters.	string
resource_type	Must be set to the value IPSecVPNPeerEndpoint	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/vpn/ipsec/peer-endpoints/f0cb1b37-d618-4406-94eb-b4099418a165 { "resource_type": "IPSecVPNPeerEndpoint", "description": "Peer endpoint for plr 1", "id": "f0cb1b37-d618-4406-94eb-b4099418a165", "display_name": "Peer endpoint for plr 1", "connection_initiation_mode": "INITIATOR", "authentication_mode": "PSK", "ipsec_tunnel_profile_id": "12a3a34c-c37b-11e7-abc4-cec278b6b50a", "dpd_profile_id": "12a39f8c-c37b-11e7-abc4-cec278b6b50a", "psk": "test", "ike_profile_id": "12a3a23e-c37b-11e7-abc4-cec278b6b50a", "peer_address": "2.1.4.1", "peer_id": "2.1.4.1", "_create_time": 1517293670492, "_last_modified_user": "admin", "_last_modified_time": 1517293670492, "_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:

IPSecVPNPeerEndpoint+

IPSecVPNPeerEndpoint (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
authentication_mode	Authentication Mode Authentication mode used for the peer authentication. For PSK (Pre Shared Key) authentication mode, 'psk' property is mandatory and for the CERTIFICATE authentication mode, 'peer_id' property is mandatory.	string	Enum: PSK, CERTIFICATE Default: "PSK"
connection_initiation_mode	Connection initiation mode Connection initiation mode used by local endpoint to establish ike connection with peer endpoint. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.	string	Enum: INITIATOR, RESPOND_ONLY, ON_DEMAND Default: "INITIATOR"
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
dpd_profile_id	Dead peer detection (DPD) profile id Dead peer detection (DPD) profile id. Default will be set according to system default policy.	string
id	Unique identifier of this resource	string	Sortable
ike_profile_id	Internet key exchange (IKE) profile id IKE profile id to be used. Default will be set according to system default policy.	string
ipsec_tunnel_profile_id	IPSec tunnel profile id Tunnel profile id to be used. By default it will point to system default profile.	string
peer_address	IPV4 address of peer endpoint on remote site. IPV4 address of peer endpoint on remote site.	string	Required
peer_id	Peer id Peer identifier.	string	Required
psk	Pre-shared key IPSec Pre-shared key. Maximum length of this field is 128 characters.	string
resource_type	Must be set to the value IPSecVPNPeerEndpoint	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "IPSecVPNPeerEndpoint", "description": "Peer endpoint for plr 1", "id": "f0cb1b37-d618-4406-94eb-b4099418a165", "display_name": "Peer endpoint for plr 1", "connection_initiation_mode": "INITIATOR", "authentication_mode": "PSK", "ipsec_tunnel_profile_id": "12a3a34c-c37b-11e7-abc4-cec278b6b50a", "dpd_profile_id": "12a39f8c-c37b-11e7-abc4-cec278b6b50a", "psk": "test", "ike_profile_id": "12a3a23e-c37b-11e7-abc4-cec278b6b50a", "peer_address": "2.1.4.1", "peer_id": "2.1.4.1", "_create_time": 1517293670492, "_last_modified_user": "admin", "_last_modified_time": 1667293670492, "_system_owned": false, "_create_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 1 }

Edit custom IPSecPeerEndpoint

Request:

IPSecVPNPeerEndpoint (schema)

Example Request:

Successful Response:

IPSecVPNPeerEndpoint (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: