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

Template Configuration for Peer Parameters

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/bgp/inst.json
{
 "bgpInst": {
   "attributes": {
     "asn": "100"
   },
   "children": [
     {
       "bgpDom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "bgpPeerCont": {
               "attributes": {
                 "inheritContPeerCtrl": "",
                 "name": "33.1.1.1"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peercont-items>
            <PeerCont-list>
              <name>33.1.1.1</name>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </PeerCont-list>
          </peercont-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

Configuring a Peer Template

This section uses examples to demonstrate many of the BGP configuration options and to show how the REST APIs correspond to the CLI commands.

Configuring a Template Configuration for Peer Parameters

Template Configuration for Peer Parameters

Enters peer template configuration mode.

CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

router bgp 100
template peer 33.1.1.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

Configuring the Autonomous System Number of the Neighbor

Configures an AS number for a template peer.

CLI Commands

router bgp 100
template peer 33.1.1.1
remote-as 330

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 Log Message for Neighbor Up/Down Events (Under a Template Configuration for Peer Parameters)

Logs a message for a neighbor up/down events.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
template peer 33.1.1.1
log-neighbor-changes

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 Local-as Number for the eBGP Neighbor

Configuring the Local-as Number for the eBGP Neighbors

Configures the local-as.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
template peer 33.1.1.1
local-as 100

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/

Creating a Neighbor-Specific Description

Creates a neighbor-specific description.

CLI Commands

router bgp 100
template peer 33.1.1.1
description oc-bgp-peer

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/

Removing a Private AS Number from Outbound Updates

Replaces all private AS numbers with the replace-as AS-path value.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
template peer 33.1.1.1
remove-private-as replace-as

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 Multihop TTL for a Remote Peer

Configures the eBGP TTL value for eBGP multihop.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
template peer 33.1.1.1
ebgp-multihop 2

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 BGP Transport Connection as Passive Only

Allows a passive connection setup only.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
template peer 33.1.1.1
transport connection-mode passive

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 Keepalive and Hold Timers

CLI Commands

router bgp 100
template peer 33.1.1.1
timers 61 181

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 IPv4 Unicast Sub-Address Family

CLI Commands

router bgp 100
template peer 33.1.1.1
address-family ipv4 unicast

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/

Send Community Attribute to this Neighbor

Sends the community attribute to this BGP peer. This command triggers an automatic soft clear or refresh of BGP neighbor sessions.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
template peer 33.1.1.1
address-family ipv4 unicast
send-community

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 Maximum Number of Prefixes from this Neighbor

CLI Commands

router bgp 100
template peer 33.1.1.1
address-family ipv4 unicast
maximum-prefix 21 20 restart 90

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 Advertisement Interval on a Template Peer

Configuring the advertisement-interval

Sets the interval time in seconds between sending advertisement frames. The range is from 1 to 255. The default is 1 second.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
template peer 33.1.1.1
address-family ipv4 unicast
advertisement-interval 80

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 Advertisement to only Active Routes to Peers

Suppresses the advertisement of routes that are not installed in the routing information base (RIB).

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
template peer 33.1.1.1
address-family ipv4 unicast
suppress-inactive

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 Default Originate Toward a Peer

Generates a default route to the BGP peer.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

router bgp 100
template peer 33.1.1.1
address-family ipv4 unicast
default-originate

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 BGP Peer Template

CLI Commands

router bgp 100
template peer BasePeer
  inherit peer-session BaseSession
  address-family ipv4 unicast
   inherit peer-policy BasePolicy 1
neighbor 192.168.1.2 remote-as 65536
  inherit peer BasePeer

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 Fabric Border Leaf for a Neighbor Template

Configures a fabric border leaf for a neighbor template.

Note: This example was added in Release 7.0(3)I7(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
template peer p1
peer-type fabric-border-leaf

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 Fabric Border Leaf in a Peer-Session Template

Configures a fabric border leaf in a peer-session template.

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

CLI Commands

router bgp 100
template peer-session ps2
peer-type fabric-external

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/

Querying a Peer Template

This API call queries the settings of the peer template that were set in the previous example Configuring a BGP Peer Template.

Issue an HTTP GET request to verify that the BGP peer template configuration was successful.