vpn ipsec-group¶

IPsec tunnel Groupings

ipsec-group Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name ipsec-group-list

Collection URI /axapi/v3/vpn/ipsec-group

Element Name ipsec-group

Element URI /axapi/v3/vpn/ipsec-group/{name}

Element Attributes ipsec-group_attributes

Partition Visibility shared

Schema ipsec-group schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/vpn/ipsec-group	ipsec-group attributes
POST /axapi/v3/vpn/ipsec-group/ Payload: { "ipsec-group": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/vpn/ipsec-group	ipsec-group attributes
Get Object	GET	/axapi/v3/vpn/ipsec-group/{name}	ipsec-group attributes
Get List	GET	/axapi/v3/vpn/ipsec-group	ipsec-group-list
Modify Object	POST	/axapi/v3/vpn/ipsec-group/{name}	ipsec-group attributes
Replace Object	PUT	/axapi/v3/vpn/ipsec-group/{name}	ipsec-group attributes
Replace List	PUT	/axapi/v3/vpn/ipsec-group	ipsec-group-list
Delete Object	DELETE	/axapi/v3/vpn/ipsec-group/{name}	ipsec-group attributes

ipsec-group-list¶

ipsec-group-list is JSON List of ipsec-group attributes

ipsec-group-list : [

{ ipsec-group attributes },

{ ipsec-group attributes },

…

]

ipsec-group attributes¶

ipsecgroup-cfg

Type: List

name

Description Group name

Type: string

Maximum Length: 31 characters

Maximum Length: 1 characters

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ipsecgroup-cfg¶

Specification Value

Type list

Block object keys

ipsec

Description specify a name to group active/backup tunnels

Type: string

Maximum Length: 31 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/vpn/ipsec

priority

Description Highest priority value is the active tunnel

Type: number

Range: 1-10