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

 Configuring an IPv4 or IPv6 Address Port for the BMP Server

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"
}}}]}}]}}

{
    imdata:[]
}

<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>

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

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.

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

The following table contains information about the bgpInst 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
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

The following table contains information about the bgpDom 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
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

The following table contains information about the bgpBmpSvr 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
addr	address:Ip	IP address of the BMP server	Value must match ipv4 or ipv6 known format
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
port	scalar:Uint16	Port number of the BMP server	RANGE: [0 , 65535]

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

Entering a Description for the BMP Server

 Entering a Description for the BMP Server

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "descr": "This is an example of a description",
                  "id": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <descr>This is an example of a description</descr>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
descr	string:Basic	BMP server description string	A sequence of characters
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]

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 Delay Interval to Connect to the BMP Server

 Configuring a Delay Interval to Connect to the BMP Server

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "delayIntvl": "30",
                  "id": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <delayIntvl>30</delayIntvl>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
delayIntvl	scalar:Uint16	Initial connect delay	RANGE: [30 , 720] DEFAULT: 45
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]

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 an Initial-Refresh Delay for the BMP Server

Configuring an Initial-Refresh Delay for the BMP Server

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "id": "1",
                  "refreshIntvlDelay": "30"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <refreshIntvlDelay>30</refreshIntvlDelay>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
refreshIntvlDelay	scalar:Uint16	Route refresh trigger delay	RANGE: [30 , 720] DEFAULT: 30

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 the BMP Server to Skip the Sending of Initial Route Updates

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

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "id": "1",
                  "refreshIntvlSkip": "yes"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <refreshIntvlSkip>true</refreshIntvlSkip>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
refreshIntvlSkip	scalar:Bool	Route refresh trigger skip	SELECTION: true or false DEFAULT: 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

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

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

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "addr": "0.0.0.0",
                  "id": "1",
                  "port": "0"
}}}]}}]}}

{
    imdata:[]
}

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

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
addr	address:Ip	IP address of the BMP server	Value must match ipv4 or ipv6 known format
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
port	scalar:Uint16	Port number of the BMP server	RANGE: [0 , 65535]

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 the Description of the BMP Server

 Disabling the Description of the BMP Server

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "descr": "",
                  "id": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <descr></descr>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
descr	string:Basic	BMP server description string	A sequence of characters
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]

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 a Delay Interval to Connect to the BMP Server

 Disabling a Delay Interval to Connect to the BMP Server

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                    "delayIntvl": "45",
                    "id": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <delayIntvl>45</delayIntvl>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
delayIntvl	scalar:Uint16	Initial connect delay	RANGE: [30 , 720] DEFAULT: 45
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]

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

Disables an Initial-Refresh Delay for the BMP Server

 Disables an Initial-Refresh Delay for the BMP Server

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "id": "1",
                  "refreshIntvlDelay": "30"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <refreshIntvlDelay>30</refreshIntvlDelay>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
refreshIntvlDelay	scalar:Uint16	Route refresh trigger delay	RANGE: [30 , 720] DEFAULT: 30

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

Disables the Skipping of an Initial-Refresh Delay

  Disables the Skipping of  an Initial-Refresh Delay

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "id": "1",
                  "refreshIntvlSkip": "no"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <refreshIntvlSkip>false</refreshIntvlSkip>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
refreshIntvlSkip	scalar:Bool	Route refresh trigger skip	SELECTION: true or false DEFAULT: 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

Disables the Administrative Shutdown of the BMP Server

 Disables the Administrative Shutdown of the BMP Server

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "adminSt": "enabled",
                  "id": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <adminSt>enabled</adminSt>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
adminSt	bgp:BmpSt (scalar:Enum8)	BMP server config state	SELECTION: 0 - enabled 1 - disabled DEFAULT: enabled
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]

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 the Specified Interval That Statistics are Sent to the BMP Server

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

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "id": "1",
                  "statIntvl": "0"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <statIntvl>0</statIntvl>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
