[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Create L3VPN

Description

Create 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

Request

URL

URL


put
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l3vpns/{l3vpn-id}
Copy

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns L3Vpn of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlineL3Vpn1
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

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
"GROUP2""SHA1""AES_128"$L3VpnSession = Initialize-nullL3VpnSession -ResourceType "PolicyBasedL3VpnSession"
"SHA1""AES_128"$L3Vpn = Initialize-nullL3Vpn -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 -DhGroups
$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
"GROUP2" -EnablePerfectForwardSecrecy $false -Enabled $false -IkeDigestAlgorithms
$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
"GROUP2""SHA1" -IkeEncryptionAlgorithms
$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
"GROUP2""SHA1""AES_128" -IkeVersion "IKE_V1" -L3vpnSession $L3VpnSession -LocalAddress "MyLocalAddress" -Passphrases "MyPassphrases" -RemotePrivateAddress "MyRemotePrivateAddress" -RemotePublicAddress "MyRemotePublicAddress" -TunnelDigestAlgorithms
$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
"GROUP2""SHA1""AES_128"$L3VpnSession = Initialize-nullL3VpnSession -ResourceType "PolicyBasedL3VpnSession"
"SHA1" -TunnelEncryptionAlgorithms
$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
"GROUP2""SHA1""AES_128"$L3VpnSession = Initialize-nullL3VpnSession -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 '{"_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":["GROUP2"],"display_name":"string","enable_perfect_forward_secrecy":false,"enabled":false,"id":"string","ike_digest_algorithms":["SHA1"],"ike_encryption_algorithms":["AES_128"],"ike_version":"IKE_V1","l3vpn_session":{"resource_type":"PolicyBasedL3VpnSession"},"local_address":"string","marked_for_delete":false,"parent_path":"string","passphrases":["string"],"path":"string","relative_path":"string","remote_private_address":"string","remote_public_address":"string","resource_type":"string","tags":[{"scope":"string","tag":"string"}],"tunnel_digest_algorithms":["SHA1"],"tunnel_encryption_algorithms":["AES_128"]}' https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l3vpns/{l3vpn-id}
Vendor Extensions

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


Feedback

Was this page helpful?