Configuring SNMP BGP Traps

This section contains payload examples and corresponding CLIs to demonstrate how to use the NX-API REST API to configure SNMP BGP traps on the Cisco Nexus 3000 and 9000 Series switches.

For information, see the Cisco Nexus 9000 Series NX-OS System Management Configuration Guide:

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

Additive Behaviors

This section describes additive behaviors when configuring SNMP BGP traps.

When snmp-server enable traps bgp state-changes all and snmp-server enable traps bgp state-changes limited and snmp-server enable traps bgp state-changes backward-trans are configured, the running configuration will reflect as snmp-server enable traps bgp state-changes only.
When snmp-server enable traps bgp state-changes all and snmp-server enable traps bgp state-changes limited and snmp-server enable traps bgp state-changes backward-trans and snmp-server enable traps bgp threshold prefix are configured, the running configuration will reflect as snmp-server enable traps bgp only.
When snmp-server enable traps bgp state-changes and snmp-server enable traps bgp threshold prefix are configured, the running configuration will reflect as snmp-server enable traps bgp only. Vice versa applies:
When snmp-server enable traps bgp state-changes is configured or "stChange" is enabled, "stChangeAllFsm": "yes", "stChangeBackTrans": "yes", "stChangeLtd": "yes" are set automatically.
When snmp-server enable traps bgp is configured or "trapAll" is enabled, "stChangeAllFsm": "yes", "stChangeBackTrans": "yes", "stChangeLtd": "yes", "stChange": "enabled", "thresPfx": "yes" are set automatically.
When snmp-server enable traps bgp cbgp2 state-changes all and snmp-server enable traps bgp cbgp2 state-changes limited and snmp-server enable traps bgp cbgp2 state-changes backward-trans are configured, the running configuration will reflect as snmp-server enable traps bgp cbgp2 state-changes only.
When snmp-server enable traps bgp cbgp2 state-changes all and snmp-server enable traps bgp cbgp2 state-changes limited and snmp-server enable traps bgp cbgp2 state-changes backward-trans and snmp-server enable traps bgp cbgp2 threshold prefix are configured, the running configuration will reflect as snmp-server enable traps bgp cbgp2 only.
When snmp-server enable traps bgp cbgp2 state-changes and snmp-server enable traps bgp cbgp2 threshold prefix are configured, the running configuration will reflect as snmp-server enable traps bgp cbgp2 only.
When snmp-server enable traps bgp cbgp2 state-changes is configured or "stChange" is enabled, "stChangeAllFsm": "yes", "stChangeBackTrans": "yes", "stChangeLtd": "yes" are set automatically.
When snmp-server enable traps bgp cbgp2 is configured or "trapAll" is enabled, "stChangeAllFsm": "yes", "stChangeBackTrans": "yes", "stChangeLtd": "yes", "stChange": "enabled", "thresPfx": "yes" are set automatically.
An error is given if you send a payload where an umbrella command is configured and one of its subcommands are unconfigured, or where an umbrella command is unconfigured and one of its subcommands are configured. See the examples below:
- Example 1
  - The config below would produce this error: "Cannot change state-change traps when stChange attribute is changed in same payload faulty_dn=sys/bgptrap"
    - Umbrella Command
      - snmp-server enable traps bgp state-changes
    - Subcommands
      - snmp-server enable traps bgp state-changes all
      - snmp-server enable traps bgp state-changes limited
      - snmp-server enable traps bgp state-changes backward-trans
- Example 2
  - The config below would produce this error: "Cannot change any state-change or threshold traps when trapAll attribute is changed in same payload faulty_dn=sys/bgptrap"
    - Umbrella Command
      - snmp-server enable traps bgp
    - Subcommands
      - snmp-server enable traps bgp state-changes
      - snmp-server enable traps bgp threshold prefix
    - or
      - snmp-server enable traps bgp state-changes all
      - snmp-server enable traps bgp state-changes limited
      - snmp-server enable traps bgp state-changes backward-trans
      - snmp-server enable traps bgp threshold prefix
