[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Create L3VPN
DescriptionCreate a new L3Vpn if the L3Vpn with given id does not already exist. If the L3Vpn with the given id already exists, replace the existing L3Vpn. This a full replace. This API is deprecated. Please use the following APIs instead:
- PUT /infra/ipsec-vpn-tunnel-profiles/
to update the IPSecVpnTunnelProfile. - PUT /infra/ipsec-vpn-ike-profiles/
to update the IPSecVpnIkeProfile. - PUT /infra/ipsec-vpn-dpd-profiles/
to update the IPSecVpnDpdProfile. - PUT /infra/tier-0s/
/locale-services/ /ipsec-vpn-services/ default/local-endpoints/ to update the IPSecVpnLocalEndpoint. - PUT /infra/tier-0s/
/locale-services/ /ipsec-vpn-services/ default/sessions/ to update the IPSecVpnSession. If used, this deprecated API will result in the following objects being internally created/updated: - IPSecVpnTunnelProfile: /infra/ipsec-vpn-tunnel-profiles/L3VPN_
. - IPSecVpnIkeProfile: /infra/ipsec-vpn-ike-profiles/L3VPN_
. - IPSecVpnDpdProfile: /infra/ipsec-vpn-dpd-profiles/L3VPN_
. - IPSecVpnLocalEndpoint: /infra/tier-0s/
/locale-services/ / ipsec-vpn-services/default/local-endpoints/ . If an object with the same “local_address” already exists, then it will be re-used. - IPSecVpnSession: /infra/tier-0s/
/locale-services/ / ipsec-vpn-services/default/sessions/L3VPN_ .
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l3vpns/{l3vpn-id}
Path Parameters
Path Parameters
string
tier-0-id
Required
string
locale-service-id
Required
string
l3vpn-id
Required
Request Body
Request Body
L3Vpn
of type(s) application/json
Required
This request body class requires all of the following:
PolicyConfigResource, InlineL3Vpn1
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
L3Vpn
of type(s) application/json
This response body class contains all of the following:
PolicyConfigResource, InlineL3Vpn1
Errors
Code Samples
Code Samples
PowerCLI Client SDK Example
$ResourceLink = Initialize-ResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-SelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-Tag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-PolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-ChildPolicyConfigResource -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
"GROUP2""SHA1""AES_128"$L3VpnSession = Initialize-L3VpnSession -ResourceType "PolicyBasedL3VpnSession"
"SHA1""AES_128"$L3Vpn = Initialize-L3Vpn -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 -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -DhGroups
$ResourceLink = Initialize-ResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-SelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-Tag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-PolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-ChildPolicyConfigResource -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
"GROUP2" -EnablePerfectForwardSecrecy $false -Enabled $false -IkeDigestAlgorithms
$ResourceLink = Initialize-ResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-SelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-Tag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-PolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-ChildPolicyConfigResource -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
"GROUP2""SHA1" -IkeEncryptionAlgorithms
$ResourceLink = Initialize-ResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-SelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-Tag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-PolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-ChildPolicyConfigResource -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
"GROUP2""SHA1""AES_128" -IkeVersion "IKE_V1" -L3vpnSession $L3VpnSession -LocalAddress "MyLocalAddress" -Passphrases "MyPassphrases" -RemotePrivateAddress "MyRemotePrivateAddress" -RemotePublicAddress "MyRemotePublicAddress" -TunnelDigestAlgorithms
$ResourceLink = Initialize-ResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-SelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-Tag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-PolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-ChildPolicyConfigResource -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
"GROUP2""SHA1""AES_128"$L3VpnSession = Initialize-L3VpnSession -ResourceType "PolicyBasedL3VpnSession"
"SHA1" -TunnelEncryptionAlgorithms
$ResourceLink = Initialize-ResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-SelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-Tag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-PolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-ChildPolicyConfigResource -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
"GROUP2""SHA1""AES_128"$L3VpnSession = Initialize-L3VpnSession -ResourceType "PolicyBasedL3VpnSession"
"SHA1""AES_128"
Invoke-CreateOrReplaceL3Vpn -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -l3vpnId "Myl3vpnId" -l3Vpn $l3Vpn
cURL Command
curl -X PUT -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l3vpns/{l3vpn-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated: null
x-vmw-doc-operation: create-l3vpn
x-vmw-nsx-module: PolicyL3Vpn
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 0s Operations
put
delete
get
patch
