InlineIPSecVpnSession1

JSON Example

{
    "authentication_mode": "string",
    "compliance_suite": "string",
    "connection_initiation_mode": "string",
    "dpd_profile_path": "string",
    "enabled": false,
    "ike_profile_path": "string",
    "local_endpoint_path": "string",
    "peer_address": "string",
    "peer_id": "string",
    "psk": "string",
    "resource_type": "string",
    "tcp_mss_clamping": {
        "direction": "string",
        "max_segment_size": 0
    },
    "tunnel_profile_path": "string"
}

string

authentication_mode

Optional

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.

Possible values are : PSK, CERTIFICATE,

string

compliance_suite

Optional

Compliance suite.

Possible values are : CNSA, SUITE_B_GCM_128, SUITE_B_GCM_256, PRIME, FOUNDATION, FIPS, NONE,

string

connection_initiation_mode

Optional

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.

Possible values are : INITIATOR, RESPOND_ONLY, ON_DEMAND,

string

dpd_profile_path

Optional

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

boolean

enabled

Optional

Enable/Disable IPSec VPN session.

string

ike_profile_path

Optional

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

string

local_endpoint_path

Required

Policy path referencing Local endpoint.

string

peer_address

Required

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

string

peer_id

Required

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

psk

Optional

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

string

resource_type

Required

A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet. 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.

Possible values are : PolicyBasedIPSecVpnSession, RouteBasedIPSecVpnSession,

TcpMaximumSegmentSizeClamping

tcp_mss_clamping

Optional

TCP MSS Clamping Direction and Value.

string

tunnel_profile_path

Optional

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

Used By

IPSecVpnSession