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

Update L3VPN

Description

Create the new L3Vpn if it does not exist. If the L3Vpn already exists, merge with the the existing one. This is a patch.

  • If the passed L3Vpn is a policy-based one and has new L3VpnRules, add them to the existing L3VpnRules.
  • If the passed L3Vpn is a policy-based one and also has existing L3VpnRules, update the existing L3VpnRules. This API is deprecated. Please use the following APIs instead:
  • PATCH /infra/ipsec-vpn-tunnel-profiles/ to patch the IPSecVpnTunnelProfile.
  • PATCH /infra/ipsec-vpn-ike-profiles/ to patch the IPSecVpnIkeProfile.
  • PATCH /infra/ipsec-vpn-dpd-profiles/ to patch the IPSecVpnDpdProfile.
  • PATCH /infra/tier-0s//locale-services//ipsec-vpn-services/ default/local-endpoints/ to patch the IPSecVpnLocalEndpoint.
  • PATCH /infra/tier-0s//locale-services//ipsec-vpn-services/ default/sessions/ to patch the IPSecVpnSession. If used, this deprecated API will result in the following objects being internally created/patched:
  • 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


patch
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

200 OK

OK

Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-CreateOrPatchL3Vpn -tier0Id -localeServiceId -l3vpnId -l3Vpn $l3Vpn

cURL Command

curl -X PATCH -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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update-l3vpn
x-vmw-nsx-module: PolicyL3Vpn


Feedback

Was this page helpful?