Configuring IP Next Hop

Setting the Next-Hop Address

Setting the Next-Hop Address

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

{
"rpmEntity": {
  "children": [
    {
      "rtmapRule": {
        "attributes": {
          "name": "map1"
        },
        "children": [
          {
            "rtmapEntry": {
              "attributes": {
                "action": "permit",
                "order": "10"
              },
              "children": [
                {
                  "rtmapSetNh": {
                    "attributes": {
                      "addr": "1.2.3.4"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>map1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <nh-items>
              <SetNh-list>
                <addr>1.2.3.4</addr>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

Specifies where output packets that pass a match clause of a route map for policy routing. In this example, the IP address is set to 1.2.3.4.

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.

route-map map1 permit 10
set ip next-hop 1.2.3.4

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
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-{[name]}
rtmapEntry	sys/rpm/rtmap-{[name]}/ent-{order}
rtmapSetNh	sys/rpm/rtmap-{[name]}/ent-{order}/nh-{[addr]}

rtmapRule Properties

The following table contains information about the rtmapRule 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	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

The following table contains information about the rtmapEntry 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
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNh Properties

The following table contains information about the rtmapSetNh 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	The peer IP address.	Value must match ipv4 or ipv6 known format

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 Next-Hop Address

Deleting the Next-Hop Address

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

{
"rpmEntity": {
  "children": [
    {
      "rtmapRule": {
        "attributes": {
          "name": "map1"
        },
        "children": [
          {
            "rtmapEntry": {
              "attributes": {
                "action": "permit",
                "order": "10"
              },
              "children": [
                {
                  "rtmapSetNh": {
                    "attributes": {
                      "addr": "1.2.3.4",
                      "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>map1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <nh-items>
              <SetNh-list xc:operation="delete">
                <addr>1.2.3.4</addr>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

CLI Commands

route-map map1 permit 10
no set ip next-hop 1.2.3.4

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

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-{[name]}
rtmapEntry	sys/rpm/rtmap-{[name]}/ent-{order}
rtmapSetNh	sys/rpm/rtmap-{[name]}/ent-{order}/nh-{[addr]}

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNh Properties

Property Name	Data Type	Description	Values
addr	address:Ip	The peer IP address.	Value must match ipv4 or ipv6 known format
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

Setting the Next-Hop Address to Unchanged for eBGP Sessions Only

Setting the Next-Hop Address to Unchanged for eBGP Sessions Only

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

{
"rpmEntity": {
  "children": [
{
  "rtmapRule": {
    "attributes": {
      "name": "map1"
},
"children": [
  {
    "rtmapEntry": {
      "attributes": {
        "action": "permit",
        "order": "10"
},
  "children": [
{
  "rtmapSetNhPeerAddr": {
    "attributes": {
      "v4Unchange": "enabled"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>map1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <nhpa-items>
              <v4Unchange>enabled</v4Unchange>
            </nhpa-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

CLI Commands

route-map map1 permit 10
set ip next-hop unchanged

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

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-{[name]}
rtmapEntry	sys/rpm/rtmap-{[name]}/ent-{order}
rtmapSetNhPeerAddr	sys/rpm/rtmap-{[name]}/ent-{order}/nhpa

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNhPeerAddr Properties

The following table contains information about the rtmapSetNhPeerAddr 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
v4Unchange	rtmap:AdminSt (scalar:Enum8)	Set IPv4 Next Hop Unchanged	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 Next-Hop Address Set to Unchanged for eBGP Sessions Only

Disabling the Next-Hop Address Set to Unchanged for eBGP Sessions Only

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

{
"rpmEntity": {
  "children": [
    {
      "rtmapRule": {
        "attributes": {
          "name": "map1"
        },
        "children": [
          {
            "rtmapEntry": {
              "attributes": {
                "action": "permit",
                "order": "10"
              },
              "children": [
                {
                  "rtmapSetNhPeerAddr": {
                    "attributes": {
                      "v4Unchange": "disabled"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>map1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <nhpa-items>
              <v4Unchange>disabled</v4Unchange>
            </nhpa-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

CLI Commands

route-map map1 permit 10
no set ip next-hop unchanged

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

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-{[name]}
rtmapEntry	sys/rpm/rtmap-{[name]}/ent-{order}
rtmapSetNhPeerAddr	sys/rpm/rtmap-{[name]}/ent-{order}/nhpa

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNhPeerAddr Properties

Property Name	Data Type	Description	Values
v4Unchange	rtmap:AdminSt (scalar:Enum8)	Set IPv4 Next Hop Unchanged	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "loadShareV4": "enabled",
                  "order": "10"
                },
                "children": [
                  {
                    "rtmapSetNh": {
                      "attributes": {
                        "addr": "2.4.6.8"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <loadShareV4>enabled</loadShareV4>
            <nh-items>
              <SetNh-list>
                <addr>2.4.6.8</addr>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

Note: This example was added in Release 9.2(2).

CLI Commands

route-map Map_1
set ip next-hop 2.4.6.8 load-share

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

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-{[name]}
rtmapEntry	sys/rpm/rtmap-{[name]}/ent-{order}
rtmapSetNh	sys/rpm/rtmap-{[name]}/ent-{order}/nh-{[addr]}

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
loadShareV4	rtmap:AdminSt (scalar:Enum8)	Load Sharing V4	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNh Properties

Property Name	Data Type	Description	Values
addr	address:Ip	The peer IP address.	Value must match ipv4 or ipv6 known format

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

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "loadShareV4": "disabled",
                  "order": "10"
                },
                "children": [
                  {
                    "rtmapSetNh": {
                      "attributes": {
                        "addr": "2.4.6.8",
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <loadShareV4>disabled</loadShareV4>
            <nh-items>
              <SetNh-list xc:operation="delete">
                <addr>2.4.6.8</addr>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

Note: This example was added in Release 9.2(2).

CLI Commands

route-map Map_1
no set ip next-hop 2.4.6.8 load-share

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

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-{[name]}
rtmapEntry	sys/rpm/rtmap-{[name]}/ent-{order}
rtmapSetNh	sys/rpm/rtmap-{[name]}/ent-{order}/nh-{[addr]}

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
loadShareV4	rtmap:AdminSt (scalar:Enum8)	Load Sharing V4	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNh Properties

Property Name	Data Type	Description	Values
addr	address:Ip	The peer IP address.	Value must match ipv4 or ipv6 known format
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

Configuring Next-Hop Order as Per CLI Configuration

Configuring Next-Hop Order as Per CLI Configuration

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "forceOrderV4": "enabled",
                  "order": "10"
                },
                "children": [
                  {
                    "rtmapSetNh": {
                      "attributes": {
                        "addr": "1.2.3.4"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <forceOrderV4>enabled</forceOrderV4>
            <nh-items>
              <SetNh-list>
                <addr>1.2.3.4</addr>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

Note: This example was added in Release 9.2(2).

CLI Commands

route-map Map_1
set ip next-hop 1.2.3.4 force-order

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

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-{[name]}
rtmapEntry	sys/rpm/rtmap-{[name]}/ent-{order}
rtmapSetNh	sys/rpm/rtmap-{[name]}/ent-{order}/nh-{[addr]}

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
forceOrderV4	rtmap:AdminSt (scalar:Enum8)	Force Order V4	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNh Properties

Property Name	Data Type	Description	Values
addr	address:Ip	The peer IP address.	Value must match ipv4 or ipv6 known format

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 Next Hop Order Configured per CLI Configuration

Deleting Next Hop Order Configured per CLI

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "forceOrderV4": "disabled",
                  "order": "10"
                },
                "children": [
                  {
                    "rtmapSetNh": {
                      "attributes": {
                        "addr": "2.4.6.8",
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <forceOrderV4>disabled</forceOrderV4>
            <nh-items>
              <SetNh-list xc:operation="delete">
                <addr>2.4.6.8</addr>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

Note: This example was added in Release 9.2(2).

CLI Commands

route-map Map_1
no set ip next-hop 2.4.6.8 force-order

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

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-{[name]}
rtmapEntry	sys/rpm/rtmap-{[name]}/ent-{order}
rtmapSetNh	sys/rpm/rtmap-{[name]}/ent-{order}/nh-{[addr]}

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
forceOrderV4	rtmap:AdminSt (scalar:Enum8)	Force Order V4	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNh Properties

Property Name	Data Type	Description	Values
addr	address:Ip	The peer IP address.	Value must match ipv4 or ipv6 known format
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

Configuring Drop packets when Next Hop is Unreachable

Configuring Drop packets when Next Hop is Unreachable

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "dropOnFailV4": "enabled",
                  "order": "10"
                },
                "children": [
                  {
                    "rtmapSetNh": {
                      "attributes": {
                        "addr": "2.4.6.8"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <dropOnFailV4>enabled</dropOnFailV4>
            <nh-items>
              <SetNh-list>
                <addr>2.4.6.8</addr>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

Note: This example was added in Release 9.2(2).

CLI Commands

route-map Map_1
set ip next-hop 2.4.6.8 drop-on-fail

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

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-{[name]}
rtmapEntry	sys/rpm/rtmap-{[name]}/ent-{order}
rtmapSetNh	sys/rpm/rtmap-{[name]}/ent-{order}/nh-{[addr]}

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
dropOnFailV4	rtmap:AdminSt (scalar:Enum8)	Drop On Fail V4 for v4 nexthop	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNh Properties

Property Name	Data Type	Description	Values
addr	address:Ip	The peer IP address.	Value must match ipv4 or ipv6 known format

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 Drop packets when Next Hop is Unreachable

Deleting Drop packets when Next Hop is Unreachable

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "dropOnFailV4": "disabled",
                  "order": "10"
                },
                "children": [
                  {
                    "rtmapSetNh": {
                      "attributes": {
                        "addr": "2.4.6.8",
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <dropOnFailV4>disabled</dropOnFailV4>
            <nh-items>
              <SetNh-list xc:operation="delete">
                <addr>2.4.6.8</addr>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

Note: This example was added in Release 9.2(2).

CLI Commands

route-map Map_1
no set ip next-hop 2.4.6.8 drop-on-fail

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

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-{[name]}
rtmapEntry	sys/rpm/rtmap-{[name]}/ent-{order}
rtmapSetNh	sys/rpm/rtmap-{[name]}/ent-{order}/nh-{[addr]}

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
dropOnFailV4	rtmap:AdminSt (scalar:Enum8)	Drop On Fail V4 for v4 nexthop	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNh Properties

Property Name	Data Type	Description	Values
addr	address:Ip	The peer IP address.	Value must match ipv4 or ipv6 known format
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

Configuring Unchanged Address During Redistribution (for BGP Session Only)

Configuring Unchanged Address During Redistribution (for BGP Session Only)

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "order": "10"
                },
                "children": [
                  {
                    "rtmapSetNhPeerAddr": {
                      "attributes": {
                        "v6RedistUnchange": "enabled"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <nhpa-items>
              <v6RedistUnchange>enabled</v6RedistUnchange>
            </nhpa-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

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

CLI Commands

route-map Map_1
set ipv6 next-hop redist-unchanged

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
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapSetNhPeerAddr	sys/rpm/rtmap-[Map_1]/ent-10/nhpa

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNhPeerAddr Properties

Property Name	Data Type	Description	Values
v6RedistUnchange	rtmap:AdminSt (scalar:Enum8)	Set IPv6 Next Hop Redist Unchanged	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 Unchanged Address During Redistribution (for BGP Session Only)

Deleting Unchanged Address During Redistribution (for BGP Session Only)

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "order": "10"
                },
                "children": [
                  {
                    "rtmapSetNhPeerAddr": {
                      "attributes": {
                        "v6RedistUnchange": "disabled"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <nhpa-items>
              <v6RedistUnchange>disabled</v6RedistUnchange>
            </nhpa-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

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

CLI Commands

route-map Map_1
no set ipv6 next-hop redist-unchanged

Verifying a DME Configuration

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapSetNhPeerAddr	sys/rpm/rtmap-[Map_1]/ent-10/nhpa

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNhPeerAddr Properties

Property Name	Data Type	Description	Values
v6RedistUnchange	rtmap:AdminSt (scalar:Enum8)	Set IPv6 Next Hop Redist Unchanged	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 to Maintain Next-Hop Order as per CLI Config

Configuring to Maintain Next-Hop Order as per CLI Config

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "forceOrderV4": "enabled",
                  "order": "10",
                  "verifyAvailabilityV4": "enabled"
                },
                "children": [
                  {
                    "rtmapSetNh": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "trackId": "240"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <forceOrderV4>enabled</forceOrderV4>
            <verifyAvailabilityV4>enabled</verifyAvailabilityV4>
            <nh-items>
              <SetNh-list>
                <addr>1.2.3.4</addr>
                <trackId>240</trackId>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

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

CLI Commands

route-map Map_1
set ip next-hop verify-availability 1.2.3.4 track 240 force-order

Verifying a DME Configuration

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapSetNh	sys/rpm/rtmap-[Map_1]/ent-10/nh-[1.2.3.4]

rtmapSetNh Properties

Property Name	Data Type	Description	Values
addr	address:Ip	The peer IP address.	Value must match ipv4 or ipv6 known format
trackId	scalar:Uint32	Track id for Next Hop VA Address	RANGE: [1 , 512]

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
forceOrderV4	rtmap:AdminSt (scalar:Enum8)	Force Order V4	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]
verifyAvailabilityV4	rtmap:AdminSt (scalar:Enum8)	Next Hop with V4 Verify Availability	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 Config to Maintain Next-Hop Order as per CLI Config

 Deleting the Config to Maintain Next-Hop Order as per CLI Config

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "forceOrderV4": "disabled",
                  "order": "10"
                },
                "children": [
                  {
                    "rtmapSetNh": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <forceOrderV4>disabled</forceOrderV4>
            <nh-items>
              <SetNh-list nc:operation="delete">
                <addr>1.2.3.4</addr>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

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

CLI Commands

route-map Map_1
no set ip next-hop verify-availability 1.2.3.4 track 240 force-order

Verifying a DME Configuration

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapSetNh	sys/rpm/rtmap-[Map_1]/ent-10/nh-[1.2.3.4]

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
forceOrderV4	rtmap:AdminSt (scalar:Enum8)	Force Order V4	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNh Properties

Property Name	Data Type	Description	Values
addr	address:Ip	The peer IP address.	Value must match ipv4 or ipv6 known format
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

Configuring to Drop Packets When Next-Hop is Unreachable

Configuring to Drop Packets When Next-Hop is Unreachable

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "dropOnFailV4": "enabled",
                  "order": "10",
                  "verifyAvailabilityV4": "enabled"
                },
                "children": [
                  {
                    "rtmapSetNh": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "trackId": "240"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <dropOnFailV4>enabled</dropOnFailV4>
            <verifyAvailabilityV4>enabled</verifyAvailabilityV4>
            <nh-items>
              <SetNh-list>
                <addr>1.2.3.4</addr>
                <trackId>240</trackId>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

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

CLI Commands

route-map Map_1
set ip next-hop verify-availability 1.2.3.4 track 240 drop-on-fail

Verifying a DME Configuration

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapSetNh	sys/rpm/rtmap-[Map_1]/ent-10/nh-[1.2.3.4]

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
dropOnFailV4	rtmap:AdminSt (scalar:Enum8)	Drop On Fail V4 for v4 nexthop	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]
verifyAvailabilityV4	rtmap:AdminSt (scalar:Enum8)	Next Hop with V4 Verify Availability	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

rtmapSetNh Properties

Property Name	Data Type	Description	Values
addr	address:Ip	The peer IP address.	Value must match ipv4 or ipv6 known format
trackId	scalar:Uint32	Track id for Next Hop VA Address	RANGE: [1 , 512]

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 Config to Drop Packets When Next-Hop is Unreachable

Deleting the Config to Drop Packets When Next-Hop is Unreachable

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

{
  "rpmEntity": {
    "children": [
      {
        "rtmapRule": {
          "attributes": {
            "name": "Map_1"
          },
          "children": [
            {
              "rtmapEntry": {
                "attributes": {
                  "action": "permit",
                  "dropOnFailV4": "disabled",
                  "order": "10"
                },
                "children": [
                  {
                    "rtmapSetNh": {
                      "attributes": {
                        "addr": "1.2.3.4",
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <rpm-items>
    <rtmap-items>
      <Rule-list>
        <name>Map_1</name>
        <ent-items>
          <Entry-list>
            <order>10</order>
            <action>permit</action>
            <dropOnFailV4>disabled</dropOnFailV4>
            <nh-items>
              <SetNh-list nc:operation="delete">
                <addr>1.2.3.4</addr>
              </SetNh-list>
            </nh-items>
          </Entry-list>
        </ent-items>
      </Rule-list>
    </rtmap-items>
  </rpm-items>
</System>

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

CLI Commands

route-map Map_1
no set ip next-hop verify-availability 1.2.3.4 track 240 drop-on-fail

Verifying a DME Configuration

MO	DN
rpmEntity	sys/rpm
rtmapRule	sys/rpm/rtmap-[Map_1]
rtmapEntry	sys/rpm/rtmap-[Map_1]/ent-10
rtmapSetNh	sys/rpm/rtmap-[Map_1]/ent-10/nh-[1.2.3.4]

rtmapRule Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	RANGE: [0 , 63]

rtmapEntry Properties

Property Name	Data Type	Description	Values
action	rtflt:Action (scalar:Enum8)	Action	SELECTION: 0 - deny 1 - permit DEFAULT: permit
dropOnFailV4	rtmap:AdminSt (scalar:Enum8)	Drop On Fail V4 for v4 nexthop	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled
order	rtflt:Order (scalar:Uint32)	Order	RANGE: [0 , 65535]

rtmapSetNh Properties

Property Name	Data Type	Description	Values
addr	address:Ip	The peer IP address.	Value must match ipv4 or ipv6 known format
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