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 None
Operational Data URI /axapi/v3/class-list/{name}/oper
Schema class-list schema

Operations Allowed:

OperationMethodURIPayload

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

class-list-list

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

class-list-list : [

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

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  

cid

Description

Type: number

Range: 1-32

ipv4addr

Description Specify IP address

Type: string

Format: ipv4-cidr

str-list

Specification Value
Type list
Block object keys  

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

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

ipv6-list

Specification Value
Type list
Block object keys  

cid

Description

Type: number

Range: 1-32

ipv6-addr

Description Specify IPv6 host or subnet

Type: string

Format: ipv6-address-plen

dns

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

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