statIntvl	scalar:Uint16	Statistics reporting interval	RANGE: [0 , 720]

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 the Source Interface for the BMP Server

Disabling the Source Interface for the BMP Server

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "id": "1",
                  "srcIf": "unspecified"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <srcIf>unspecified</srcIf>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
srcIf	nw:IfId (base:IfIndex)	Source Interface for BMP server	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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

Administratively Shutting Down the BMP Server

 Administratively Shutting Down the BMP Server

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "adminSt": "disabled",
                  "id": "1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <adminSt>disabled</adminSt>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
adminSt	bgp:BmpSt (scalar:Enum8)	BMP server config state	SELECTION: 0 - enabled 1 - disabled DEFAULT: enabled
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]

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 the Interval after which Statistics are Sent to the BMP Server

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

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "id": "1",
                  "statIntvl": "30"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <statIntvl>30</statIntvl>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
statIntvl	scalar:Uint16	Statistics reporting interval	RANGE: [0 , 720]

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 the Source Ethernet Interface for a BMP Session

 Configuring the Source Ethernet Interface for a BMP Session

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "id": "1",
                  "srcIf": "eth2/1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <srcIf>eth2/1</srcIf>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
srcIf	nw:IfId (base:IfIndex)	Source Interface for BMP server	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 Virtual Router Context for a BMP Server

Configuring a Virtual Router Context for a BMP Server

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "id": "1",
                  "vrfName": "v1"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <vrfName>v1</vrfName>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
vrfName	l3:VrfName (string:Basic)	VRF for BMP server	A sequence of characters DEFAULT: default

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 the BMP for a Peer (Values inherited from a Peer Template)

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

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

