[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Update IPsec VPN Session
DescriptionCreate or patch an IPSec VPN session for a given locale service under Tier-0.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
Path Parameters
Path Parameters
string
tier-0-id
Required
string
locale-service-id
Required
string
service-id
Required
string
session-id
Required
Request Body
Request Body
IPSecVpnSession
of type(s) application/json
Required
This request body class requires all of the following:
PolicyConfigResource, InlineIPSecVpnSession1
Authentication
This operation uses the following authentication methods.
Errors
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
$TunnelInterfaceIPSubnet = Initialize-nullTunnelInterfaceIPSubnet -IpAddresses "MyIpAddresses" -PrefixLength 0
$IPSecVpnTunnelInterface = Initialize-nullIPSecVpnTunnelInterface -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 -IpSubnets $TunnelInterfaceIPSubnet
$SiteOverride = Initialize-nullSiteOverride -LocalEndpointPath "MyLocalEndpointPath" -LocaleServicePath "MyLocaleServicePath" -PeerAddress "MyPeerAddress" -PeerId "MyPeerId" -TunnelInterfaces $IPSecVpnTunnelInterface
$TcpMaximumSegmentSizeClamping = Initialize-nullTcpMaximumSegmentSizeClamping -Direction "NONE" -MaxSegmentSize 0
$IPSecVpnSession = Initialize-nullIPSecVpnSession -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 "PolicyBasedIPSecVpnSession" -Tags $Tag -OriginSiteId "MyOriginSiteId" -OwnerId "MyOwnerId" -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -RemotePath "MyRemotePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -AuthenticationMode "PSK" -ComplianceSuite "CNSA" -ConnectionInitiationMode "INITIATOR" -DpdProfilePath "MyDpdProfilePath" -Enabled $false -IkeProfilePath "MyIkeProfilePath" -LocalEndpointPath "MyLocalEndpointPath" -PeerAddress "MyPeerAddress" -PeerId "MyPeerId" -Psk "MyPsk" -SiteOverrides $SiteOverride -TcpMssClamping $TcpMaximumSegmentSizeClamping -TunnelProfilePath "MyTunnelProfilePath"
Invoke-CreateOrPatchTier0IPSecVpnSession -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -serviceId "MyserviceId" -sessionId "MysessionId" -iPSecVpnSession $iPSecVpnSession
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,"authentication_mode":"PSK","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"}]}],"compliance_suite":"CNSA","connection_initiation_mode":"INITIATOR","description":"string","display_name":"string","dpd_profile_path":"string","enabled":false,"id":"string","ike_profile_path":"string","local_endpoint_path":"string","marked_for_delete":false,"parent_path":"string","path":"string","peer_address":"string","peer_id":"string","psk":"string","relative_path":"string","resource_type":"PolicyBasedIPSecVpnSession","tags":[{"scope":"string","tag":"string"}],"tcp_mss_clamping":{"direction":"NONE","max_segment_size":0},"tunnel_profile_path":"string"}' https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update-ipsec-vpn-session
x-vmw-nsx-module: PolicyIPSecVpn
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 0s Operations
delete
delete
patch
