L3Vpn
Contains information necessary to configure IPSec VPN.
Properties
| Required | Property Name | Type | Description |
|---|---|---|---|
| optional | _create_time | integer |
Timestamp of resource creation |
| optional | _create_user | string |
ID of the user who created this resource |
| optional | _last_modified_time | integer |
Timestamp of last modification |
| optional | _last_modified_user | string |
ID of the user who last modified this resource |
| optional | _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| optional | _protection | string |
Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
| optional | _revision | integer |
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
| optional | _schema | string |
Schema for this resource |
| optional | _self | SelfResourceLink |
Link to this resource |
| optional | _system_owned | boolean |
Indicates system owned resource |
| optional | children | array of ChildPolicyConfigResource |
subtree for this type within policy tree containing nested elements. |
| optional | description | string |
Description of this resource |
| optional | dh_groups | array of string |
Diffie-Hellman group to be used if PFS is enabled. Default group is GROUP14. |
| optional | display_name | string |
Defaults to ID if not set |
| optional | enable_perfect_forward_secrecy | boolean |
If true, perfect forward secrecy (PFS) is enabled. |
| optional | enabled | boolean |
Flag to enable L3Vpn. Default is enabled. |
| optional | id | string |
Unique identifier of this resource |
| optional | ike_digest_algorithms | array of string |
Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256. |
| optional | ike_encryption_algorithms | array of string |
Algorithm to be used during Internet Key Exchange(IKE) negotiation. Default is AES_128. |
| optional | ike_version | string |
IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2. |
| optional | l3vpn_session | L3VpnSession |
L3Vpn Session |
| optional | local_address | string |
IPv4 address of local gateway |
| optional | marked_for_delete | boolean |
Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. |
| optional | parent_path | string |
Path of its parent |
| optional | passphrases | array of string |
List of IPSec pre-shared keys used for IPSec authentication. If not specified, the older passphrase values are retained if there are any. |
| optional | path | string |
Absolute path of this object |
| optional | relative_path | string |
Path relative from its parent |
| optional | remote_private_address | string |
This field is used to resolve conflicts in case of a remote site being behind NAT as remote public ip address is not enough. If it is not the case the remote public address should be provided here. If not provided, the value of this field is set to remote_public_address. |
| optional | remote_public_address | string |
Public IPv4 address of remote gateway |
| optional | resource_type | string |
The type of this resource. |
| optional | tags | array of Tag |
Opaque identifiers meaningful to the API user |
| optional | tunnel_digest_algorithms | array of string |
Algorithm to be used for message digest during tunnel establishment. Default algorithm is empty. |
| optional | tunnel_encryption_algorithms | array of string |
Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128. |
Property of
ChildL3Vpn
L3VpnListResult
Parameter To
Create L3VPN
Update L3VPN
Returned By
Get L3VPN
Create L3VPN
Get L3VPN With Sensitve Data
Extends
PolicyConfigResource
JSON Example
{
"_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"
]
}
