Create Or Patch L3 Vpn

Create Or Patch L3 Vpn

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
URI
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
string
tier-0-id
Required

tier-0-id

string
locale-service-id
Required

locale-service-id

string
l3vpn-id
Required

l3vpn-id


Request Body
L3Vpn of type(s) application/json
Optional
This request body class requires all of the following: PolicyConfigResource , InlineL3Vpn1
{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_revision": 0,
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_protection": "string",
    "_system_owned": false,
    "description": "string",
    "display_name": "string",
    "id": "string",
    "resource_type": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "parent_path": "string",
    "path": "string",
    "relative_path": "string",
    "children": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "marked_for_delete": false
        }
    ],
    "marked_for_delete": false,
    "dh_groups": [
        "string"
    ],
    "enable_perfect_forward_secrecy": false,
    "enabled": false,
    "ike_digest_algorithms": [
        "string"
    ],
    "ike_encryption_algorithms": [
        "string"
    ],
    "ike_version": "string",
    "l3vpn_session": {
        "resource_type": "string"
    },
    "local_address": "string",
    "passphrases": [
        "string"
    ],
    "remote_private_address": "string",
    "remote_public_address": "string",
    "tunnel_digest_algorithms": [
        "string"
    ],
    "tunnel_encryption_algorithms": [
        "string"
    ]
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Operation doesn't return any data structure

400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}