CoPP

Control Plane Policing.

URLs Summary

URL	GET	POST	PATCH	PUT	DELETE
/rest/v1/running/copp	Y	N	Y	N	N
/rest/v1/running/copp/group/{name}	Y	Y	Y	N	Y

Examples

Get all CoPP configurations.

GET HTTPS://{switch IP}/rest/v1/running/copp

Create a CoPP group.

POST HTTPS://{switch IP}/rest/v1/running/copp/group
{
    "name": "copp-system-lldp",
    "cir": null,
    "cbs": null
}

Properties Descriptions

CoPP groups

Tree Diagrams

  +--rw copp
     +--rw group* [name]
        +--rw name
        +--ro trap-ids*
        +--ro queue?
        +--ro trap-priority?
        +--ro trap-action?
        +--ro mode?
        +--ro meter-type?
        +--rw cbs?
        +--rw cir?
        +--ro red-packet-action?
        +--ro green-packet-action?
        +--ro yellow-packet-action?

Table of Properties

Name	Required	Type/Range	Description
copp	M		Path-only node, has no configurable value. CoPP group configuration
group	M		(sub-property of copp) Path-only node, has no configurable value. List of CoPP group
name	M	”copp-system-ttl_err" "copp-system-static_fdb_move" "copp-system-bgp" "copp-system-bfd" "copp-system-ospf" "copp-system-vrrp" "copp-system-isis" "copp-system-lacp" "copp-system-stp" "copp-system-arp" "copp-system-neigh_discovery" "copp-system-macsec" "copp-system-lldp" "copp-system-igmp" "copp-system-udld" "copp-system-pim" "copp-system-dhcp_relay" "copp-system-sflow" "copp-system-ip2me" "copp-system-nat" "copp-system-ptp" "copp-system-pvrst" "copp-system-vrrpv6" "copp-system-mld" "copp-system-ssh" "copp-system-snmp" "copp-system-l3_mtu_error" "copp-system-ldp”	(sub-property of group) CoPP group class name; Current platform support names like “copp-system-xxx” that define specific class
trap-ids	RO	”bgp""bgpv6""bfd" "bfdv6""ospf""ospfv6" "vrrp""isis""lacp" "stp""arp_req""arp_resp" "neigh_discovery""eapol" "src_nat_miss""dest_nat_miss" "lldp""udld""dhcp" "dhcpv6""ip2me""igmp_query" "igmp_leave""igmp_v1_report" "igmp_v2_report""igmp_v3_report" "sample_packet""static_fdb_move" "ttl_error""pim""ptp" "pvrst""vrrpv6""mld_v1_v2" "mld_v1_report""mld_v2_report" "mld_v1_done""ssh" "l3_mtu_error""snmp""ldp”	(sub-property of group) Value of trap ids does not support to configure; Trap-ids mostly is associated with class-name, for examle: isis is the trap-id of copp-system-isis. Here’re some special trap-ids worthy of remark: bgp, bgpv6 -> copp-system-bgp bfd, bfdv6 -> copp-system-bfd ospf, ospfv6 -> copp-system-ospf arp_req, arp_resp -> copp-system-arp src_nat_miss, dest_nat_miss -> copp-system-nat igmp_query, igmp_leave, igmg_v1_report, igmp_v2_report, igmp_v3_report -> copp-system-igmp
queue	RO	0..7	(sub-property of group) CPU Rx queue
Default value: 0
trap-priority	RO	0..255	(sub-property of group) Trap priority; Normally the same as queue
trap-action	RO	”drop""trap" "copy""forward”	(sub-property of group) COPP trap action refers to how a network device responds when it detects traffic that exceeds the configured limits or matches specific policies
mode	RO	”sr-tcm""tr-tcm”	(sub-property of group) Policer mode. Default value: “sr-tcm”
meter-type	RO	”packets""bytes”	(sub-property of group) Policer meter type. Default value: “bytes”
cbs	O	0 1000..400000000000	(sub-property of group) Committed burst size for the dual-rate token bucket policer. This value represents the depth of the token bucket. If platform is innovium, the value of cbs must greater than (cir * 128 / 1000000)
cir	O	0 1000..400000000000	(sub-property of group) Committed information rate for the dual-rate token bucket policer.This value represents the rate at which tokens are added to the primary bucket.
red-packet-action	RO	”drop""trap" "copy""forward”	(sub-property of group) Red packet action refers to a specific action taken when packets that are deemed critical or potentially harmful are detected. Default value: “drop”
green-packet-action	RO	”drop""trap" "copy""forward”	(sub-property of group) Green packet action refers to handling packets that are considered safe and fall within acceptable limits.
yellow-packet-action	RO	”drop""trap" "copy""forward”	(sub-property of group) Yellow packet action refers to how a network device handles packets that are classified as potentially problematic but not immediately harmful