- Example 3
  - The config below would produce this error: "Cannot change state-change traps when stChange attribute is changed in same payload faulty_dn=sys/cbgp2trap"
    - Umbrella Command
      - snmp-server enable traps bgp cbgp2 state-changes
    - Subcommands
      - snmp-server enable traps bgp cbgp2 state-changes all
      - snmp-server enable traps bgp cbgp2 state-changes limited
      - snmp-server enable traps bgp cbgp2 state-changes backward-trans
- Example 4
  - The config below would produce this error: "Cannot change any state-change or threshold traps when trapAll attribute is changed in same payload faulty_dn=sys/cbgp2trap"
    - Umbrella Command 5
      - snmp-server enable traps bgp cbgp2
    - Subcommands
      - snmp-server enable traps bgp cbgp2 state-changes
      - snmp-server enable traps bgp cbgp2 threshold prefix
    - or
      - snmp-server enable traps bgp cbgp2 state-changes all
      - snmp-server enable traps bgp cbgp2 state-changes limited
      - snmp-server enable traps bgp cbgp2 state-changes backward-trans
      - snmp-server enable traps bgp cbgp2 threshold prefix

Configuring a Cisco-Specific SNMP BGP Trap for State Changes

Configuring a Cisco-Specific SNMP BGP Trap for State Changes

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "stChange": "enabled"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <stChange>enabled</stChange>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

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.

snmp-server enable traps bgp state-changes

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.

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

The following table contains information about the bgpTbgp 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 Name	Data Type	Description	Values
stChange	bgp:TrapType (scalar:Enum8)	SNMP BGP trap for all bgp state change traps	SELECTION: 0 - none 1 - disabled 2 - enabled

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 Cisco-Specific SNMP BGP Trap for State Changes

Deleting a Cisco-Specific SNMP BGP Trap for State Changes

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "stChange": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <stChange>disabled</stChange>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp state-changes

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

Property Name	Data Type	Description	Values
stChange	bgp:TrapType (scalar:Enum8)	SNMP BGP trap for all bgp state change traps	SELECTION: 0 - none 1 - disabled 2 - enabled

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

Enabling SNMP CBGP2 Traps

Enabling SNMP CBGP2 Traps

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "stChange": "enabled"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <stChange>enabled</stChange>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

snmp-server enable traps bgp cbgp2 state-changes

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

The following table contains information about the bgpTcbgp2 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 Name	Data Type	Description	Values
stChange	bgp:TrapType (scalar:Enum8)	SNMP BGP trap for all bgp state change traps	SELECTION: 0 - none 1 - disabled 2 - enabled

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

Disabling SNMP CBGP2 Traps

Disabling SNMP CBGP2 Traps

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "stChange": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <stChange>disabled</stChange>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp cbgp2 state-changes

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

Property Name	Data Type	Description	Values
stChange	bgp:TrapType (scalar:Enum8)	SNMP BGP trap for all bgp state change traps	SELECTION: 0 - none 1 - disabled 2 - enabled

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 CISCO-Specific SNMP CBGP2 Trap for All FSM State Changes

Configuring a CISCO-Specific SNMP CBGP2 Trap for All FSM State Changes

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "stChangeAllFsm": "yes"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <stChangeAllFsm>true</stChangeAllFsm>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

snmp-server enable traps bgp cbgp2 state-changes all

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

Property Name	Data Type	Description	Values
stChangeAllFsm	scalar:Bool	SNMP BGP trap for all fsm state change	SELECTION: 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

Deleting a CISCO-Specific SNMP CBGP2 Trap for All FSM State Changes

Deleting a CISCO-Specific SNMP CBGP2 Trap for All FSM State Changes

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "stChangeAllFsm": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <stChangeAllFsm>false</stChangeAllFsm>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp cbgp2 state-changes all

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

Property Name	Data Type	Description	Values
stChangeAllFsm	scalar:Bool	SNMP BGP trap for all fsm state change	SELECTION: 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

Enabling SNMP CBGP2 Traps

