Developer Documentation


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.


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 authentication_mode string

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.

optional children array of ChildPolicyConfigResource

subtree for this type within policy tree containing nested elements.

optional compliance_suite string

Compliance suite.

optional connection_initiation_mode string

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.

optional description string

Description of this resource

optional display_name string

Defaults to ID if not set

optional dpd_profile_path string

Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.

optional enabled boolean

Enable/Disable IPSec VPN session.

optional force_whitelisting boolean

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.

optional id string

Unique identifier of this resource

optional ike_profile_path string

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

optional local_endpoint_path string

Policy path referencing Local endpoint.

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 path string

Absolute path of this object

optional peer_address string

Public IPV4 address of the remote device terminating the VPN connection.

optional peer_id string

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.

optional psk string

IPSec Pre-shared key. Maximum length of this field is 128 characters.

optional relative_path string

Path relative from its parent

optional resource_type string

The type of this resource.

optional tags array of Tag

Opaque identifiers meaningful to the API user

optional tcp_mss_clamping TcpMaximumSegmentSizeClamping

TCP Maximum Segment Size Clamping Direction and Value.

optional tunnel_interfaces array of IPSecVpnTunnelInterface

IP Tunnel interfaces.

optional tunnel_profile_path string

Policy path referencing Tunnel profile to be used. Default is set to system default profile.



Was this page helpful?