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: Listfile
Description Create/Edit a class-list stored as a file
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
geo-list
Type: Listipv4-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
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 cid
Description
Type: number
Range: 1-32
ipv4addr
Description Specify IP address
Type: string
Format: ipv4-cidr
geo-list¶
Specification 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 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
ipv6-list¶
Specification 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
operational data¶
| Counter | Size | Description | |
|---|---|---|---|
| file-or-string | enum | Output contains one of the following values: - file, config | |
| ac-entries | ac-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 | |
| ipv6-entries | ipv6-entries | ||
| string-total-entries | number | string-total-entries | |
| geo-location-total-entries | number | geo-location-total-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 | ||
| geo-location-entries | geo-location-entries | ||
| ipv6-total-single-ip | number | ipv6-total-single-ip |