Enabling SNMP CBGP2 Traps

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "trapAll": "enabled"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <trapAll>enabled</trapAll>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

snmp-server enable traps bgp cbgp2

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

Property Name	Data Type	Description	Values
trapAll	bgp:TrapType (scalar:Enum8)	All state-change and threshold prefix traps	SELECTION: 0 - none 1 - disabled 2 - enabled

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

Disabling SNMP CBGP2 Traps

Disabling SNMP CBGP2 Traps

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "trapAll": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <trapAll>disabled</trapAll>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp cbgp2

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

Property Name	Data Type	Description	Values
trapAll	bgp:TrapType (scalar:Enum8)	All state-change and threshold prefix traps	SELECTION: 0 - none 1 - disabled 2 - enabled

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 CISCO-Specific SNMP BGP Trap for All FSM State Changes

Configuring a CISCO-Specific SNMP BGP Trap for All FSM State Changes

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "stChangeAllFsm": "yes"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <stChangeAllFsm>true</stChangeAllFsm>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

snmp-server enable traps bgp state-changes all

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

Property Name	Data Type	Description	Values
stChangeAllFsm	scalar:Bool	SNMP BGP trap for all fsm state change	SELECTION: 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

Deleting a CISCO-Specific SNMP BGP Trap for All FSM State Changes

Deleting a CISCO-Specific SNMP BGP Trap for All FSM State Changes

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "stChangeAllFsm": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <stChangeAllFsm>false</stChangeAllFsm>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp state-changes all

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

Property Name	Data Type	Description	Values
stChangeAllFsm	scalar:Bool	SNMP BGP trap for all fsm state change	SELECTION: 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

Enabling SNMP BGP Traps

Enabling SNMP BGP Traps

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "trapAll": "enabled"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <trapAll>enabled</trapAll>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

snmp-server enable traps bgp

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

Property Name	Data Type	Description	Values
trapAll	bgp:TrapType (scalar:Enum8)	All state-change and threshold prefix traps	SELECTION: 0 - none 1 - disabled 2 - enabled

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

Disabling SNMP BGP Traps

Disabling SNMP BGP Traps

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "trapAll": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <trapAll>disabled</trapAll>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

Property Name	Data Type	Description	Values
trapAll	bgp:TrapType (scalar:Enum8)	All state-change and threshold prefix traps	SELECTION: 0 - none 1 - disabled 2 - enabled

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 Cisco-Specific BGP Trap for Backward Transition

Configuring a Cisco-Specific BGP Trap for Backward Transition

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "stChangeBackTrans": "yes"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <stChangeBackTrans>true</stChangeBackTrans>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

snmp-server enable traps bgp state-changes backward-trans

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

Property Name	Data Type	Description	Values
stChangeBackTrans	scalar:Bool	SNMP BGP trap for backward transition state change trap	SELECTION: 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

Deleting a Cisco-Specific BGP Trap for Backward Transition

Deleting a Cisco-Specific BGP Trap for Backward Transition

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "stChangeBackTrans": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <stChangeBackTrans>false</stChangeBackTrans>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp state-changes backward-trans

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

Property Name	Data Type	Description	Values
stChangeBackTrans	scalar:Bool	SNMP BGP trap for backward transition state change trap	SELECTION: 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 Cisco-Specific CBGP2 Trap for Backward Transition

Configuring a Cisco-Specific CBGP2 Trap for Backward Transition

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "stChangeBackTrans": "yes"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <stChangeBackTrans>true</stChangeBackTrans>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

snmp-server enable traps bgp cbgp2 state-changes backward-trans

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

Property Name	Data Type	Description	Values
stChangeBackTrans	scalar:Bool	SNMP BGP trap for backward transition state change trap	SELECTION: 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

Deleting a Cisco-Specific CBGP2 Trap for Backward Transition

Deleting a Cisco-Specific CBGP2 Trap for Backward Transition

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "stChangeBackTrans": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <stChangeBackTrans>false</stChangeBackTrans>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp cbgp2 state-changes backward-trans

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

