NSX Autonomous Edge REST API

Edit custom IPSecTunnelProfile

Edit custom IPSec Tunnel Profile. System owned profiles are non editable.

Request:

Method:

PUT

URI Path(s):

/vpn/ipsec/tunnel-profiles/{ipsec-vpn-tunnel-profile-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

IPSecVPNTunnelProfile+

IPSecVPNTunnelProfile (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.	integer	Readonly
_schema	Location of schema for this resource	string	Readonly
_self		SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
actions	Actions applicable to the resource at this time	array of ActionDescriptor	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
df_policy	Policy for handling defragmentation bit Defragmentation policy helps to handle defragmentation bit present in the inner packet. COPY copies the defragmentation bit from the inner IP packet into the outer packet. CLEAR ignores the defragmentation bit present in the inner packet.	string	Enum: COPY, CLEAR Default: "COPY"
dh_groups	DH group Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.	array of DHGroup
digest_algorithms	Algorithm for message hash Algorithm used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm "AES_GCM_128".	array of TunnelDigestAlgorithm
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_perfect_forward_secrecy	Enable perfect forward secrecy If true, perfect forward secrecy (PFS) is enabled.	boolean	Default: "True"
encapsulation_mode	Encapsulation Mode Encapsulation Mode to be used for encryption of packet. Tunnel mode protects internal routing information by encrypting IP header of original packet.	string	Readonly Enum: TUNNEL_MODE Default: "TUNNEL_MODE"
encryption_algorithms	Encryption algorithm to use in tunnel establishement Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.	array of TunnelEncryptionAlgorithm
id	Unique identifier of this resource	string	Readonly Sortable
is_default	Default Profile It is a boolean flag which reflects whether a profile is created and owned by system or not. If the session creation/update does not define a profile, this default profile will be used. Default profiles cannot be edited or deleted. If the sessions needs different settings, please create a new profile.	boolean	Readonly
notify_mpa	send notification to MPA about this config change (applicable on edge node)	boolean	Default: "False"
resource_type	Must be set to the value IPSecVPNTunnelProfile	string
sa_life_time	Security association (SA) life time SA life time specifies the expiry time of security association. Default is 3600 seconds.	integer	Minimum: 900 Maximum: 31536000 Default: "3600"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transform_protocol	Tunnel protocol IPSec transform specifies IPSec security protocol.	string	Readonly Enum: ESP Default: "ESP"

Example Request:

{ "resource_type" : "IPSecVPNTunnelProfile", "id" : "12a3a34c-c37b-11e7-abc4-cec278b6b50a", "display_name" : "nsx-default-tunnel-profile", "enable_perfect_forward_secrecy" : true, "encryption_algorithms" : [ "AES_128" ], "digest_algorithms" : [ "SHA2_256" ], "sa_life_time" : 3600, "dh_groups" : [ "GROUP14" ], "encapsulation_mode" : "TUNNEL_MODE", "transform_protocol" : "ESP", "df_policy" : "COPY" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IPSecVPNTunnelProfile+

IPSecVPNTunnelProfile (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.	integer	Readonly
_schema	Location of schema for this resource	string	Readonly
_self		SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
actions	Actions applicable to the resource at this time	array of ActionDescriptor	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
df_policy	Policy for handling defragmentation bit Defragmentation policy helps to handle defragmentation bit present in the inner packet. COPY copies the defragmentation bit from the inner IP packet into the outer packet. CLEAR ignores the defragmentation bit present in the inner packet.	string	Enum: COPY, CLEAR Default: "COPY"
dh_groups	DH group Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.	array of DHGroup
digest_algorithms	Algorithm for message hash Algorithm used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm "AES_GCM_128".	array of TunnelDigestAlgorithm
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_perfect_forward_secrecy	Enable perfect forward secrecy If true, perfect forward secrecy (PFS) is enabled.	boolean	Default: "True"
encapsulation_mode	Encapsulation Mode Encapsulation Mode to be used for encryption of packet. Tunnel mode protects internal routing information by encrypting IP header of original packet.	string	Readonly Enum: TUNNEL_MODE Default: "TUNNEL_MODE"
encryption_algorithms	Encryption algorithm to use in tunnel establishement Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.	array of TunnelEncryptionAlgorithm
id	Unique identifier of this resource	string	Readonly Sortable
is_default	Default Profile It is a boolean flag which reflects whether a profile is created and owned by system or not. If the session creation/update does not define a profile, this default profile will be used. Default profiles cannot be edited or deleted. If the sessions needs different settings, please create a new profile.	boolean	Readonly
notify_mpa	send notification to MPA about this config change (applicable on edge node)	boolean	Default: "False"
resource_type	Must be set to the value IPSecVPNTunnelProfile	string
sa_life_time	Security association (SA) life time SA life time specifies the expiry time of security association. Default is 3600 seconds.	integer	Minimum: 900 Maximum: 31536000 Default: "3600"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transform_protocol	Tunnel protocol IPSec transform specifies IPSec security protocol.	string	Readonly Enum: ESP Default: "ESP"

Example Response:

{ "resource_type" : "IPSecVPNTunnelProfile", "id" : "12a3a34c-c37b-11e7-abc4-cec278b6b50a", "display_name" : "nsx-default-tunnel-profile", "enable_perfect_forward_secrecy" : true, "encryption_algorithms" : [ "AES_128" ], "digest_algorithms" : [ "SHA2_256" ], "sa_life_time" : 3600, "dh_groups" : [ "GROUP14" ], "encapsulation_mode" : "TUNNEL_MODE", "transform_protocol" : "ESP", "df_policy" : "COPY" }

Required Permissions:

crud

Feature:

vpn

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable