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 schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/class-list | ||
Create List | POST | /axapi/v3/class-list | ||
Get Object | GET | /axapi/v3/class-list/{name} | ||
Get List | GET | /axapi/v3/class-list | ||
Modify Object | POST | /axapi/v3/class-list/{name} | ||
Replace Object | PUT | /axapi/v3/class-list/{name} | ||
Replace List | PUT | /axapi/v3/class-list | ||
Delete Object | DELETE | /axapi/v3/class-list/{name} |
class-list-list¶
class-list-list is JSON List of class-list attributes
class-list-list : [
]
class-list attributes¶
ac-list
Type: Listdns
Type: Listfile
Description Create/Edit a class-list stored as a file
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv4-list
Type: Listipv6-list
Type: Listname
Description Specify name of the class list
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
str-list
Type: Listtype
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 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: number
Range: 1-1023
Mutual Exclusion: glidlid, shared-partition-glid, lsn-lid, lsn-radius-profile and gtp-rate-limit-policy-v4 are mutually exclusive
Reference Object: /axapi/v3/glid
glid-shared
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-v4lid, 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: lidglid-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-lidlid, 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-profilelid, 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 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: number
Range: 1-1023
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
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
ac-list¶
Specification 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 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-v6v6-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: number
Range: 1-1023
Mutual Exclusion: v6-glidlid, 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
v6-lid
Description Use Limit ID defined in template (Specify LID index)
Type: number
Range: 1-1023
Mutual Exclusion: v6-lidglid-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-lidv6-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-profilev6-lid, v6-glid, v6-lsn-lid and gtp-rate-limit-policy-v6 are mutually exclusive
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 lid and shared-partition-dns-glid are mutually exclusive
Reference Object: /axapi/v3/glid
dns-glid-shared
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
operational data¶
| Counter | Size | Description | |
|---|---|---|---|
| file-or-string | enum | Output contains one of the following values: - file, config | |
| ipv6-entries | ipv6-entries | ||
| ac-total-entries | number | ac-total-entries | |
| ipv6-total-subnet | number | ipv6-total-subnet | |
| dns-total-entries | number | dns-total-entries | |
| ipv4-total-subnet | number | ipv4-total-subnet | |
| dns-entries | dns-entries | ||
| ipv4-entries | ipv4-entries | ||
| ipv4-total-single-ip | number | ipv4-total-single-ip | |
| user-tag | string | user-tag | |
| geo-total-entries | number | geo-total-entries | |
| string-total-entries | number | string-total-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] | |
| string-entries | string-entries | ||
| ipv6-total-single-ip | number | ipv6-total-single-ip |