session-filter

Create a convenience Filter to display/clear sessions

session-filter Specification

Parameter Value
Type Collection
Object Key(s) name
Collection Name session-filter-list
Collection URI /axapi/v3/session-filter
Element Name session-filter
Element URI /axapi/v3/session-filter/{name}
Element Attributes session-filter_attributes
Partition Visibility shared
Schema session-filter schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/session-filter

session-filter attributes

Create List

POST

/axapi/v3/session-filter

session-filter attributes

Get Object

GET

/axapi/v3/session-filter/{name}

session-filter attributes

Get List

GET

/axapi/v3/session-filter

session-filter-list

Modify Object

POST

/axapi/v3/session-filter/{name}

session-filter attributes

Replace Object

PUT

/axapi/v3/session-filter/{name}

session-filter attributes

Replace List

PUT

/axapi/v3/session-filter

session-filter-list

Delete Object

DELETE

/axapi/v3/session-filter/{name}

session-filter attributes

session-filter-list

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

session-filter-list : [

session-filter attributes

filter-cfg

Description: filter-cfg is a JSON Block. Please see below for filter-cfg

Type: Object

name

Description Session filter name

Type: string

Maximum Length: 31 characters

Maximum Length: 1 characters

set

Description Set filter criteria

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

filter-cfg

Specification Value
Type object

dest-addr

Description Forward Destination IP (Destination IP address)

Type: string

Format: ipv4-address

dest-mask

Description Forward Destination IP Subnet (Destination Netmask)

Type: string

Format: ipv4-netmask

dport2

Description Forward Destination Port (Dest Port)

Type: number

Range: 1-65535

session-type

Description ‘ipv6’: Display ipv6 sessions only; ‘sip’: SIP sessions;

Type: string

Supported Values: ipv6, sip

source-addr

Description Forward Source IP (Source IP address)

Type: string

Format: ipv4-address

source-mask

Description Forward Source IP Subnet (Source Netmask)

Type: string

Format: ipv4-netmask

source-port

Description Forward Source Port

Type: number

Range: 1-65535