fw session-aging¶

Session aging

session-aging Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name session-aging-list

Collection URI /axapi/v3/fw/session-aging

Element Name session-aging

Element URI /axapi/v3/fw/session-aging/{name}

Element Attributes session-aging_attributes

Partition Visibility shared

Schema session-aging schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/fw/session-aging	session-aging attributes
POST /axapi/v3/fw/session-aging/ Payload: { "session-aging": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/fw/session-aging	session-aging attributes
Get Object	GET	/axapi/v3/fw/session-aging/{name}	session-aging attributes
GET /axapi/v3/fw/session-aging/a Reponse: { "session-aging": { "name": "a", "icmp-idle-timeout": 2, "ip-idle-timeout": 30, "uuid": "68a027ba-4fa3-11ee-8464-111a54c85a5d", "user-tag": "a", "a10-url": "/axapi/v3/fw/session-aging/a" } }
Get List	GET	/axapi/v3/fw/session-aging	session-aging-list
Modify Object	POST	/axapi/v3/fw/session-aging/{name}	session-aging attributes
Replace Object	PUT	/axapi/v3/fw/session-aging/{name}	session-aging attributes
PUT /axapi/v3/fw/session-aging/a Payload: { "session-aging": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/fw/session-aging	session-aging-list
Delete Object	DELETE	/axapi/v3/fw/session-aging/{name}	session-aging attributes
DELETE /axapi/v3/fw/session-aging/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

session-aging-list¶

session-aging-list is JSON List of session-aging attributes

session-aging-list : [

{ session-aging attributes },

{ session-aging attributes },

…

]

session-aging attributes¶

icmp-idle-timeout

Description Idle Timeout time (default 2 seconds) (Second, default 2)

Type: number

Range: 2-15000

Default: 2

ip-idle-timeout

Description Idle Timeout time(sec), default is 30 (Second)

Type: number

Range: 1-2097151

Default: 30

name

Description session-aging Template (session-aging Template name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

tcp

Description: tcp is a JSON Block. Please see below for tcp

Type: Object

Reference Object: /axapi/v3/fw/session-aging/{name}/tcp

udp

Description: udp is a JSON Block. Please see below for udp

Type: Object

Reference Object: /axapi/v3/fw/session-aging/{name}/udp

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

udp¶

Specification Value

Type object

port-cfg

Type: List

udp-idle-timeout

Description Idle Timeout (sec), default is 120 (number)

Type: number

Range: 1-2097151

Default: 120

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

udp_port-cfg¶

Specification Value

Type list

Block object keys

udp-idle-timeout

Description Idle Timeout (sec), default is 120 (number)

Type: number

Range: 1-2097151

Default: 120

udp-port

Description

Type: number

Range: 1-65535

tcp¶

Specification Value

Type object

force-delete-timeout

Description The maximum time that a session can stay in the system before being deleted, default is off (number (second))

Type: number

Range: 1-31

Mutual Exclusion: force-delete-timeout and force-delete-timeout-100ms are mutually exclusive

force-delete-timeout-100ms

Description The maximum time that a session can stay in the system before being deleted, default is off (number in 100ms)

Type: number

Range: 1-31

Mutual Exclusion: force-delete-timeout-100ms and force-delete-timeout are mutually exclusive

half-close-idle-timeout

Description TCP Half Close Idle Timeout (sec), default is off (number)

Type: number

Range: 60-120

half-open-idle-timeout

Description TCP Half Open Idle Timeout (sec), default is off (number)

Type: number

Range: 1-60

port-cfg

Type: List

tcp-idle-timeout

Description Idle Timeout (sec), default is 600 (number)

Type: number

Range: 1-2097151

Default: 600

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

tcp_port-cfg¶

Specification Value

Type list

Block object keys

force-delete-timeout

Description The maximum time that a session can stay in the system before being deleted, default is off (number (second))

Type: number

Range: 1-31

Mutual Exclusion: force-delete-timeout and force-delete-timeout-100ms are mutually exclusive

force-delete-timeout-100ms

Description The maximum time that a session can stay in the system before being deleted, default is off (number in 100ms)

Type: number

Range: 1-31

Mutual Exclusion: force-delete-timeout-100ms and force-delete-timeout are mutually exclusive

half-close-idle-timeout

Description TCP Half Close Idle Timeout (sec), default is off (number)

Type: number

Range: 60-120

half-open-idle-timeout

Description TCP Half Open Idle Timeout (sec), default is off (number)

Type: number

Range: 1-60

tcp-idle-timeout

Description Idle Timeout (sec), default is 600 (number)

Type: number

Range: 1-2097151

tcp-port

Description

Type: number

Range: 1-65535