Configuring Control Plane Policing

Control Plane Policing (CoPP) allows a policy map to be applied to the control plane. The policy map is applied to all traffic entering the switch from a non-management port in order to prevent DoS attacks from impacting performance.

This section contains payload examples and CLIs to demonstrate how to use the NX-API REST API to configure COPP on Cisco Nexus 3000 and 9000 Series switches and to show how the REST APIs correspond to the CLI commands. For more information about ARP, see the Cisco Nexus 9000 Series NX-OS Security Configuration Guide.

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Creating a Class Map

Creating a Class Map
POST http://<IP_Address>/api/node/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "cmap1",
            "flag": "no"
}}},{
        "coppClass": {
          "attributes": {
            "cName": "match-any",
            "matchOption": "MatchAny"
}}}]}}

This example creates a class-map and a 'match-any' class.

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Class Map

Configuring a Class Map
POST http://<IP_Address>/api/node/mo/sys/copp.json
{
  "coppClass": {
    "attributes": {
      "cName": "cmap1",
      "flag": "no"
    },
    "children": [
      {
        "coppMulticast": {
          "attributes": {
            "flag": "no",
            "mcastOption": "rpf-failure"
}}},{
        "coppExeOptions": {
          "attributes": {
            "flag": "no",
            "option": "mtu-failure"
}}},{
        "coppIp": {
          "attributes": {
            "flag": "no",
            "options": "yes"
}}},{
        "coppIpv6Icmp": {
          "attributes": {
            "flag": "no",
            "option": "unreachable"
}}},{
        "coppProtocol": {
          "attributes": {
            "flag": "no",
            "type": "arp"
}}}]}}

This example configures the class map.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

match protocol arp
match exception mtu-failure
match exception ip option
match exception ipv6 icmp unreachable
match exception multicast rpf-failure

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppClass sys/copp/classp-{cName}
coppMulticast sys/copp/classp-{cName}/mcast-{mcastOption}
coppExeOptions sys/copp/classp-{cName}/excep-{option}
coppIp sys/copp/classp-{cName}/ip
coppIpv6Icmp sys/copp/classp-{cName}/icmpv6-{option}
coppProtocol sys/copp/classp-{cName}/prot-{type}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppMulticast Properties

The following table contains information about the coppMulticast properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
mcastOptioncopp:Mcast
(scalar:Enum8)
Multicast optionsSELECTION:
0 - Undefined
1 - dest-miss
2 - rpf-failure
3 - sg-rpf-failure
4 - ipv6-dest-miss
5 - ipv6-rpf-failure
6 - ipv6-sg-rpf-failure
DEFAULT: Undefined


coppExeOptions Properties

The following table contains information about the coppExeOptions properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optioncopp:Excep
(scalar:Enum16)
Match optionsSELECTION:
0 - Undefined
1 - glean
2 - mtu-failure
3 - ttl-failure
4 - nat-flow
5 - sflow
6 - mvpn
DEFAULT: Undefined


coppIp Properties

The following table contains information about the coppIp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optionsscalar:Bool
Ip OptionSELECTION: true or false


coppIpv6Icmp Properties

The following table contains information about the coppIpv6Icmp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optioncopp:Icmp
(scalar:Enum8)
icmp optionsSELECTION:
0 - Undefined
1 - redirect
2 - unreachable
DEFAULT: Undefined


coppProtocol Properties

The following table contains information about the coppProtocol properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
typecopp:Proto
(scalar:Bitmask64)
Protocol ListSELECTION:
1 - bgp
2 - ospf
4 - cdp
8 - traceroute
16 - lldp
32 - lacp
64 - isis
128 - arp
256 - dhcp
512 - igmp
1024 - icmp
2048 - zmq
4096 - mgmt
8192 - snmp
16384 - stp
32768 - bfd
65536 - pim
131072 - static
262144 - ifc
524288 - mpls
1048576 - mplsexp6
2097152 - mplsralert


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Match for IPv4 Option Exception Packets