{
  "bgpInst": {
    "attributes": {
      "asn": "123"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpPeer": {
                "attributes": {
                  "addr": "1.2.3.4",
                  "bmpSrvId1St": "disabled",
                  "inheritContPeerCtrl": "",
                  "sessionContImp": "sess"
}}},{
              "bgpPeerCont": {
                "attributes": {
                  "bmpSrvId1St": "enabled",
                  "inheritContPeerCtrl": "",
                  "name": "peer"
}}},{
              "bgpSessionCont": {
                "attributes": {
                  "bmpSrvId1St": "enabled",
                  "inheritContPeerCtrl": "",
                  "name": "sess"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <bmpSrvId1St>disabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <sessionContImp>sess</sessionContImp>
            </Peer-list>
          </peer-items>
          <peercont-items>
            <PeerCont-list>
              <name>peer</name>
              <bmpSrvId1St>enabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </PeerCont-list>
          </peercont-items>
          <sessioncont-items>
            <SessionCont-list>
              <name>sess</name>
              <bmpSrvId1St>enabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </SessionCont-list>
          </sessioncont-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpPeer	sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerCont	sys/bgp/inst/dom-{name}/peercont-{name}
bgpSessionCont	sys/bgp/inst/dom-{name}/sessioncont-{name}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeer Properties

The following table contains information about the bgpPeer 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
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth
sessionContImp	string:Basic	Peer Session Template To Import From	A sequence of characters

bgpPeerCont Properties

The following table contains information about the bgpPeerCont 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
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpSessionCont Properties

The following table contains information about the bgpSessionCont 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
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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 BMP for a Peer

Configuring BMP for a Peer

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

{
  "bgpInst": {
    "attributes": {
      "asn": "123"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpPeer": {
                "attributes": {
                  "addr": "1.2.3.4",
                  "bmpSrvId1St": "enabled",
                  "inheritContPeerCtrl": ""
}}},{
              "bgpPeerCont": {
                "attributes": {
                  "bmpSrvId1St": "enabled",
                  "inheritContPeerCtrl": "",
                  "name": "peer"
}}},{
              "bgpSessionCont": {
                "attributes": {
                  "bmpSrvId1St": "enabled",
                  "inheritContPeerCtrl": "",
                  "name": "sess"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <bmpSrvId1St>enabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </Peer-list>
          </peer-items>
          <peercont-items>
            <PeerCont-list>
              <name>peer</name>
              <bmpSrvId1St>enabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </PeerCont-list>
          </peercont-items>
          <sessioncont-items>
            <SessionCont-list>
              <name>sess</name>
              <bmpSrvId1St>enabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </SessionCont-list>
          </sessioncont-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpPeer	sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerCont	sys/bgp/inst/dom-{name}/peercont-{name}
bgpSessionCont	sys/bgp/inst/dom-{name}/sessioncont-{name}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeer Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth

bgpPeerCont Properties

Property Name	Data Type	Description	Values
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpSessionCont Properties

Property Name	Data Type	Description	Values
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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 the Configured BMP for a Peer

Deleting the Configured BMP for a Peer

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

{
  "bgpInst": {
    "attributes": {
      "asn": "123"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpPeer": {
                "attributes": {
                  "addr": "1.2.3.4",
                  "bmpSrvId1St": "disabled",
                  "inheritContPeerCtrl": ""
}}},{
              "bgpPeerCont": {
                "attributes": {
                  "bmpSrvId1St": "enabled",
                  "inheritContPeerCtrl": "",
                  "name": "peer"
}}},{
              "bgpSessionCont": {
                "attributes": {
                  "bmpSrvId1St": "enabled",
                  "inheritContPeerCtrl": "",
                  "name": "sess"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <bmpSrvId1St>disabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </Peer-list>
          </peer-items>
          <peercont-items>
            <PeerCont-list>
              <name>peer</name>
              <bmpSrvId1St>enabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </PeerCont-list>
          </peercont-items>
          <sessioncont-items>
            <SessionCont-list>
              <name>sess</name>
              <bmpSrvId1St>enabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </SessionCont-list>
          </sessioncont-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpPeer	sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerCont	sys/bgp/inst/dom-{name}/peercont-{name}
bgpSessionCont	sys/bgp/inst/dom-{name}/sessioncont-{name}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeer Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth

bgpPeerCont Properties

Property Name	Data Type	Description	Values
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpSessionCont Properties

Property Name	Data Type	Description	Values
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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 the BMP for a Peer (Values inherited from a Peer Template)

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

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

{
  "bgpInst": {
    "attributes": {
      "asn": "123"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpPeer": {
                "attributes": {
                  "addr": "1.2.3.4",
                  "bmpSrvId1St": "disabled",
                  "inheritContPeerCtrl": "",
                  "sessionContImp": "sess"
}}},{
  "bgpPeerCont": {
    "attributes": {
      "bmpSrvId1St": "enabled",
      "inheritContPeerCtrl": "",
      "name": "peer"
}}},{
  "bgpSessionCont": {
    "attributes": {
      "bmpSrvId1St": "enabled",
      "inheritContPeerCtrl": "",
      "name": "sess"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>123</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <bmpSrvId1St>disabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
              <sessionContImp>sess</sessionContImp>
            </Peer-list>
          </peer-items>
          <peercont-items>
            <PeerCont-list>
              <name>peer</name>
              <bmpSrvId1St>enabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </PeerCont-list>
          </peercont-items>
          <sessioncont-items>
            <SessionCont-list>
              <name>sess</name>
              <bmpSrvId1St>enabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </SessionCont-list>
          </sessioncont-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpPeer	sys/bgp/inst/dom-{name}/peer-{[addr]}
bgpPeerCont	sys/bgp/inst/dom-{name}/peercont-{name}
bgpSessionCont	sys/bgp/inst/dom-{name}/sessioncont-{name}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeer Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth
sessionContImp	string:Basic	Peer Session Template To Import From	A sequence of characters

bgpPeerCont Properties

Property Name	Data Type	Description	Values
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpSessionCont Properties

Property Name	Data Type	Description	Values
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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

Activating BMP for a Neighbor

 Activating BMP for a Neighbor

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpPeer": {
                "attributes": {
                  "addr": "1.2.3.4",
                  "bmpSrvId1St": "enabled",
                  "inheritContPeerCtrl": ""
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <bmpSrvId1St>enabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpPeer	sys/bgp/inst/dom-{name}/peer-{[addr]}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeer Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth

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 BMP Configuration for a Neighbor

Deleting a BMP Configuration for a Neighbor

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

{
"bgpInst": {
  "attributes": {
    "asn": "100"
  },
  "children": [
    {
      "bgpDom": {
        "attributes": {
          "name": "default"
        },
        "children": [
          {
            "bgpPeer": {
              "attributes": {
                "addr": "1.2.3.4",
                "bmpSrvId1St": "disabled",
                "inheritContPeerCtrl": ""
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <peer-items>
            <Peer-list>
              <addr>1.2.3.4</addr>
              <bmpSrvId1St>disabled</bmpSrvId1St>
              <inheritContPeerCtrl></inheritContPeerCtrl>
            </Peer-list>
          </peer-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

CLI Commands

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpPeer	sys/bgp/inst/dom-{name}/peer-{[addr]}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpPeer Properties

Property Name	Data Type	Description	Values
addr	address:Ip	Peer address	Value must match ipv4 or ipv6 known format
bmpSrvId1St	bgp:AdminSt (scalar:Enum8)	Activate BMP Server 1	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
inheritContPeerCtrl	bgp:InheritContPeerCtrlType (scalar:Bitmask64)	Inherit control of peer parameters	SELECTION: 1 - shutdown 2 - remote-as 4 - conn-mode 8 - bfd 16 - dis-conn-check 32 - cap-neg-off 64 - description 128 - timer 256 - password 512 - source-interface 1024 - ttl 2048 - ipv4-ucast 4096 - ipv4-mcast 8192 - epe 16384 - ipv6-ucast 32768 - ipv6-mcast 65536 - no-dyn-cap 131072 - local-as 262144 - remove-private-as 524288 - ipv4-lucast 1048576 - ipv6-lucast 2097152 - lnkstate 4194304 - log-nbr-chgs 8388608 - peer-type 16777216 - ipv4-mvpn 33554432 - ipv6-mvpn 67108864 - low-memory-exempt 134217728 - cap-suppr-4-byte-as 268435456 - l2vpn-evpn 536870912 - aff-grp 2147483648 - vpnv4-ucast 8589934592 - vpnv6-ucast 34359738368 - security-hops 137438953472 - bmp-activate-server-1 274877906944 - bmp-activate-server-2 549755813888 - dscp 1099511627776 - gshut-activate 2199023255552 - ipv4-mdt 4398046511104 - mhop-intvl 8796093022208 - mhop-auth

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 a VRF Context

 Disabling a VRF Context

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "id": "1"
                  "vrfName": "default"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list>
              <id>1</id>
              <vrfName>default</vrfName>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

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

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
vrfName	l3:VrfName (string:Basic)	VRF for BMP server	A sequence of characters DEFAULT: default

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 Configured BMP Server

Deleting a Configured BMP Server

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

{
  "bgpInst": {
    "attributes": {
      "asn": "100"
    },
    "children": [
      {
        "bgpDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "bgpBmpSvr": {
                "attributes": {
                  "id": "1",
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <bgp-items>
    <inst-items>
      <asn>100</asn>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <bmp-items>
            <BmpSvr-list xc:operation="delete">
              <id>1</id>
            </BmpSvr-list>
          </bmp-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </bgp-items>
</System>

CLI Commands

router bgp 100
no bmp-server 1

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

MO	DN
bgpInst	sys/bgp/inst
bgpDom	sys/bgp/inst/dom-{name}
bgpBmpSvr	sys/bgp/inst/dom-{name}/bmp-{id}

bgpInst Properties

Property Name	Data Type	Description	Values
asn	bgp:AsnNum (string:Basic)	Autonomous system number	A sequence of characters

bgpDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

bgpBmpSvr Properties

Property Name	Data Type	Description	Values
id	bgp:SrvId (scalar:UByte)	BMP Server Id	RANGE: [1 , 2]
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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