[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Create IPsec VPN DPD Profile
DescriptionCreate or patch dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile. System will be provisioned with system owned editable default DPD profile. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/ipsec-vpn-dpd-profiles/{dpd-profile-id}
Path Parameters
Path Parameters
string
dpd-profile-id
Required
Request Body
Request Body
IPSecVpnDpdProfile
of type(s) application/json
Required
This request body class requires all of the following:
PolicyConfigResource, InlineIPSecVpnDpdProfile1
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
IPSecVpnDpdProfile
of type(s) application/json
This response body class contains all of the following:
PolicyConfigResource, InlineIPSecVpnDpdProfile1
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
ApiError
404
Not Found
ApiError
412
Precondition Failed
ApiError
500
Internal Server Error
ApiError
503
Service Unavailable
Code Samples
PowerCLI Client SDK Example
$ResourceLink = Initialize-nullResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-nullSelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-nullTag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-nullPolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-nullChildPolicyConfigResource -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -MarkForOverride $false -MarkedForDelete $false -RequestParameter $PolicyRequestParameter
$IPSecVpnDpdProfile = Initialize-nullIPSecVpnDpdProfile -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -OriginSiteId "MyOriginSiteId" -OwnerId "MyOwnerId" -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -RemotePath "MyRemotePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -DpdProbeInterval 0 -DpdProbeMode "PERIODIC" -Enabled $false -RetryCount 0
Invoke-CreateOrUpdateIPSecVpnDpdProfile -dpdProfileId "MydpdProfileId" -iPSecVpnDpdProfile $iPSecVpnDpdProfile
cURL Command
curl -X PUT -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","display_name":"string","dpd_probe_interval":0,"enabled":false,"id":"string","marked_for_delete":false,"parent_path":"string","path":"string","relative_path":"string","resource_type":"string","tags":[{"scope":"string","tag":"string"}]}' https://nsxmanager.your.domain/policy/api/v1/infra/ipsec-vpn-dpd-profiles/{dpd-profile-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-ipsec-vpn-dpd-profile
x-vmw-nsx-module: PolicyIPSecVpn
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
