Cisco Nexus 3000 and 9000 Series NX-API REST SDK and API, Release 7.x

NX-OS 7(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring an IPv4 or IPv6 Address Port for the BMP Server

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "addr": "1.2.3.4",
                  "id": "1",
                  "port": "1"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <addr>1.2.3.4</addr>
              <port>1</port>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configuring a BMP Server

This section uses examples to demonstrate BMP server configuration options and to show how the REST APIs correspond to the CLI commands.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

Configuring an IPv4 or IPv6 Address Port for the BMP Server

Configures an IPv4 or IPv6 address port for the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

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.

router bgp 100
bmp-server 1
address 1.2.3.4 port-number 1

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

Entering a Description for the BMP Server

Enters a description for the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
description This is an example of a description

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/

Configuring a Delay Interval to Connect to the BMP Server

Configures a delay interval to connect to the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
initial-delay 30

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/

Configuring an Initial-Refresh Delay for the BMP Server

Configures an initial refresh delay for the BMP server; after which, the initial route update is sent to the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
initial-refresh delay 30

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/

Configuring the BMP Server to Skip the Sending of Initial Route Updates

Configures an initial-refresh for the BMP server to skip the sending of initial route updates to the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
initial-refresh skip

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/

Disabling an IPv4 or IPv6 Address Port Configuration for the BMP Server

Disables the configuration of an IPv4 or IPv6 address port for the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
no address

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/

Disabling the Description of the BMP Server

Disables the description of the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
no description

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/

Disabling a Delay Interval to Connect to the BMP Server

Disables a delay interval to connect to the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
no initial-delay 30

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/

Disables an Initial-Refresh Delay for the BMP Server

Disables an initial refresh delay for the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
no initial-refresh delay 30

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/

Disables the Skipping of an Initial-Refresh Delay

Disables the skipping of an initial refresh delay.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
no initial-refresh skip

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/

Disables the Administrative Shutdown of the BMP Server

Disables the administrative shutdown of the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
no shutdown

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/

Disabling the Specified Interval That Statistics are Sent to the BMP Server

Disables the specified interval that statistics are sent to the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
no stats-reporting-period

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/

Disabling the Source Interface for the BMP Server

Disables the source interface of a BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
no update-source

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/

Administratively Shutting Down the BMP Server

Administratively shuts down the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
shutdown

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/

Configuring the Interval after which Statistics are Sent to the BMP Server

Configures the interval after which statistics are sent to the BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
stats-reporting-period 30

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/

Configuring the Source Ethernet Interface for a BMP Session

Configures the source Ethernet interface for a BMP session.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
update-source ethernet 2/1

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/

Configuring a Virtual Router Context for a BMP Server

Configures a virtual router context for a BMP server.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
vrf v1

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/

Configuring the BMP for a Peer (Values inherited from a Peer Template)

Note: This example was added in Release 7.0(3)I7(2).

CLI Commands

router bgp 123
template peer peer
  bmp-activate-server 1
template peer-session sess
  bmp-activate-server 1
neighbor 1.2.3.4
  inherit peer-session sess
default bmp-activate-server 1

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/

Configuring BMP for a Peer

Note: This example was added in Release 7.0(3)I7(2).

CLI Commands

router bgp 123
template peer peer
  bmp-activate-server 1
template peer-session sess
  bmp-activate-server 1
neighbor 1.2.3.4
  bmp-activate-server 1

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/

Deleting the Configured BMP for a Peer

Note: This example was added in Release 7.0(3)I7(2).

CLI Commands

router bgp 123
template peer peer
  bmp-activate-server 1
template peer-session sess
  bmp-activate-server 1
neighbor 1.2.3.4
  no bmp-activate-server 1

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/

Configuring the BMP for a Peer (Values inherited from a Peer Template)

Note: This example was added in Release 7.0(3)I7(2).

CLI Commands

router bgp 123
template peer peer
  bmp-activate-server 1
template peer-session sess
  bmp-activate-server 1
neighbor 1.2.3.4
  inherit peer-session sess
default bmp-activate-server 1

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/

Activating BMP for a Neighbor

Activates BMP monitoring for a peer.

Note: The bmp-activate-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
neighbor 1.2.3.4
bmp-activate-server 1

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/

Deleting a BMP Configuration for a Neighbor

Note: This example was added in Release 7.0(3)I7(2).

CLI Commands

router bgp 100
neighbor 1.2.3.4
no bmp-activate-server 1

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/

Disabling a VRF Context

Disables a VRF context.

Note: The bmp-server CLI was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
bmp-server 1
no vrf VRF_1

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/

Deleting a Configured BMP Server

Note: This example was added in Release 7.0(3)I7(2).

CLI Commands

router bgp 100
no bmp-server 1

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/