class-list

Configure classification list.

class-list Specification

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
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

Create List

POST

/axapi/v3/class-list/

class-list Attributes

Get Object

GET

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

class-list Attributes

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

Replace List

PUT

/axapi/v3/class-list/

class-list-list

Delete Object

DELETE

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

class-list Attributes

Get Oper

GET

/axapi/v3/class-list/{name}/oper

operational data

class-list-list

class-list-list is JSON List of class-list Attributes

class-list-list : [

class-list Attributes

ac-list

Description: ac-list is a JSON List . Please see below for ac-list

Type: List

dns

Description: dns is a JSON List . Please see below for dns

Type: List

file

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

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv4-list

Description: ipv4-list is a JSON List . Please see below for ipv4-list

Type: List

ipv6-list

Description: ipv6-list is a JSON List . Please see below for ipv6-list

Type: List

name

Description: Specify name of the class list

Type: string

Format: string-rlx

Required: Yes

str-list

Description: str-list is a JSON List . Please see below for 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;

Type: string

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

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

ipv4-list

Specification
Type list
Block object keys

glid

Description: Use global Limit ID (Specify global LID index)

Type: number

Range: 1-1023

Mutual Exclusion: glid and lid are mutually exclusive

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-31

Mutual Exclusion: lid and glid are mutually exclusive

lsn-lid

Description: LSN Limit ID (LID index)

Type: number

Range: 1-1023

lsn-radius-profile

Description: LSN RADIUS Profile Index

Type: number

Range: 1-16

str-list

Specification
Type list
Block object keys

str

Description: Specify key string

Type: string

Format: string-rlx

str-glid

Description: Global LID index

Type: number

Range: 1-1023

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-lid

Description: LID index

Type: number

Range: 1-31

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

ac-list

Specification
Type list
Block object keys

ac-key-string

Description: Specify key string

Type: string

Format: string-rlx

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

ipv6-list

Specification
Type list
Block object keys

ipv6-addr

Description: Specify IPv6 host or subnet

Type: string

Format: ipv6-address-plen

v6-glid

Description: Use global Limit ID (Specify global LID index)

Type: number

Range: 1-1023

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

v6-lid

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

Type: number

Range: 1-31

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

v6-lsn-lid

Description: LSN Limit ID (LID index)

Type: number

Range: 1-1023

v6-lsn-radius-profile

Description: LSN RADIUS Profile Index

Type: number

Range: 1-16

dns

Specification
Type list
Block object keys

dns-glid

Description: Use global Limit ID (Specify global LID index)

Type: number

Range: 1-1023

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

dns-lid

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

Type: number

Range: 1-31

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

dns-match-string

Description: Domain name

Type: string

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

operational data

Name Type Description
file-or-string enum Output contains one of the following values: - file, config
string-entries string-entries
dns-entries dns-entries
ipv4-entries ipv4-entries
user-tag string user-tag
ipv6-entries ipv6-entries
ac-entries ac-entries
type enum Output contains one of the following values: - ac, dns, ipv4, ipv6, string, string-case-insensitive, [ipv4], [ipv6], [dns], [dns, ipv4], [dns, ipv6]