Update IPsec VPN IKE Profile
Create or patch custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/ipsec-vpn-ike-profiles/{ike-profile-id}
Parameters
Parameters
string
ike-profile-id
Required
No description available
Request Body
Request Body
IPSecVpnIkeProfile (required)
integer
_create_time
Optional
Timestamp of resource creation
string
_create_user
Optional
ID of the user who created this resource
integer
_last_modified_time
Optional
Timestamp of last modification
string
_last_modified_user
Optional
ID of the user who last modified this resource
array of
ResourceLink
_links
Optional
The server will populate this field when returing the resource. Ignored on PUT and POST.
string
_protection
Optional
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.
integer
_revision
Optional
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.
string
_schema
Optional
Schema for this resource
boolean
_system_owned
Optional
Indicates system owned resource
array of
ChildPolicyConfigResource
children
Optional
subtree for this type within policy tree containing nested elements.
string
description
Optional
Description of this resource
array of
string
dh_groups
Optional
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
Possible values are: GROUP2, GROUP5, GROUP14, GROUP15, GROUP16, GROUP19, GROUP20, GROUP21
array of
string
digest_algorithms
Optional
Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.
Possible values are: SHA1, SHA2_256, SHA2_384, SHA2_512
string
display_name
Optional
Defaults to ID if not set
array of
string
encryption_algorithms
Optional
Encryption algorithm is used during Internet Key Exchange(IKE) negotiation. Default is AES_128.
Possible values are: AES_128, AES_256, AES_GCM_128, AES_GCM_192, AES_GCM_256
string
id
Optional
Unique identifier of this resource
string
ike_version
Optional
IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.
Possible values are: IKE_V1, IKE_V2, IKE_FLEX
boolean
marked_for_delete
Optional
Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.
string
parent_path
Optional
Path of its parent
string
path
Optional
Absolute path of this object
string
relative_path
Optional
Path relative from its parent
string
resource_type
Optional
The type of this resource.
integer
sa_life_time
Optional
Life time for security association. Default is 86400 seconds (1 day).
cURL Command
curl -X PATCH -H "Content-Type: application/json" -d '{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"children":[{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"description":"string","display_name":"string","id":"string","marked_for_delete":false,"resource_type":"string","tags":[{"scope":"string","tag":"string"}]}],"description":"string","dh_groups":["string"],"digest_algorithms":["string"],"display_name":"string","encryption_algorithms":["string"],"id":"string","ike_version":"string","marked_for_delete":false,"parent_path":"string","path":"string","relative_path":"string","resource_type":"string","sa_life_time":0,"tags":[{"scope":"string","tag":"string"}]}' https://nsxmanager.your.domain/policy/api/v1/infra/ipsec-vpn-ike-profiles/{ike-profile-id}
Errors
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
503
The server is currently unavailable (because it is overloaded or down for maintenance).