Property Name	Data Type	Description	Values
stChangeBackTrans	scalar:Bool	SNMP BGP trap for backward transition state change trap	SELECTION: 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 Cisco-Specific CBGP2 Trap for Prefix Threshold Events

Configuring a Cisco-Specific CBGP2 Trap for Prefix Threshold Events

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "thresPfx": "yes"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <thresPfx>true</thresPfx>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

snmp-server enable traps bgp cbgp2 threshold prefix

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

Property Name	Data Type	Description	Values
thresPfx	scalar:Bool	SNMP BGP trap for prefix threshold event	SELECTION: 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

Deleting a Cisco-Specific CBGP2 Trap for Prefix Threshold Events

Deleting a Cisco-Specific CBGP2 Trap for Prefix Threshold Events

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "thresPfx": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <thresPfx>false</thresPfx>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp cbgp2 threshold prefix

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

Property Name	Data Type	Description	Values
thresPfx	scalar:Bool	SNMP BGP trap for prefix threshold event	SELECTION: 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 Cisco-Specific BGP Trap for State-Changes Limited

Configuring a Cisco-Specific BGP Trap for State-Changes Limited

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "stChangeLtd": "yes"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <stChangeLtd>true</stChangeLtd>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

snmp-server enable traps bgp state-changes limited

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

Property Name	Data Type	Description	Values
stChangeLtd	scalar:Bool	SNMP BGP trap for limited state change trap	SELECTION: 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

Deleting a Cisco-Specific BGP Trap for State-Changes Limited

Deleting a Cisco-Specific BGP Trap for State-Changes Limited

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "stChangeLtd": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <stChangeLtd>false</stChangeLtd>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp state-changes limited

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

Property Name	Data Type	Description	Values
stChangeLtd	scalar:Bool	SNMP BGP trap for limited state change trap	SELECTION: 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 Cisco-Specific CBGP2 Trap for State-Changes Limited

Configuring a Cisco-Specific CBGP2 Trap for State-Changes Limited

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "stChangeLtd": "yes"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <stChangeLtd>true</stChangeLtd>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

snmp-server enable traps bgp cbgp2 state-changes limited

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

Property Name	Data Type	Description	Values
stChangeLtd	scalar:Bool	SNMP BGP trap for limited state change trap	SELECTION: 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

Deleting a Cisco-Specific CBGP2 Trap for State-Changes Limited

Deleting a Cisco-Specific CBGP2 Trap for State-Changes Limited

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTcbgp2": {
          "attributes": {
            "stChangeLtd": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <cbgp2trap-items>
    <stChangeLtd>false</stChangeLtd>
  </cbgp2trap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp cbgp2 state-changes limited

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTcbgp2	sys/cbgp2trap

bgpTcbgp2 Properties

Property Name	Data Type	Description	Values
stChangeLtd	scalar:Bool	SNMP BGP trap for limited state change trap	SELECTION: 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 Cisco-Specific BGP Trap for Prefix Threshold Events

Configuring Cisco-Specific BGP Trap for Prefix Threshold Events

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "thresPfx": "yes"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <thresPfx>true</thresPfx>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

snmp-server enable traps bgp threshold prefix

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

Property Name	Data Type	Description	Values
thresPfx	scalar:Bool	SNMP BGP trap for prefix threshold event	SELECTION: 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

Deleting Cisco-Specific BGP Trap for Prefix Threshold Events

Deleting Cisco-Specific BGP Trap for Prefix Threshold Events

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "bgpTbgp": {
          "attributes": {
            "thresPfx": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <bgptrap-items>
    <thresPfx>false</thresPfx>
  </bgptrap-items>
</System>

Note: This example was added in Release 9.3(3).

CLI Commands

no snmp-server enable traps bgp threshold prefix

Verifying a DME Configuration

MO	DN
topSystem	sys
bgpTbgp	sys/bgptrap

bgpTbgp Properties

Property Name	Data Type	Description	Values
thresPfx	scalar:Bool	SNMP BGP trap for prefix threshold event	SELECTION: 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