class-list¶

Configure classification list

class-list Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name class-list-list

Collection URI /axapi/v3/class-list

Element Name class-list

Element URI /axapi/v3/class-list/{name}

Element Attributes class-list_attributes

Partition Visibility shared

Operational Data URI /axapi/v3/class-list/{name}/oper

Schema class-list schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/class-list	class-list attributes
POST /axapi/v3/class-list/ Payload: { "class-list": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/class-list	class-list attributes
Get Object	GET	/axapi/v3/class-list/{name}	class-list attributes
GET /axapi/v3/class-list/a Reponse: { "class-list": { "name": "a", "file": 0, "uuid": "674c1be6-5032-11ee-b31e-61a3d9cb4d7f", "user-tag": "a", "a10-url": "/axapi/v3/class-list/a" } }
Get List	GET	/axapi/v3/class-list	class-list-list
Modify Object	POST	/axapi/v3/class-list/{name}	class-list attributes
Replace Object	PUT	/axapi/v3/class-list/{name}	class-list attributes
PUT /axapi/v3/class-list/a Payload: { "class-list": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/class-list	class-list-list
Delete Object	DELETE	/axapi/v3/class-list/{name}	class-list attributes
DELETE /axapi/v3/class-list/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

class-list-list¶

class-list-list is JSON List of class-list attributes

class-list-list : [

{ class-list attributes },

{ class-list attributes },

…

]

class-list attributes¶

ac-list

Type: List

dns

Type: List

file

Description Create/Edit a class-list stored as a file

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

geo-list

Type: List

ipv4-list

Type: List

ipv6-list

Type: List

name

Description Specify name of the class list

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

str-list

Type: List

type

Description ‘ac’: Make class-list type Aho-Corasick; ‘dns’: Make class-list type DNS; ‘ipv4’: Make class-list type IPv4; ‘ipv6’: Make class-list type IPv6; ‘string’: Make class-list type String; ‘string-case-insensitive’: Make class-list type String-case-insensitive. Case insensitive is applied to key string;

Type: string

Supported Values: ac, dns, ipv4, ipv6, string, string-case-insensitive

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

ipv4-list¶

Specification Value

Type list

Block object keys

age

Description Specify age in minutes

Type: number

Range: 1-2000

glid

Description Use global Limit ID (Specify global LID index)

Type: string

Format: string-rlx

Maximum Length: 1023 characters

Maximum Length: 1 characters

Mutual Exclusion: glid,lid, shared-partition-glid, lsn-lid, lsn-radius-profile, and gtp-rate-limit-policy-v4 are mutually exclusive

Reference Object: /axapi/v3/glid

glid-shared

Description Use global Limit ID

Type: string

Format: string-rlx

Maximum Length: 1023 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

gtp-rate-limit-policy-v4

Description GTP Rate Limit Template Name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: gtp-rate-limit-policy-v4,lid, glid, lsn-lid, and lsn-radius-profile are mutually exclusive

Reference Object: /axapi/v3/template/gtp/rate-limit-policy

ipv4addr

Description Specify IP address

Type: string

Format: ipv4-cidr

lid

Description Use Limit ID defined in template (Specify LID index)

Type: number

Range: 1-1023

Mutual Exclusion: lid,glid-num, glid, lsn-lid, lsn-radius-profile, gtp-rate-limit-policy-v4, v6-glid, and dns-glid are mutually exclusive

lsn-lid

Description LSN Limit ID (LID index)

Type: number

Range: 1-1023

Mutual Exclusion: lsn-lid,lid, glid, lsn-radius-profile, and gtp-rate-limit-policy-v4 are mutually exclusive

lsn-radius-profile

Description LSN RADIUS Profile Index

Type: number

Range: 1-16

Mutual Exclusion: lsn-radius-profile,lid, glid, lsn-lid, and gtp-rate-limit-policy-v4 are mutually exclusive

shared-partition-glid

Description Reference a glid from shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared-partition-glid and glid are mutually exclusive

str-list¶

Specification Value

Type list

Block object keys

shared-partition-str-glid

Description Reference a glid from shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared-partition-str-glid and str-glid are mutually exclusive

str

Description Specify key string

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

str-glid

Description Global LID index

Type: string

Format: string-rlx

Maximum Length: 1023 characters

Maximum Length: 1 characters

Mutual Exclusion: str-glid and shared-partition-str-glid are mutually exclusive

Reference Object: /axapi/v3/glid

str-glid-dummy

Description Use global Limit ID

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: str-glid-dummy and str-lid-dummy are mutually exclusive

str-glid-shared

Description Use global Limit ID

Type: string

Format: string-rlx

Maximum Length: 1023 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

str-lid

Description LID index

Type: number

Range: 1-1023

str-lid-dummy

Description Use Limit ID defined in template

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: str-lid-dummy and str-glid-dummy are mutually exclusive

value-str

Description Specify value string

Type: string

Format: string-rlx

Maximum Length: 639 characters

Maximum Length: 1 characters

geo-list¶

Specification Value

Type list

Block object keys

geo-location

Description Specify geo-location

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

geo-location-ipv6

Description Specify IPv6 geo-location

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

ac-list¶

Specification Value

Type list

Block object keys

ac-key-string

Description Specify key string

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

ac-match-type

Description ‘contains’: String contains another string; ‘ends-with’: String ends with another string; ‘equals’: String equals another string; ‘starts-with’: String starts with another string;

Type: string

Supported Values: contains, ends-with, equals, starts-with

ac-value

Description Specify value string

Type: string

Format: string-rlx

Maximum Length: 639 characters

Maximum Length: 1 characters

Mutual Exclusion: ac-value and gtp-rate-limit-policy-str are mutually exclusive

gtp-rate-limit-policy-str

Description GTP Rate Limit Template Name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: gtp-rate-limit-policy-str and ac-value are mutually exclusive

Reference Object: /axapi/v3/template/gtp/rate-limit-policy

ipv6-list¶

Specification Value

Type list

Block object keys

gtp-rate-limit-policy-v6

Description GTP Rate Limit Template Name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: gtp-rate-limit-policy-v6,v6-lid, v6-glid, v6-lsn-lid, and v6-lsn-radius-profile are mutually exclusive

Reference Object: /axapi/v3/template/gtp/rate-limit-policy

ipv6-addr

Description Specify IPv6 host or subnet

Type: string

Format: ipv6-address-plen

shared-partition-v6-glid

Description Reference a glid from shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared-partition-v6-glid and v6-glid are mutually exclusive

v6-age

Description Specify age in minutes

Type: number

Range: 1-2000

v6-glid

Description Use global Limit ID (Specify global LID index)

Type: string

Format: string-rlx

Maximum Length: 1023 characters

Maximum Length: 1 characters

Mutual Exclusion: v6-glid,lid, shared-partition-v6-glid, v6-lsn-lid, v6-lsn-radius-profile, and gtp-rate-limit-policy-v6 are mutually exclusive

Reference Object: /axapi/v3/glid

v6-glid-shared

Description Use global Limit ID

Type: string

Format: string-rlx

Maximum Length: 1023 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

v6-lid

Description Use Limit ID defined in template (Specify LID index)

Type: number

Range: 1-1023

Mutual Exclusion: v6-lid,glid-v6, v6-lsn-lid, v6-lsn-radius-profile, and gtp-rate-limit-policy-v6 are mutually exclusive

v6-lsn-lid

Description LSN Limit ID (LID index)

Type: number

Range: 1-1023

Mutual Exclusion: v6-lsn-lid,v6-lid, v6-glid, v6-lsn-radius-profile, and gtp-rate-limit-policy-v6 are mutually exclusive

v6-lsn-radius-profile

Description LSN RADIUS Profile Index

Type: number

Range: 1-16

Mutual Exclusion: v6-lsn-radius-profile,v6-lid, v6-glid, v6-lsn-lid, and gtp-rate-limit-policy-v6 are mutually exclusive

dns¶

Specification Value

Type list

Block object keys

dns-glid

Description Use global Limit ID (Specify global LID index)

Type: string

Format: string-rlx

Maximum Length: 1023 characters

Maximum Length: 1 characters

Mutual Exclusion: dns-glid, lid, and shared-partition-dns-glid are mutually exclusive

Reference Object: /axapi/v3/glid

dns-glid-shared

Description Use global Limit ID

Type: string

Format: string-rlx

Maximum Length: 1023 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

dns-lid

Description Use Limit ID defined in template (Specify LID index)

Type: number

Range: 1-1023

Mutual Exclusion: dns-lid and glid-dns are mutually exclusive

dns-match-string

Description Domain name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

dns-match-type

Description ‘contains’: Domain contains another string; ‘ends-with’: Domain ends with another string; ‘starts-with’: Domain starts-with another string;

Type: string

Supported Values: contains, ends-with, starts-with

shared-partition-dns-glid

Description Reference a glid from shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared-partition-dns-glid and dns-glid are mutually exclusive