Configuring a Match for IPv4 Option Exception Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
"coppEntity": {
  "children": [
    {
      "coppClass": {
        "attributes": {
          "cName": "CMAP",
          "flag": "no"
        },
        "children": [
          {
            "coppIp": {
              "attributes": {
                "flag": "no",
                "options": "yes"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <ip-items>
          <flag>false</flag>
          <options>true</options>
        </ip-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception ip option

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppIp sys/copp/classp-{cName}/ip


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppIp Properties

The following table contains information about the coppIp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optionsscalar:Bool
Ip OptionSELECTION: true or false


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for IPv4 Option Exception Packets

Deleting a Match for IPv4 Option Exception Packets 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/ip
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception ip option

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for Redirected IPv4 ICMP Redirect Packets

 Configuring a Match for Redirected IPv4 ICMP Redirect Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppIpIcmp": {
                "attributes": {
                  "flag": "no",
                  "option": "redirect"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <icmp-items>
          <IpIcmp-list>
            <option>redirect</option>
            <flag>false</flag>
          </IpIcmp-list>
        </icmp-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception ip icmp redirect

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppIpIcmp sys/copp/classp-{cName}/icmp-{option}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppIpIcmp Properties

The following table contains information about the coppIpIcmp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optioncopp:Icmp
(scalar:Enum8)
icmp optionsSELECTION:
0 - Undefined
1 - redirect
2 - unreachable
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for Redirected IPv4 ICMP Redirect Packets

 Deleting a Match for Redirected IPv4 ICMP Redirect Packets 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/icmp-redirect.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception ip icmp redirect

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for Unreachable IPv4 ICMP Redirect Packets

 Configuring a Match for Unreachable IPv4 ICMP Redirect Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppIpIcmp": {
                "attributes": {
                  "flag": "no",
                  "option": "unreachable"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <icmp-items>
          <IpIcmp-list>
            <option>unreachable</option>
            <flag>false</flag>
          </IpIcmp-list>
        </icmp-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception ip icmp unreachable

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppIpIcmp sys/copp/classp-{cName}/icmp-{option}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppIpIcmp Properties

The following table contains information about the coppIpIcmp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optioncopp:Icmp
(scalar:Enum8)
icmp optionsSELECTION:
0 - Undefined
1 - redirect
2 - unreachable
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for Unreachable IPv4 ICMP Redirect Packets

 Deleting a Match for Unreachable IPv4 ICMP Redirect Packets 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/icmp-unreachable.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception ip icmp unreachable

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for IPv6 Option Exception Packets

 Configuring a Match for IPv6 Option Exception Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppIpv6": {
                "attributes": {
                  "flag": "no",
                  "options": "yes"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <ipv6-items>
          <flag>false</flag>
          <options>true</options>
        </ipv6-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception ipv6 option

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppIpv6 sys/copp/classp-{cName}/ipv6


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppIpv6 Properties

The following table contains information about the coppIpv6 properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optionsscalar:Bool
Ip OptionSELECTION: true or false


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for IPv6 Option Exception Packets

 Deleting a Match for IPv6 Option Exception Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/ipv6.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception ipv6 option

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for IPv6 ICMP Redirect Packets

 Configuring a Match for IPv6 ICMP Redirect Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppIpv6Icmp": {
                "attributes": {
                  "flag": "no",
                  "option": "redirect"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <icmpv6-items>
          <Ipv6Icmp-list>
            <option>redirect</option>
            <flag>false</flag>
          </Ipv6Icmp-list>
        </icmpv6-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception ipv6 icmp redirect

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppIpv6Icmp sys/copp/classp-{cName}/icmpv6-{option}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppIpv6Icmp Properties

The following table contains information about the coppIpv6Icmp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optioncopp:Icmp
(scalar:Enum8)
icmp optionsSELECTION:
0 - Undefined
1 - redirect
2 - unreachable
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for IPv6 ICMP Redirect Packets

 Deleting a Match for IPv6 ICMP Redirect Packets 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/icmpv6-redirect.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception ipv6 icmp redirect

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for Unreachable IPv6 ICMP Redirect Packets

 Configuring a Match for Unreachable IPv6 ICMP Redirect Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppIpv6Icmp": {
                "attributes": {
                  "flag": "no",
                  "option": "unreachable"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <icmpv6-items>
          <Ipv6Icmp-list>
            <option>unreachable</option>
            <flag>false</flag>
          </Ipv6Icmp-list>
        </icmpv6-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception ipv6 icmp unreachable

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppIpv6Icmp sys/copp/classp-{cName}/icmpv6-{option}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppIpv6Icmp Properties

The following table contains information about the coppIpv6Icmp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optioncopp:Icmp
(scalar:Enum8)
icmp optionsSELECTION:
0 - Undefined
1 - redirect
2 - unreachable
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for Unreachable IPv6 ICMP Redirect Packets

 Deleting a Match for Unreachable IPv6 ICMP Redirect Packets 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/icmpv6-redirect.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception ipv6 icmp unreachable

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for Exception Packets Failed in TTL

 Configuring a Match for Exception Packets Failed in TTL 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppExeOptions": {
                "attributes": {
                  "flag": "no",
                  "option": "ttl-failure"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <excep-items>
          <ExeOptions-list>
            <option>ttl-failure</option>
            <flag>false</flag>
          </ExeOptions-list>
        </excep-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception ttl-failure

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppExeOptions sys/copp/classp-{cName}/excep-{option}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppExeOptions Properties

The following table contains information about the coppExeOptions properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optioncopp:Excep
(scalar:Enum16)
Match optionsSELECTION:
0 - Undefined
1 - glean
2 - mtu-failure
3 - ttl-failure
4 - nat-flow
5 - sflow
6 - mvpn
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for Exception Packets Failed in TTL

 Deleting a Match for Exception Packets Failed in TTL 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/excep-ttl-failure.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception ttl-failure

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for Glean Exception Packets

 Configuring a Match for Glean Exception Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppExeOptions": {
                "attributes": {
                  "flag": "no",
                  "option": "glean"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <excep-items>
          <ExeOptions-list>
            <option>glean</option>
            <flag>false</flag>
          </ExeOptions-list>
        </excep-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception glean

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppExeOptions sys/copp/classp-{cName}/excep-{option}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppExeOptions Properties

The following table contains information about the coppExeOptions properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optioncopp:Excep
(scalar:Enum16)
Match optionsSELECTION:
0 - Undefined
1 - glean
2 - mtu-failure
3 - ttl-failure
4 - nat-flow
5 - sflow
6 - mvpn
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for Glean Exception Packets

 Deleting a Match for Glean Exception Packets 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/excep-glean.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception glean

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for MTU-Failed Exception Packets

 Configuring a Match for MTU-Failed Exception Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppExeOptions": {
                "attributes": {
                  "flag": "no",
                  "option": "mtu-failure"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <excep-items>
          <ExeOptions-list>
            <option>mtu-failure</option>
            <flag>false</flag>
          </ExeOptions-list>
        </excep-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception mtu-failure

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppExeOptions sys/copp/classp-{cName}/excep-{option}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppExeOptions Properties

The following table contains information about the coppExeOptions properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optioncopp:Excep
(scalar:Enum16)
Match optionsSELECTION:
0 - Undefined
1 - glean
2 - mtu-failure
3 - ttl-failure
4 - nat-flow
5 - sflow
6 - mvpn
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for MTU-Failed Exception Packets

 Deleting a Match for MTU-Failed Exception Packets 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/excep-mtu-failure.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception mtu-failure

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for IPv4 Software NAT Flow Packets

 Configuring a Match for IPv4 Software NAT Flow Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppExeOptions": {
                "attributes": {
                  "flag": "no",
                  "option": "nat-flow"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <excep-items>
          <ExeOptions-list>
            <option>nat-flow</option>
            <flag>false</flag>
          </ExeOptions-list>
        </excep-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception nat-flow

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppExeOptions sys/copp/classp-{cName}/excep-{option}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppExeOptions Properties

The following table contains information about the coppExeOptions properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
optioncopp:Excep
(scalar:Enum16)
Match optionsSELECTION:
0 - Undefined
1 - glean
2 - mtu-failure
3 - ttl-failure
4 - nat-flow
5 - sflow
6 - mvpn
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for IPv4 Software NAT Flow Packets

 Deleting a Match for IPv4 Software NAT Flow Packets 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/excep-nat-flow.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception nat-flow

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for Multicast RPF Check Failure Packets

 Configuring a Match for Multicast RPF Check Failure Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppMulticast": {
                "attributes": {
                  "flag": "no",
                  "mcastOption": "rpf-failure"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <mcast-items>
          <Multicast-list>
            <mcastOption>rpf-failure</mcastOption>
            <flag>false</flag>
          </Multicast-list>
        </mcast-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception multicast rpf-failure

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppMulticast sys/copp/classp-{cName}/mcast-{mcastOption}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppMulticast Properties

The following table contains information about the coppMulticast properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
mcastOptioncopp:Mcast
(scalar:Enum8)
Multicast optionsSELECTION:
0 - Undefined
1 - dest-miss
2 - rpf-failure
3 - sg-rpf-failure
4 - ipv6-dest-miss
5 - ipv6-rpf-failure
6 - ipv6-sg-rpf-failure
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for Multicast RPF Check Failure Packets

 Deleting a Match for Multicast RPF Check Failure Packets 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/mcast-rpf-failure.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception multicast rpf-failure

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for Multicast SG RPF Check Failure Packets

 Configuring a Match for Multicast SG RPF Check Failure Packets 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppMulticast": {
                "attributes": {
                  "flag": "no",
                  "mcastOption": "sg-rpf-failure"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <mcast-items>
          <Multicast-list>
            <mcastOption>sg-rpf-failure</mcastOption>
            <flag>false</flag>
          </Multicast-list>
        </mcast-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception multicast sg-rpf-failure

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppMulticast sys/copp/classp-{cName}/mcast-{mcastOption}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppMulticast Properties

The following table contains information about the coppMulticast properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
mcastOptioncopp:Mcast
(scalar:Enum8)
Multicast optionsSELECTION:
0 - Undefined
1 - dest-miss
2 - rpf-failure
3 - sg-rpf-failure
4 - ipv6-dest-miss
5 - ipv6-rpf-failure
6 - ipv6-sg-rpf-failure
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for Multicast SG RPF Check Failure Packets

 Deleting a Match for Multicast SG RPF Check Failure Packets 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/mcast-sg-rpf-failure.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception multicast sg-rpf-failure

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/media/dme/index.html

Configuring a Match for Layer 3 Multicast Destination Lookup Failures

 Configuring a Match for Layer 3 Multicast Destination Lookup Failures
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppMulticast": {
                "attributes": {
                  "flag": "no",
                  "mcastOption": "dest-miss"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <mcast-items>
          <Multicast-list>
            <mcastOption>dest-miss</mcastOption>
            <flag>false</flag>
          </Multicast-list>
        </mcast-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception multicast dest-miss

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppMulticast sys/copp/classp-{cName}/mcast-{mcastOption}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppMulticast Properties

The following table contains information about the coppMulticast properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
mcastOptioncopp:Mcast
(scalar:Enum8)
Multicast optionsSELECTION:
0 - Undefined
1 - dest-miss
2 - rpf-failure
3 - sg-rpf-failure
4 - ipv6-dest-miss
5 - ipv6-rpf-failure
6 - ipv6-sg-rpf-failure
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for Layer 3 Multicast Destination Lookup Failures

 Deleting a Match for Layer 3 Multicast Destination Lookup Failures 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/mcast-dest-miss.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception multicast dest-miss

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

Configuring a Match for IPv6 Multicast RPF Check Failures

 Configuring a Match for IPv6 Multicast RPF Check Failures 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppMulticast": {
                "attributes": {
                  "flag": "no",
                  "mcastOption": "ipv6-rpf-failure"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <mcast-items>
          <Multicast-list>
            <mcastOption>ipv6-rpf-failure</mcastOption>
            <flag>false</flag>
          </Multicast-list>
        </mcast-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception multicast ipv6-rpf-failure

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppMulticast sys/copp/classp-{cName}/mcast-{mcastOption}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppMulticast Properties

The following table contains information about the coppMulticast properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
mcastOptioncopp:Mcast
(scalar:Enum8)
Multicast optionsSELECTION:
0 - Undefined
1 - dest-miss
2 - rpf-failure
3 - sg-rpf-failure
4 - ipv6-dest-miss
5 - ipv6-rpf-failure
6 - ipv6-sg-rpf-failure
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for IPv6 Multicast RPF Check Failures

 Deleting a Match for IPv6 Multicast RPF Check Failures 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/mcast-ipv6-rpf-failure.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception multicast ipv6-rpf-failure

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

Configuring a Match for IPv6 Multicast SG RPF Check Failures

 Configuring a Match for IPv6 Multicast SG RPF Check Failures 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppMulticast": {
                "attributes": {
                  "flag": "no",
                  "mcastOption": "ipv6-sg-rpf-failure"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <mcast-items>
          <Multicast-list>
            <mcastOption>ipv6-sg-rpf-failure</mcastOption>
            <flag>false</flag>
          </Multicast-list>
        </mcast-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception multicast ipv6-sg-rpf-failure

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppMulticast sys/copp/classp-{cName}/mcast-{mcastOption}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppMulticast Properties

The following table contains information about the coppMulticast properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
mcastOptioncopp:Mcast
(scalar:Enum8)
Multicast optionsSELECTION:
0 - Undefined
1 - dest-miss
2 - rpf-failure
3 - sg-rpf-failure
4 - ipv6-dest-miss
5 - ipv6-rpf-failure
6 - ipv6-sg-rpf-failure
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Match for IPv6 Multicast SG RPF Check Failures

 Deleting a Match for IPv6 Multicast SG RPF Check Failures 
DELETE http://<mgmt0_IP>/api/mo/sys/copp/classp-CMAP/mcast-ipv6-sg-rpf-failure.json
{
    imdata:[]
}


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 no match exception multicast ipv6-sg-rpf-failure

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

Configuring a Match for IPv6 L3 Multicast Destination Lookup Failures

 Configuring a Match for IPv6 L3 Multicast Destination Lookup Failures 
POST http://<mgmt0_IP>/api/mo/sys/copp.json
{
  "coppEntity": {
    "children": [
      {
        "coppClass": {
          "attributes": {
            "cName": "CMAP",
            "flag": "no"
          },
          "children": [
            {
              "coppMulticast": {
                "attributes": {
                  "flag": "no",
                  "mcastOption": "ipv6-dest-miss"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <copp-items>
    <classp-items>
      <Class-list>
        <cName>CMAP</cName>
        <flag>false</flag>
        <mcast-items>
          <Multicast-list>
            <mcastOption>ipv6-dest-miss</mcastOption>
            <flag>false</flag>
          </Multicast-list>
        </mcast-items>
      </Class-list>
    </classp-items>
  </copp-items>
</System>


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

class-map type control-plane CMAP
 match exception multicast ipv6-dest-miss

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppEntity sys/copp
coppClass sys/copp/classp-{cName}
coppMulticast sys/copp/classp-{cName}/mcast-{mcastOption}


coppClass Properties

The following table contains information about the coppClass properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cNamestring:Basic
Class-map nameA sequence of characters
flagscalar:Bool
Property FlagSELECTION: true or false


coppMulticast Properties

The following table contains information about the coppMulticast properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
mcastOptioncopp:Mcast
(scalar:Enum8)
Multicast optionsSELECTION:
0 - Undefined
1 - dest-miss
2 - rpf-failure
3 - sg-rpf-failure
4 - ipv6-dest-miss
5 - ipv6-rpf-failure
6 - ipv6-sg-rpf-failure
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Creating a Policy Map

Creating a Policy Map
POST http://<IP_Address>/api/node/mo/sys/copp/policy-[pmap1].json
{
  "coppPolicy": {
    "attributes": {
      "flag": "no",
      "name": "pmap1"
    },
    "children": [
      {
        "coppClassp": {
          "attributes": {
            "flag": "no",
            "name": "cmap1"
          },
          "children": [
            {
              "coppLogging": {
                "attributes": {
                  "levelRange": "2",
                  "threshold": "1345"
}}},{
              "coppSetCos": {
                "attributes": {
                  "cosVal": "3",
                  "flag": "no"
}}},{
              "coppPolicerAction": {
                "attributes": {
                  "burstC": "500",
                  "burstUnit": "packets",
                  "cirUnit": "pps",
                  "cirVal": "1345",
                  "conformAction": "transmit",
                  "flag": "no",
                  "violateAction": "drop"
}}}]}}]}}

This example creates a policy-map with class-map that sets the COS, has a logging action, and has a policing action.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

policy-map type control-plane pmap1
class cmap1
set cos 3
logging drop threshold 1345 level 2
police cir 1345 pps bc 500 packets conform transmit violate drop

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppPolicy sys/copp/policy-{name}
coppClassp sys/copp/policy-{name}/classp-{name}
coppLogging sys/copp/policy-{name}/classp-{name}/logging-{threshold}-level-{levelRange}
coppSetCos sys/copp/policy-{name}/classp-{name}/setCos-{cosVal}
coppPolicerAction sys/copp/policy-{name}/classp-{name}/cir-{cirVal}-Unit-{cirUnit}-burst-{burstC}-bcUnit-{burstUnit}


coppPolicy Properties

The following table contains information about the coppPolicy properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
namestring:Basic
Policy-map nameA sequence of characters


coppClassp Properties

The following table contains information about the coppClassp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
flagscalar:Bool
Property FlagSELECTION: true or false
namestring:Basic
Class nameA sequence of characters


coppLogging Properties

The following table contains information about the coppLogging properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
levelRangecopp:LevelRange
(scalar:Uint16)
logging range
RANGE: [1 , 7]
DEFAULT: 1
thresholdcopp:IrVal
(scalar:Uint64)
Logging ThresholdRANGE: [0, 18446744073709551615]


coppSetCos Properties

The following table contains information about the coppSetCos properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
cosValcopp:CosVal
(scalar:Uint16)
Cos ValueRANGE: [0, 65535]
flagscalar:Bool
Property FlagSELECTION: true or false


coppPolicerAction Properties

The following table contains information about the coppPolicerAction properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
burstCcopp:BurstVal
(scalar:Uint32)
Burst countRANGE: [0, 4294967295]
burstUnitcopp:BurstUnit
(scalar:Enum16)
BC unitSELECTION:
0 - Unknown
1 - bytes
2 - kbytes
3 - mbytes
4 - packets
5 - us
6 - ms
DEFAULT: Unknown
cirUnitcopp:IrUnit
(scalar:Enum16)
Cir rateSELECTION:
0 - Unknown
1 - bps
2 - pps
3 - kbps
4 - mbps
5 - gbps
DEFAULT: Unknown
cirValcopp:IrVal
(scalar:Uint64)
Cir valueRANGE: [0, 18446744073709551615]
conformActioncopp:ConformAction
(scalar:Enum16)
Conform ActionSELECTION:
0 - Undefined
1 - transmit
2 - drop
DEFAULT: Undefined
flagscalar:Bool
Property FlagSELECTION: true or false
violateActioncopp:ViolateAction
(scalar:Enum16)
Violate actionSELECTION:
0 - Undefined
1 - transmit
2 - drop
DEFAULT: Undefined


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Policy Map

Deleting a Policy Map
HTTP DELETE
http://<IP_Address>/api/node/mo/sys/copp/policy-[pmap1].json

This example deletes a policy map.

Creating a Service Policy

Creating a Service Policy
POST http://<IP_Address>/api/node/mo/sys/copp/service-[pmap1].json
{
  "coppService": {
    "attributes": {
      "name": "pmap1"
    }
  }
}
POST http://<IP_Address>/api/node/mo/sys/copp/service-[{service_policy_name}].json

This example creates a service policy.

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppService sys/copp/service-{name}


coppService Properties

The following table contains information about the coppService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
namestring:Basic
service-policy nameA sequence of characters


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Service Policy

Deleting a Service Policy
HTTP DELETE
http://<IP_Address>/api/node/mo/sys/copp/service-[pmap1].json

This example deletes a service policy.

Changing the Default CoPP Policy

Changing the Default CoPP Policy
POST http://<IP_Address>/api/node/mo/sys/copp/profile.json
{
  "coppProfile": {
    "attributes": {
      "prof": "moderate"
    }
  }
}

This example applies a moderate default CoPP policy.

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppProfile sys/copp/profile


coppProfile Properties

The following table contains information about the coppProfile properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
profcopp:ProfT
(scalar:Enum16)
Profile type SELECTION:
0 - unknown
1 - strict
2 - moderate
3 - lenient
4 - dense
DEFAULT: unknown


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Applying a Scale Factor

Applying a Scale Factor
POST http://<IP_Address>/api/node/mo/sys/copp/scale-[1].json
{
  "coppScale": {
    "attributes": {
      "module": "1",
      "scaleVal": "1.3"
    }
  }
}

This example applies a scale factor.

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
coppScale sys/copp/scale-{module}


coppScale Properties

The following table contains information about the coppScale properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
modulescalar:Uint16
Module numberRANGE: [0, 65535]
scaleValscalar:Float
scale factor valueA floating number per IEEE-754 standard


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Scale Factor

Deleting a Scale Factor
HTTP DELETE
http://<IP_Address>/api/node/mo/sys/copp/scale-[1].json