Read L3 Vpn
Read the L3Vpn with the given id. No sensitive data is returned as part of the response. This API is deprecated. Please use the following APIs instead:
- GET /infra/tier-0s/
/locale-services/ /ipsec-vpn-services/ default/sessions/L3VPN_ to get the associated IPSecVpnSession. - GET /infra/tier-0s/
/locale-services/ /ipsec-vpn-services/ default/local-endpoints/ to get the associated IPSecVpnLocalEndpoint. - GET /infra/ipsec-vpn-tunnel-profiles/L3VPN_
to get the associated IPSecVpnTunnelProfile. - GET /infra/ipsec-vpn-ike-profiles/L3VPN_
to get the associated IPSecVpnIkeProfile. - GET /infra/ipsec-vpn-dpd-profiles/L3VPN_
to get the associated IPSecVpnDpdProfile. If used, this deprecated API will not return L3Vpn with id unless the associated IPSecVpnSession with L3VPN_ id exists. For example, if the IPSecVpnSession gets deleted using DELETE /infra/tier-0s/ /locale-services/ /ipsec-vpn-services/ default/sessions/L3VPN_ , the deprecated API will throw an ObjectNotFoundException.
Request
URI
GET
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
Responses
200
OK
Returns L3Vpn of type(s) application/json
This response body class contains 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"
]
}
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
Not Found
Operation doesn't return any data structure
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"
}
]
}