List L3VPN Sessions
Paginated list of L3Vpns.
This API is deprecated. Please use the following APIs instead:
- GET /infra/tier-0s/
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l3vpns
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Not available |
| required |
|
string | Not available |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
string | Opaque cursor to be used for getting next page of records (supplied by current result page) |
| optional |
|
boolean | Include objects that are marked for deletion in results |
| optional |
|
string | Comma separated list of fields that should be included in query result |
| optional |
|
string | Resource type of L3Vpn Session |
| optional |
|
integer | Maximum number of results to return in this page (server may return fewer) |
| optional |
|
boolean | Not available |
| optional |
|
string | Field by which records are sorted |
Response
Response
Response BodyResponse Body
200 OK returns
L3VpnListResult
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"cursor": "string",
"result_count": 0,
"results": [
{
"_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": [
"string"
],
"display_name": "string",
"enable_perfect_forward_secrecy": false,
"enabled": false,
"id": "string",
"ike_digest_algorithms": [
"string"
],
"ike_encryption_algorithms": [
"string"
],
"ike_version": "string",
"l3vpn_session": {
"resource_type": "string"
},
"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": [
"string"
],
"tunnel_encryption_algorithms": [
"string"
]
}
],
"sort_ascending": false,
"sort_by": "string"
}| Property Name | Type | Description |
|---|---|---|
| _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| _schema | string |
Schema for this resource |
| _self | SelfResourceLink |
Link to this resource |
| cursor | string |
Opaque cursor to be used for getting next page of records (supplied by current result page) |
| result_count | integer |
Count of results found (across all pages), set only on first page |
| results | array of L3Vpn |
L3Vpn list results |
| sort_ascending | boolean |
If true, results are sorted in ascending order |
| sort_by | string |
Field by which records are sorted |
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l3vpns
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | NotFound | The requested resource could not be found but may be available again in the future. |
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
On This Page
Locale Services L3VPN Operations
put
delete
get
patch
