HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/classes/{Class.name},{Class.type}/cfg_entries

Path Params
string
required

Reference Resource: Class
Name of a Classifier Class (Class).

string
enum
required

Reference Resource: Class
Type of a Class.

Allowed:
Body Params
string
length ≤ 256

Comment to associate with the specified class entry. This column value can be empty.

boolean

Class entry attribute count action: when true, increment hit count for packets that match this Class.

integer
0 to 63

Differentiated Services Code Point matching attribute. An empty column value indicates that this qualifier will not be used to match packets. DSCP match is not supported when class type is gbp*

string
length between 7 and 79

Destination IP matching attribute: If no IP address is specified, the Class entry will not match on destination IP address. The following IPv4 and IPv6 address formats are accepted. IPv4 format (A.B.C.D/W.X.Y.Z) IPv6 format (A:B::C:D/W:X::Y:Z) If an invalid format is used via REST, it will be accepted. Verify configurations are valid by checking for error log messages and configuration warnings in CLI. An empty column value indicates that this qualifier will not be used to match packets. Destination IP match is not supported when class type is gbp*

integer
0 to 65535

Maximum IP destination port matching attribute: Used in conjunction with dst_l4_port_min and dst_l4_port_range_reverse. An empty column value indicates that this qualifier will not be used to match packets.

integer
0 to 65535

Minimum IP destination port matching attribute: Used in conjunction with dst_l4_port_max and dst_l4_port_range_reverse. An empty column value indicates that this qualifier will not be used to match packets.

string
length between 1 and 29

Destination MAC matching attribute: AAAA.BBBB.CCCC/XXXX.YYYY.ZZZZ If an invalid format is used via REST, it will be accepted. Verify configurations are valid by checking for error log messages and configuration warnings in CLI. An empty column value indicates that this qualifier will not be used to match packets. Destination MAC match is not supported when class type is gbp*

string
length ≤ 128

Destination role matching attribute. An empty column value indicates that this qualifier will not be used to match packets.

integer
0 to 3

Explicit Congestion Notification matching attribute. An empty column value indicates that this qualifier will not be used to match packets. Explicit Congestion match is not supported when class type is gbp*

integer
0 to 65535

Ethernet type matching attribute. An empty column value indicates that this qualifier will not be used to match packets.

boolean

Fragment matching attribute. If not specified, the class entry will not restrict matching to fragmented packets.

integer
0 to 255

ICMP code matching attribute. An empty column value indicates that this qualifier will not be used to match packets.

integer
0 to 255

ICMP type matching attribute. An empty column value indicates that this qualifier will not be used to match packets.

integer
0 to 7

IP Precedence matching attribute. An empty column value indicates that this qualifier will not be used to match packets. IP Precedence match is not supported when class type is gbp*

string
enum

Origin of the class-entry, i.e., how the class-entry is provisioned. dynamic: class entry is provisioned dynamically via DUR from Clearpass server or via a NAS-Filter-Rule attribute from a RADIUS server. synthesized: class entry has been dynamically synthesized by the system. static: class entry is provisioned by the administrator via CLI or REST.

Allowed:
integer
0 to 7

Priority Code Point matching attribute. An empty column value indicates that this qualifier will not be used to match packets. PCP match is not supported when class type is gbp*

integer
0 to 255

IPv4 protocol matching attribute. An empty column value indicates that this qualifier will not be used to match packets.

integer
required

Reference Resource: Class_Entry
Class entries as configured by the user. An empty column value indicates that no match criteria is specified for this list.

string
length between 7 and 79

Source IP matching attribute: If no IP address is specified, the Class entry will not match on source IP address. The following IPv4 and IPv6 address formats are accepted. IPv4 format (A.B.C.D/W.X.Y.Z) IPv6 format (A:B::C:D/W:X::Y:Z) If an invalid format is used via REST, it will be accepted. Verify configurations are valid by checking for error log messages and configuration warnings in CLI. An empty column value indicates that this qualifier will not be used to match packets. Source IP match is not supported when class type is gbp*

integer
0 to 65535

Maximum L4 port to match on the packet. An empty column value indicates that this qualifier will not be used to match packets.

integer
0 to 65535

Minimum L4 port to match on the packet. An empty column value indicates that this qualifier will not be used to match packets.

string
length between 1 and 29

Source MAC matching attribute: AAAA.BBBB.CCCC/XXXX.YYYY.ZZZZ If an invalid format is used via REST, it will be accepted. Verify configurations are valid by checking for error log messages and configuration warnings in CLI. An empty column value indicates that this qualifier will not be used to match packets. Source MAC match is not supported when class type is gbp*

string
length ≤ 128

Source role matching attribute. An empty column value indicates that this qualifier will not be used to match packets.

boolean

TCP ACK flag matching attribute.

boolean

TCP CWR flag matching attribute.

boolean

TCP ECE flag matching attribute.

boolean

Match packets that are in an established state, (ACK or RST flag is set). If not specified, the class entry will not restrict matching to established TCP connections.

boolean

TCP FIN flag matching attribute.

boolean

TCP PSH flag matching attribute.

boolean

TCP RST flag matching attribute.

boolean

TCP SYN flag matching attribute.

boolean

TCP URG flag matching attribute.

integer
0 to 31

IP Type of Service value matching attribute. An empty column value indicates that this qualifier will not be used to match packets. IP Type of Service match is not supported when class type is gbp*

integer
0 to 255

Time-to-live matching attribute. An empty column value indicates that this qualifier will not be used to match packets.

string
enum

Type of a class entry: 'match': corresponding policy actions will be performed on the matching packets. 'ignore': matching packets will be processed as if no policy was applied. An empty column value indicates that this qualifier will not be used to match packets.

Allowed:
integer
1 to 4094

VLAN-ID matching attribute. An empty column value indicates that this qualifier will not be used to match packets. VLAN-ID match is not supported when class type is gbp*

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
Response
Click Try It! to start a request and see the response here!