RouteBasedIPSecVpnSession (schema)

Route based VPN session

A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.
Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_protection Indicates protection status of this resource

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
string Readonly
_revision Generation of this resource config

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.
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
authentication_mode Authentication Mode

Peer authentication mode.
PSK - In this mode a secret key shared between local and
peer sites is to be used for authentication. The secret
key can be a string with a maximum length of 128 characters.
CERTIFICATE - In this mode a certificate defined at the
global level is to be used for authentication.
Default: "PSK"
children subtree for this type within policy tree

subtree for this type within policy tree containing nested elements.
array of ChildPolicyConfigResource
Children are not allowed for this type
compliance_suite Compliance suite

Compliance suite.
connection_initiation_mode Connection initiation mode

Connection initiation mode used by local endpoint to
establish ike connection with peer site.
INITIATOR - In this mode local endpoint initiates
tunnel setup and will also respond to incoming tunnel
setup requests from peer gateway.
RESPOND_ONLY - In this mode, local endpoint shall only
respond to incoming tunnel setup requests. It shall not
initiate the tunnel setup.
ON_DEMAND - In this mode local endpoint will initiate
tunnel creation once first packet matching the policy
rule is received and will also respond to incoming
initiation request.
Default: "INITIATOR"
description Description of this resource string Maximum length: 1024
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
dpd_profile_path Dead peer detection (DPD) profile path

Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.
enabled Enable/Disable IPSec VPN session

Enable/Disable IPSec VPN session.
boolean Default: "True"
force_whitelisting Flag to add default whitelisting Gateway Policy rule for the VTI interface.

If true the default firewall rule Action is set to DROP, otherwise set to ALLOW.
This filed is deprecated and recommended to change Rule action filed. Note that this
filed is not synchornied with default rule field.
boolean Deprecated
Default: "False"
id Unique identifier of this resource string Sortable
ike_profile_path Internet key exchange (IKE) profile path

Policy path referencing IKE profile to be used. Default is set according to system default profile.
local_endpoint_path Local endpoint path

Policy path referencing Local endpoint.
string Required
marked_for_delete Indicates whether the intent object is marked for deletion

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.
boolean Readonly
Default: "False"
overridden Indicates whether this object is the overridden intent object

Global intent objects cannot be modified by the user.
However, certain global intent objects can be overridden locally by use
of this property. In such cases, the overridden local values take
precedence over the globally defined values for the properties.
boolean Readonly
Default: "False"
parent_path Path of its parent

Path of its parent
string Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
peer_address IPV4 address of peer endpoint on remote site

Public IPV4 address of the remote device terminating the VPN connection.
string Required
peer_id Peer id

Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer.
string Required
psk Pre-shared key

IPSec Pre-shared key. Maximum length of this field is 128 characters.
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RouteBasedIPSecVpnSession IPSecVpnSessionResourceType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
tcp_mss_clamping TCP MSS Clamping

TCP Maximum Segment Size Clamping Direction and Value.
tunnel_interfaces IP Tunnel interfaces

IP Tunnel interfaces.
array of IPSecVpnTunnelInterface Required
Minimum items: 1
Maximum items: 1
tunnel_profile_path IPSec tunnel profile path

Policy path referencing Tunnel profile to be used. Default is set to system default profile.
unique_id A unique identifier assigned by the system

This is a UUID generated by the GM/LM to uniquely identify
entites in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
string Readonly