Configuring a Route Map
You can use route maps for route redistribution or route filtering. Route maps can contain multiple match criteria and multiple set criteria. Configuring a route map for BGP triggers an automatic soft clear or refresh of BGP neighbor sessions.
For more information, see the Cisco Nexus 9000 Series NX-OS Unicast Routing Configuration Guide:
Configuring a Route Map
Configuring a Route Map
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "testRtMap"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"descr": "world",
"loadShareV4": "enabled",
"loadShareV6": "enabled",
"order": "10"
},
"children": [
{
"rtmapSetOrigin": {
"attributes": {
"originT": "egp",
"type": "origin"
}}},{
"rtmapMatchAsPathAccessList": {
"children": [
{
"rtmapRsRtAsPathAccAtt": {
"attributes": {
"tDn": "sys/rpm/accesslist-testAccList2"
}}},{
"rtmapRsRtAsPathAccAtt": {
"attributes": {
"tDn": "sys/rpm/accesslist-testAccList1"
}}}]}},{
"rtmapSetNh": {
"attributes": {
"addr": "10.10.10.10"
}}},{
"rtmapSetNh": {
"attributes": {
"addr": "2000::4"
}}},{
"rtmapSetRegComm": {
"attributes": {
"noCommAttr": "disabled"
},
"children": [
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65281"
}}},{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:0:0"
}}},{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65283"
}}},{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65282"
}}},{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65530:50300"
}}},{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65530:50800"
}}}]}},{
"rtmapMatchRegComm": {
"attributes": {
"criteria": "exact"
},
"children": [
{
"rtmapRsRegCommAtt": {
"attributes": {
"tDn": "sys/rpm/rtregcom-testRegComm1"
}}},{
"rtmapRsRegCommAtt": {
"attributes": {
"tDn": "sys/rpm/rtregcom-testRegComm2"
}}}]}},{
"rtmapMatchRtType": {
"attributes": {
"routeT": "external"
}}},{
"rtmapMatchRtType": {
"attributes": {
"routeT": "local"
}}},{
"rtmapMatchRtType": {
"attributes": {
"routeT": "isis-l2"
}}},{
"rtmapMatchRtTag": {
"attributes": {
"tag": "232"
}}},{
"rtmapMatchRtTag": {
"attributes": {
"tag": "231"
}}},{
"rtmapMatchRtDstV6": {
"children": [
{
"rtmapRsRtDstV6Att": {
"attributes": {
"tDn": "sys/rpm/pfxlistv6-testV6PfxList2"
}}},{
"rtmapRsRtDstV6Att": {
"attributes": {
"tDn": "sys/rpm/pfxlistv6-testV6PfxList1"
}}}]}},{
"rtmapMatchRtDst": {
"children": [
{
"rtmapRsRtDstAtt": {
"attributes": {
"tDn": "sys/rpm/pfxlistv4-testV4PfxList2"
}}},{
"rtmapRsRtDstAtt": {
"attributes": {
"tDn": "sys/rpm/pfxlistv4-testV4PfxList1"
}}}]}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>testRtMap</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<descr>world</descr>
<loadShareV4>enabled</loadShareV4>
<loadShareV6>enabled</loadShareV6>
<origin-items>
<originT>egp</originT>
<type>origin</type>
</origin-items>
<mrtacclist-items>
<rsrtAsPathAccAtt-items>
<RsRtAsPathAccAtt-list>
<tDn>/System/rpm-items/accesslist-items/Rule-list[name='testAccList2']</tDn>
</RsRtAsPathAccAtt-list>
<RsRtAsPathAccAtt-list>
<tDn>/System/rpm-items/accesslist-items/Rule-list[name='testAccList1']</tDn>
</RsRtAsPathAccAtt-list>
</rsrtAsPathAccAtt-items>
</mrtacclist-items>
<nh-items>
<SetNh-list>
<addr>10.10.10.10</addr>
</SetNh-list>
<SetNh-list>
<addr>2000::4</addr>
</SetNh-list>
</nh-items>
<sregcomm-items>
<noCommAttr>disabled</noCommAttr>
<item-items>
<Item-list>
<community>regular:as2-nn2:65535:65281</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:0:0</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:65535:65283</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:65535:65282</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:65530:50300</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:65530:50800</community>
</Item-list>
</item-items>
</sregcomm-items>
<mregcomm-items>
<criteria>exact</criteria>
<rsregCommAtt-items>
<RsRegCommAtt-list>
<tDn>/System/rpm-items/rtregcom-items/Rule-list[name='testRegComm1']</tDn>
</RsRegCommAtt-list>
<RsRegCommAtt-list>
<tDn>/System/rpm-items/rtregcom-items/Rule-list[name='testRegComm2']</tDn>
</RsRegCommAtt-list>
</rsregCommAtt-items>
</mregcomm-items>
<mrttype-items>
<MatchRtType-list>
<routeT>external</routeT>
</MatchRtType-list>
<MatchRtType-list>
<routeT>local</routeT>
</MatchRtType-list>
<MatchRtType-list>
<routeT>isis-l2</routeT>
</MatchRtType-list>
</mrttype-items>
<mrttag-items>
<MatchRtTag-list>
<tag>232</tag>
</MatchRtTag-list>
<MatchRtTag-list>
<tag>231</tag>
</MatchRtTag-list>
</mrttag-items>
<mrtdstv6-items>
<rsrtDstV6Att-items>
<RsRtDstV6Att-list>
<tDn>/System/rpm-items/pfxlistv6-items/RuleV6-list[name='testV6PfxList2']</tDn>
</RsRtDstV6Att-list>
<RsRtDstV6Att-list>
<tDn>/System/rpm-items/pfxlistv6-items/RuleV6-list[name='testV6PfxList1']</tDn>
</RsRtDstV6Att-list>
</rsrtDstV6Att-items>
</mrtdstv6-items>
<mrtdst-items>
<rsrtDstAtt-items>
<RsRtDstAtt-list>
<tDn>/System/rpm-items/pfxlistv4-items/RuleV4-list[name='testV4PfxList2']</tDn>
</RsRtDstAtt-list>
<RsRtDstAtt-list>
<tDn>/System/rpm-items/pfxlistv4-items/RuleV4-list[name='testV4PfxList1']</tDn>
</RsRtDstAtt-list>
</rsrtDstAtt-items>
</mrtdst-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
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.
network testRtMap permit 10
description world
match as-path testAccList1 testAccList2
match ip address prefix-list testV4PfxList1 testV4PfxList2
match ipv6 address prefix-list testV6PfxList1 testV6PfxList2
match tag 231 232
match community testRegComm1 testRegComm2 exact-match
match route-type external local level-2
set ip next-hop 10.10.10.10 load-share
set ipv6 next-hop 2000::4 load-share
set origin egp
set community internet 65530:50300 65530:50800 no-export no-advertise local-AS
Note: The set path-selection <> advertise
CLI command (and others listed below) is not currently supported in the REST DME model. A GET operation does not return the configured entity (rtmapSetPathSelection
in this case) and a POST operation does not set it. If this CLI command is present in your running configuration, you must reconfigure it manually after any operation that might clear it.
- This note applies to HTTP, NETCONF, and gNMI GET operations.
- This note applies to the following CLI commands:
set path-selection <> advertise
match as-number as-path-list <aspl-name>
set ip address prefix-list <name>
set ipv6 address prefix-list <name>
set level { level-1 | level-1-2 | level-2 }
set extcommunity evpn rmac <mac-addr>
match ipv6 multicast {{rp <ipv6rp> ...
ip extcommunity-list standard <name> {permit | deny} ...
ip extcommunity-list expanded <name> {deny | permit} <line> ...
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 |
---|---|
topSystem | sys |
rpmEntity | sys/rpm |
rtmapRule | sys/rpm/rtmap-{[name]} |
rtmapEntry | sys/rpm/rtmap-{[name]}/ent-{order} |
rtmapSetOrigin | sys/rpm/rtmap-{[name]}/ent-{order}/origin |
rtmapMatchAsPathAccessList | sys/rpm/rtmap-{[name]}/ent-{order}/mrtacclist |
rtmapRsRtAsPathAccAtt | sys/rpm/rtmap-{[name]}/ent-{order}/mrtacclist/rsrtAsPathAccAtt-{[tDn]} |
rtmapSetNh | sys/rpm/rtmap-{[name]}/ent-{order}/nh-{[addr]} |
rtmapSetRegComm | sys/rpm/rtmap-{[name]}/ent-{order}/sregcomm |
rtregcomItem | sys/rpm/rtmap-{[name]}/ent-{order}/sregcomm/item-{community} |
rtmapMatchRegComm | sys/rpm/rtmap-{[name]}/ent-{order}/mregcomm |
rtmapRsRegCommAtt | sys/rpm/rtmap-{[name]}/ent-{order}/mregcomm/rsregCommAtt-{[tDn]} |
rtmapMatchRtType | sys/rpm/rtmap-{[name]}/ent-{order}/mrttype-{[routeT]} |
rtmapMatchRtTag | sys/rpm/rtmap-{[name]}/ent-{order}/mrttag-{tag} |
rtmapMatchRtDstV6 | sys/rpm/rtmap-{[name]}/ent-{order}/mrtdstv6 |
rtmapRsRtDstV6Att | sys/rpm/rtmap-{[name]}/ent-{order}/mrtdstv6/rsrtDstV6Att-{[tDn]} |
rtmapMatchRtDst | sys/rpm/rtmap-{[name]}/ent-{order}/mrtdst |
rtmapRsRtDstAtt | sys/rpm/rtmap-{[name]}/ent-{order}/mrtdst/rsrtDstAtt-{[tDn]} |
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 |
descr | pol:Descr | descr | RANGE: [0 , 90] |
loadShareV4 | rtmap:AdminSt (scalar:Enum8) | Load Sharing V4 | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
loadShareV6 | rtmap:AdminSt (scalar:Enum8) | Load Sharing V6 | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
order | rtflt:Order (scalar:Uint32) | Order | RANGE: [0 , 65535] |
rtmapSetOrigin Properties
The following table contains information about the rtmapSetOrigin 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 |
---|---|---|---|
originT | rtmap:OriginT (scalar:Enum8) | Origin Type | SELECTION: 1 - egp 2 - igp 3 - incomplete DEFAULT: egp |
type | rtmap:SetT (scalar:Enum8) | The specific type of the object or component. | SELECTION: 1 - reg-community 2 - ext-gen-community 3 - rtt-community 4 - rt-tag 5 - rt-weight 6 - local-pref 7 - metric 8 - ospf-nssa 9 - ospf-fwd-addr 10 - ip-nh 11 - metric-type 12 - rt-dist 13 - nh-pa 14 - origin 15 - list-community 16 - dampening 17 - extcommunity-cost 18 - ip-prec 19 - continue 20 - rt-index 21 - list-extcommunity 22 - ipv6-prec 23 - prepend 24 - lastas 25 - as-pathtag 26 - ps-adv DEFAULT: origin |
rtmapRsRtAsPathAccAtt Properties
The following table contains information about the rtmapRsRtAsPathAccAtt 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
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 |
rtmapSetRegComm Properties
The following table contains information about the rtmapSetRegComm 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 |
---|---|---|---|
noCommAttr | rtmap:AdminSt (scalar:Enum8) | No Community Attribute | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
rtmapMatchRegComm Properties
The following table contains information about the rtmapMatchRegComm 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 |
---|---|---|---|
criteria | rtmap:Criteria (scalar:Enum8) | Criteria | SELECTION: 1 - exact 2 - sub-group DEFAULT: sub-group |
rtmapRsRegCommAtt Properties
The following table contains information about the rtmapRsRegCommAtt 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
rtmapMatchRtType Properties
The following table contains information about the rtmapMatchRtType 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 |
---|---|---|---|
routeT | rtmap:RouteT (scalar:Enum8) | Route Type | SELECTION: 1 - external 2 - internal 3 - ospf-inter-area 4 - ospf-intra-area 5 - isis-l1 6 - isis-l2 7 - local 8 - ospf-nssa-external 9 - ospf-type1 10 - ospf-type2 11 - R1 12 - mac-only 13 - mac-ip 14 - R2_ALL 15 - R3 16 - R4 17 - R5 18 - R6 DEFAULT: external |
rtmapMatchRtTag Properties
The following table contains information about the rtmapMatchRtTag 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 |
---|---|---|---|
tag | rtmap:RouteTag (scalar:Uint32) | The color of a policy label. | RANGE: [0, 4294967295] |
rtmapRsRtDstV6Att Properties
The following table contains information about the rtmapRsRtDstV6Att 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
rtmapRsRtDstAtt Properties
The following table contains information about the rtmapRsRtDstAtt 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Redirect VRF
Configuring Redirect VRF
POST http://<mgmt0_IP>/api/mo/sys.json
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "test"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetVrf": {
"attributes": {
"vrfName": "one"
}
}
}
]
}
}
]
}
}
]
}
}
Response
{
imdata:[]
}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>test</name>
<ent-items>
<Entry-list>
<order>10</order>
<svrf-items>
<vrfName>one</vrfName>
</svrf-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
CLI Command
The CLI command below is the equivalent of the payload example displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.
route-map test permit 10
set vrf one
Note: The property information for this example was added in Release 10.5(2).
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} | rtmapSetVrf | sys/rpm/rtmap-{[name]}/ent-{order}/svrf |
Properties
The following table contains information about the 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 |
---|---|---|---|
vrfName | l3:VrfName (string:Basic) | Set VRF Name for PBR redirection | MAX SIZE: 32 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Set VRF Recalculation Interface
Configuring Set VRF Recalculation Interface
POST http://<mgmt0_IP>/api/mo/sys.json
POST: http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rpmInst": {
"children": [
{
"rpmPbrSetVrfRecircIntf": {
"attributes": {
"id": "po1.1",
"vrfName": "one"
}
}
}
]
}
}
]
}
}
Response:
{
"imdata": []
}
{
imdata:[]
}
<System>
<rpm-items>
<inst-items>
<pbrsetvrfrecircintf-items>
<PbrSetVrfRecircIntf-list>
<vrfName>one</vrfName>
<id>po1.1</id>
</PbrSetVrfRecircIntf-list>
</pbrsetvrfrecircintf-items>
</inst-items>
</rpm-items>
</System>
CLI Command
The CLI command below is the equivalent of the payload example displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.
vrf context one
pbr set-vrf recirculation interface port-channel1.1
Note: The property information for this example was added in Release 10.5(2).
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 |
rpmInst | sys/rpm/inst |
vrfName | sys/rpm/inst/pbrsetvrfrecircintf-[vrfName] |
Properties
The following table contains information about the 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 |
---|---|---|---|
vrfName | l3:VrfName (string:Basic) | Set VRF Name for PBR redirection | MAX SIZE: 32 |
id | nw:IfId | Recirculation Interface that will be used for set-vrf feature | Must match first field in the output of `show intf brief`. Example: port-channel1.1 or po1.1 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Matching Two BGP Communities
Matching Two BGP Communities
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "test2"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchRegComm": {
"children": [
{
"rtmapRsRegCommAtt": {
"attributes": {
"tDn": "sys/rpm/rtregcom-bgpHigh"
}}},{
"rtmapRsRegCommAtt": {
"attributes": {
"tDn": "sys/rpm/rtregcom-bgpLow"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>test2</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mregcomm-items>
<rsregCommAtt-items>
<RsRegCommAtt-list>
<tDn>/System/rpm-items/rtregcom-items/Rule-list[name='bgpHigh']</tDn>
</RsRegCommAtt-list>
<RsRegCommAtt-list>
<tDn>/System/rpm-items/rtregcom-items/Rule-list[name='bgpLow']</tDn>
</RsRegCommAtt-list>
</rsregCommAtt-items>
</mregcomm-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
This example shows how to match two BGP communities.
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 test2
match community bgpLow bgpHigh
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} |
rtmapMatchRegComm | sys/rpm/rtmap-{[name]}/ent-{order}/mregcomm |
rtmapRsRegCommAtt | sys/rpm/rtmap-{[name]}/ent-{order}/mregcomm/rsregCommAtt-{[tDn]} |
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] |
rtmapRsRegCommAtt Properties
The following table contains information about the rtmapRsRegCommAtt 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Removing a Configured Match of Two BGP Communities
Removing a Configured Match of Two BGP Communities
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "test2"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchRegComm": {
"children": [
{
"rtmapRsRegCommAtt": {
"attributes": {
"status": "deleted",
"tDn": "sys/rpm/rtregcom-bgpHigh"
}}},{
"rtmapRsRegCommAtt": {
"attributes": {
"status": "deleted",
"tDn": "sys/rpm/rtregcom-bgpLow"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>test2</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mregcomm-items>
<rsregCommAtt-items>
<RsRegCommAtt-list xc:operation="delete">
<tDn>/System/rpm-items/rtregcom-items/Rule-list[name='bgpHigh']</tDn>
</RsRegCommAtt-list>
<RsRegCommAtt-list xc:operation="delete">
<tDn>/System/rpm-items/rtregcom-items/Rule-list[name='bgpLow']</tDn>
</RsRegCommAtt-list>
</rsregCommAtt-items>
</mregcomm-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
This example shows how to remove a match for two BGP communities.
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 test2
no match community bgpLow bgpHigh
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} |
rtmapMatchRegComm | sys/rpm/rtmap-{[name]}/ent-{order}/mregcomm |
rtmapRsRegCommAtt | sys/rpm/rtmap-{[name]}/ent-{order}/mregcomm/rsregCommAtt-{[tDn]} |
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] |
rtmapRsRegCommAtt Properties
The following table contains information about the rtmapRsRegCommAtt 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 |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Setting the Segment Routing (SR) Label Index of a Route
Setting the Segment Routing (SR) Label Index of a Route
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "map1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetLabelIndex": {
"attributes": {
"index": "123",
"type": "rt-index"
}}}]}}]}}]}},{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "default"
},
"children": [
{
"bgpDomAf": {
"attributes": {
"type": "ipv4-ucast"
},
"children": [
{
"bgpAdvPrefix": {
"attributes": {
"addr": "0.0.0.0/2",
"rtMap": "map1"
}}}]}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>map1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<slblindex-items>
<index>123</index>
<type>rt-index</type>
</slblindex-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<type>ipv4-ucast</type>
<prefix-items>
<AdvPrefix-list>
<addr>0.0.0.0/2</addr>
<rtMap>map1</rtMap>
</AdvPrefix-list>
</prefix-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-items>
</System>
This example sets the label index for routes that match the network command. The range is from 0 to 471788. By default, a label index is not added to the route.
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 label-index 123
router bgp 100
address-family ipv4 unicast
network 1.2.3.4/2 route-map map1
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 |
---|---|
topSystem | sys |
rpmEntity | sys/rpm |
rtmapRule | sys/rpm/rtmap-{[name]} |
rtmapEntry | sys/rpm/rtmap-{[name]}/ent-{order} |
rtmapSetLabelIndex | sys/rpm/rtmap-{[name]}/ent-{order}/slblindex |
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-{name} |
bgpDomAf | sys/bgp/inst/dom-{name}/af-{[type]} |
bgpAdvPrefix | sys/bgp/inst/dom-{name}/af-{[type]}/prefix-{[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] |
rtmapSetLabelIndex Properties
The following table contains information about the rtmapSetLabelIndex 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 |
---|---|---|---|
index | rtmap:Index (scalar:Uint32) | Label Index | RANGE: [0 , 471788] |
type | rtmap:SetT (scalar:Enum8) | The specific type of the object or component. | SELECTION: 1 - reg-community 2 - ext-gen-community 3 - rtt-community 4 - rt-tag 5 - rt-weight 6 - local-pref 7 - metric 8 - ospf-nssa 9 - ospf-fwd-addr 10 - ip-nh 11 - metric-type 12 - rt-dist 13 - nh-pa 14 - origin 15 - list-community 16 - dampening 17 - extcommunity-cost 18 - ip-prec 19 - continue 20 - rt-index 21 - list-extcommunity 22 - ipv6-prec 23 - prepend 24 - lastas 25 - as-pathtag 26 - ps-adv DEFAULT: rt-index |
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 |
bgpDomAf Properties
The following table contains information about the bgpDomAf 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 |
---|---|---|---|
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast |
bgpAdvPrefix Properties
The following table contains information about the bgpAdvPrefix 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 network or prefix to advertise | Value must match ipv4 or ipv6 known format |
rtMap | string:Basic | Route map to modify attributes | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Segment Routing (SR) Label Index of a Route (IPv4)
Deleting the Segment Routing (SR) Label Index of a Route
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "map1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetLabelIndex": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}},{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "default"
},
"children": [
{
"bgpDomAf": {
"attributes": {
"type": "ipv4-ucast"
},
"children": [
{
"bgpAdvPrefix": {
"attributes": {
"addr": "0.0.0.0/2",
"rtMap": "map1"
}}}]}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>map1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<slblindex-items xc:operation="delete">
</slblindex-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<type>ipv4-ucast</type>
<prefix-items>
<AdvPrefix-list>
<addr>0.0.0.0/2</addr>
<rtMap>map1</rtMap>
</AdvPrefix-list>
</prefix-items>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-items>
</System>
This example deletes the label index for routes that match the network command.
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
no set label-index 123
router bgp 100
address-family ipv4 unicast
network 1.2.3.4/2 route-map map1
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 |
---|---|
topSystem | sys |
rpmEntity | sys/rpm |
rtmapRule | sys/rpm/rtmap-{[name]} |
rtmapEntry | sys/rpm/rtmap-{[name]}/ent-{order} |
rtmapSetLabelIndex | sys/rpm/rtmap-{[name]}/ent-{order}/slblindex |
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-{name} |
bgpDomAf | sys/bgp/inst/dom-{name}/af-{[type]} |
bgpAdvPrefix | sys/bgp/inst/dom-{name}/af-{[type]}/prefix-{[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] |
rtmapSetLabelIndex Properties
The following table contains information about the rtmapSetLabelIndex 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 |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
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 |
bgpDomAf Properties
The following table contains information about the bgpDomAf 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 |
---|---|---|---|
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast |
bgpAdvPrefix Properties
The following table contains information about the bgpAdvPrefix 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 network or prefix to advertise | Value must match ipv4 or ipv6 known format |
rtMap | string:Basic | Route map to modify attributes | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Setting the Local Preference to 100 for all Routes Included in an Access List
Setting the Local Preference to 100 for all Routes Included in an Access List
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "map-preference"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchAsPathAccessList": {
"children": [
{
"rtmapRsRtAsPathAccAtt": {
"attributes": {
"tDn": "sys/rpm/accesslist-1"
}}}]}},{
"rtmapSetPref": {
"attributes": {
"localPref": "100",
"type": "local-pref"
}}}]}}]}},{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>map-preference</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mrtacclist-items>
<rsrtAsPathAccAtt-items>
<RsRtAsPathAccAtt-list>
<tDn>/System/rpm-items/accesslist-items/Rule-list[name='1']</tDn>
</RsRtAsPathAccAtt-list>
</rsrtAsPathAccAtt-items>
</mrtacclist-items>
<spref-items>
<localPref>100</localPref>
<type>local-pref</type>
</spref-items>
</Entry-list>
</ent-items>
</Rule-list>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
The preference is sent only to all routers in the local autonomous system.
You must have a match clause (even if it points to a "permit everything" list) if you want to set tags.
Use the route-map global configuration command and the match and set route-map configuration commands to define the conditions for redistributing routes from one routing protocol into another. Each route-map command has a list of match and set commands associated with it. The match commands specify the match criteria—the conditions under which redistribution is allowed for the current route-map command. The set commands specify the set actions—the particular redistribution actions to perform if the criteria enforced by the match commands are met. The no route-map command deletes the route map.
The set route-map configuration commands specify the redistribution set actions to be performed when all the match criteria of a route map are met. When all match criteria are met, all set actions are performed.
This example shows how to set the local preference to 100 for all routes that are included in access list 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.
route-map map-preference
match as-path 1
set local-preference 100
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} |
rtmapMatchAsPathAccessList | sys/rpm/rtmap-{[name]}/ent-{order}/mrtacclist |
rtmapRsRtAsPathAccAtt | sys/rpm/rtmap-{[name]}/ent-{order}/mrtacclist/rsrtAsPathAccAtt-{[tDn]} |
rtmapSetPref | sys/rpm/rtmap-{[name]}/ent-{order}/spref |
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] |
rtmapRsRtAsPathAccAtt Properties
The following table contains information about the rtmapRsRtAsPathAccAtt 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
rtmapSetPref Properties
The following table contains information about the rtmapSetPref 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 |
---|---|---|---|
localPref | rtmap:LocalPref (scalar:Uint32) | Local Preference | RANGE: [0, 4294967295] |
type | rtmap:SetT (scalar:Enum8) | The specific type of the object or component. | SELECTION: 1 - reg-community 2 - ext-gen-community 3 - rtt-community 4 - rt-tag 5 - rt-weight 6 - local-pref 7 - metric 8 - ospf-nssa 9 - ospf-fwd-addr 10 - ip-nh 11 - metric-type 12 - rt-dist 13 - nh-pa 14 - origin 15 - list-community 16 - dampening 17 - extcommunity-cost 18 - ip-prec 19 - continue 20 - rt-index 21 - list-extcommunity 22 - ipv6-prec 23 - prepend 24 - lastas 25 - as-pathtag 26 - ps-adv DEFAULT: local-pref |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Local Preference Set to 100 for all Routes Included in an Access List
Deleting the Local Preference Set to 100 for all Routes Included in an Access List
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "map-preference"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchAsPathAccessList": {
"children": [
{
"rtmapRsRtAsPathAccAtt": {
"attributes": {
"tDn": "sys/rpm/accesslist-1"
}}}]}},{
"rtmapSetPref": {
"attributes": {
"status": "deleted"
}}}]}}]}},{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>map-preference</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mrtacclist-items>
<rsrtAsPathAccAtt-items>
<RsRtAsPathAccAtt-list>
<tDn>/System/rpm-items/accesslist-items/Rule-list[name='1']</tDn>
</RsRtAsPathAccAtt-list>
</rsrtAsPathAccAtt-items>
</mrtacclist-items>
<spref-items xc:operation="delete">
</spref-items>
</Entry-list>
</ent-items>
</Rule-list>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
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 map-preference
match as-path 1
no set local-preference 100
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} |
rtmapMatchAsPathAccessList | sys/rpm/rtmap-{[name]}/ent-{order}/mrtacclist |
rtmapRsRtAsPathAccAtt | sys/rpm/rtmap-{[name]}/ent-{order}/mrtacclist/rsrtAsPathAccAtt-{[tDn]} |
rtmapSetPref | sys/rpm/rtmap-{[name]}/ent-{order}/spref |
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] |
rtmapRsRtAsPathAccAtt Properties
The following table contains information about the rtmapRsRtAsPathAccAtt 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
rtmapSetPref Properties
The following table contains information about the rtmapSetPref 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 |
---|---|---|---|
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:
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:
Building and Matching a Prefix List
Building and Matching a Prefix List
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"rpmEntity": {
"children": [
{
"rtpfxRuleV4": {
"attributes": {
"name": "List_1"
},
"children": [
{
"rtpfxEntry": {
"attributes": {
"action": "permit",
"criteria": "exact",
"fromPfxLen": "0",
"order": "123",
"pfx": "1.2.3.4/2",
"toPfxLen": "0"
}}}]},{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "deny",
"order": "10"
},
"children": [
{
"rtmapMatchRtDst": {
"children": [
{
"rtmapRsRtDstAtt": {
"attributes": {
"tDn": "sys/rpm/pfxlistv4-List_1"
}}}]}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<pfxlistv4-items>
<RuleV4-list>
<name>List_1</name>
<ent-items>
<Entry-list>
<order>123</order>
<action>permit</action>
<criteria>exact</criteria>
<fromPfxLen>0</fromPfxLen>
<pfx>1.2.3.4/2</pfx>
<toPfxLen>0</toPfxLen>
</Entry-list>
</ent-items>
</RuleV4-list>
</pfxlistv4-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>deny</action>
<mrtdst-items>
<rsrtDstAtt-items>
<RsRtDstAtt-list>
<tDn>/System/rpm-items/pfxlistv4-items/RuleV4-list[name='List_1']</tDn>
</RsRtDstAtt-list>
</rsrtDstAtt-items>
</mrtdst-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
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.
ip prefix-list List_1 seq 123 permit 1.2.3.4/2
route-map Map_1 deny
match ip address prefix-list List_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 |
---|---|
topSystem | sys |
rpmEntity | sys/rpm |
rtpfxRuleV4 | sys/rpm/pfxlistv4-{[name]} |
rtpfxEntry | sys/rpm/pfxlistv6-{[name]}/ent-{order} |
rtmapRule | sys/rpm/rtmap-{[name]} |
rtmapEntry | sys/rpm/rtmap-{[name]}/ent-{order} |
rtmapMatchRtDst | sys/rpm/rtmap-{[name]}/ent-{order}/mrtdst |
rtmapRsRtDstAtt | sys/rpm/rtmap-{[name]}/ent-{order}/mrtdst/rsrtDstAtt-{[tDn]} |
rtpfxRuleV4 Properties
The following table contains information about the rtpfxRuleV4 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 | MAX SIZE: 64 |
rtpfxEntry Properties
The following table contains information about the rtpfxEntry 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 |
criteria | rtpfx:Criteria (scalar:Enum8) | Criteria | SELECTION: 0 - exact 1 - inexact DEFAULT: exact |
fromPfxLen | l3:IpPfxLen (scalar:Uint16) | The start of a range used to describe the prefix length if the criteria is not an exact match. | RANGE: [0 , 128] DEFAULT: 0 |
order | rtflt:Order (scalar:Uint32) | Order | RANGE: [1 , 4294967294] |
pfx | address:Ip | Specifies the OSPF route prefix. | Value must match ipv4 or ipv6 known format |
toPfxLen | l3:IpPfxLen (scalar:Uint16) | The end of a range to describe the prefix length if the criteria is not an exact match. | RANGE: [0 , 128] DEFAULT: 0 |
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] |
rtmapRsRtDstAtt Properties
The following table contains information about the rtmapRsRtDstAtt 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a BGP Community with Graceful Shutdown
Configuring a BGP Community with Graceful Shutdown
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetRegComm": {
"attributes": {
"additive": "enabled",
"noCommAttr": "disabled"
},
"children": [
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:123:12"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:0"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:0:0"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65283"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65282"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65281"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<sregcomm-items>
<additive>enabled</additive>
<noCommAttr>disabled</noCommAttr>
<item-items>
<Item-list>
<community>regular:as2-nn2:123:12</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:65535:0</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:0:0</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:65535:65283</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:65535:65282</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:65535:65281</community>
</Item-list>
</item-items>
</sregcomm-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
set community additive internet no-advertise no-export local-AS graceful-shutdown 123:12
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
rpmEntity | sys/rpm |
rtmapRule | sys/rpm/rtmap-[Map_1] |
rtmapEntry | sys/rpm/rtmap-[Map_1]/ent-10 |
rtmapSetRegComm | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:123:12 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:0 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:0:0 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65283 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65282 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65281 |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetRegComm Properties
The following table contains information about the rtmapSetRegComm 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 |
---|---|---|---|
additive | rtmap:AdminSt (scalar:Enum8) | Add To Existing Community | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
noCommAttr | rtmap:AdminSt (scalar:Enum8) | No Community Attribute | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a BGP Community with Graceful Shutdown
Deleting a BGP Community with Graceful Shutdown
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetRegComm": {
"attributes": {
"additive": "disabled"
},
"children": [
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:123:12",
"status": "deleted"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:0",
"status": "deleted"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:0:0",
"status": "deleted"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65283",
"status": "deleted"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65282",
"status": "deleted"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65281",
"status": "deleted"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<sregcomm-items>
<additive>disabled</additive>
<item-items>
<Item-list nc:operation="delete">
<community>regular:as2-nn2:123:12</community>
</Item-list>
<Item-list nc:operation="delete">
<community>regular:as2-nn2:65535:0</community>
</Item-list>
<Item-list nc:operation="delete">
<community>regular:as2-nn2:0:0</community>
</Item-list>
<Item-list nc:operation="delete">
<community>regular:as2-nn2:65535:65283</community>
</Item-list>
<Item-list nc:operation="delete">
<community>regular:as2-nn2:65535:65282</community>
</Item-list>
<Item-list nc:operation="delete">
<community>regular:as2-nn2:65535:65281</community>
</Item-list>
</item-items>
</sregcomm-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
no set community additive internet no-advertise no-export local-AS graceful-shutdown 123:12
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
rpmEntity | sys/rpm |
rtmapRule | sys/rpm/rtmap-[Map_1] |
rtmapEntry | sys/rpm/rtmap-[Map_1]/ent-10 |
rtmapSetRegComm | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:123:12 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:0 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:0:0 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65283 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65282 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65281 |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetRegComm Properties
The following table contains information about the rtmapSetRegComm 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 |
---|---|---|---|
additive | rtmap:AdminSt (scalar:Enum8) | Add To Existing Community | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community | |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community | |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community | |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community | |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community | |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community | |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | 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:
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:
Configuring No Community Attribute
Configuring No Community Attribute
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetRegComm": {
"attributes": {
"noCommAttr": "enabled"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<sregcomm-items>
<noCommAttr>enabled</noCommAttr>
</sregcomm-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
set community none
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 |
rtmapSetRegComm | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetRegComm Properties
The following table contains information about the rtmapSetRegComm 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 |
---|---|---|---|
noCommAttr | rtmap:AdminSt (scalar:Enum8) | No Community Attribute | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting No Community Attribute
Deleting No Community Attribute
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetRegComm": {
"attributes": {
"noCommAttr": "disabled"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<sregcomm-items>
<noCommAttr>disabled</noCommAttr>
</sregcomm-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
no set community none
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 |
rtmapSetRegComm | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetRegComm Properties
The following table contains information about the rtmapSetRegComm 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 |
---|---|---|---|
noCommAttr | rtmap:AdminSt (scalar:Enum8) | No Community Attribute | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a BGP Community to Not Send Outside Local AS
Configuring a BGP Community to Not Send Outside Local AS
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetRegComm": {
"attributes": {
"additive": "enabled",
"noCommAttr": "disabled"
},
"children": [
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:123:12"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:0:0"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65283"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65282"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65281"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<sregcomm-items>
<additive>enabled</additive>
<noCommAttr>disabled</noCommAttr>
<item-items>
<Item-list>
<community>regular:as2-nn2:123:12</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:0:0</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:65535:65283</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:65535:65282</community>
</Item-list>
<Item-list>
<community>regular:as2-nn2:65535:65281</community>
</Item-list>
</item-items>
</sregcomm-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
set community additive internet no-advertise no-export local-AS 123:12
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
rpmEntity | sys/rpm |
rtmapRule | sys/rpm/rtmap-[Map_1] |
rtmapEntry | sys/rpm/rtmap-[Map_1]/ent-10 |
rtmapSetRegComm | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:123:12 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:0:0 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65283 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65282 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65281 |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetRegComm Properties
The following table contains information about the rtmapSetRegComm 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 |
---|---|---|---|
additive | rtmap:AdminSt (scalar:Enum8) | Add To Existing Community | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
noCommAttr | rtmap:AdminSt (scalar:Enum8) | No Community Attribute | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a BGP Community to Not Send Outside Local AS
Deleting a BGP Community to Not Send Outside Local AS
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetRegComm": {
"attributes": {
"additive": "disabled"
},
"children": [
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:123:12",
"status": "deleted"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:0:0",
"status": "deleted"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65283",
"status": "deleted"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65282",
"status": "deleted"
}
}
},
{
"rtregcomItem": {
"attributes": {
"community": "regular:as2-nn2:65535:65281",
"status": "deleted"
}
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<sregcomm-items>
<additive>disabled</additive>
<item-items>
<Item-list nc:operation="delete">
<community>regular:as2-nn2:123:12</community>
</Item-list>
<Item-list nc:operation="delete">
<community>regular:as2-nn2:0:0</community>
</Item-list>
<Item-list nc:operation="delete">
<community>regular:as2-nn2:65535:65283</community>
</Item-list>
<Item-list nc:operation="delete">
<community>regular:as2-nn2:65535:65282</community>
</Item-list>
<Item-list nc:operation="delete">
<community>regular:as2-nn2:65535:65281</community>
</Item-list>
</item-items>
</sregcomm-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
no set community additive internet no-advertise no-export local-AS 123:12
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
topSystem | sys |
rpmEntity | sys/rpm |
rtmapRule | sys/rpm/rtmap-[Map_1] |
rtmapEntry | sys/rpm/rtmap-[Map_1]/ent-10 |
rtmapSetRegComm | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:123:12 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:0:0 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65283 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65282 |
rtregcomItem | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm/item-regular:as2-nn2:65535:65281 |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetRegComm Properties
The following table contains information about the rtmapSetRegComm 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 |
---|---|---|---|
additive | rtmap:AdminSt (scalar:Enum8) | Add To Existing Community | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community | |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community | |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community | |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community | |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
rtregcomItem Properties
The following table contains information about the rtregcomItem 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 |
---|---|---|---|
community | base:Community | Community | |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | 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:
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:
Configuring No Community Attribute
Configuring No Community Attribute
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetRegComm": {
"attributes": {
"noCommAttr": "enabled"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<sregcomm-items>
<noCommAttr>enabled</noCommAttr>
</sregcomm-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
set community none
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 |
rtmapSetRegComm | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetRegComm Properties
The following table contains information about the rtmapSetRegComm 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 |
---|---|---|---|
noCommAttr | rtmap:AdminSt (scalar:Enum8) | No Community Attribute | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting No Community Attribute
Deleting No Community Attribute
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetRegComm": {
"attributes": {
"noCommAttr": "disabled"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<sregcomm-items>
<noCommAttr>disabled</noCommAttr>
</sregcomm-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
no set community none
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 |
rtmapSetRegComm | sys/rpm/rtmap-[Map_1]/ent-10/sregcomm |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetRegComm Properties
The following table contains information about the rtmapSetRegComm 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 |
---|---|---|---|
noCommAttr | rtmap:AdminSt (scalar:Enum8) | No Community Attribute | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring the Address Match of a Route
Configuring the Address Match of a Route
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchRtDst": {
"children": [
{
"rtmapRsRtDstAccAtt": {
"attributes": {
"tDn": "sys/rpm/accesslist-[SampleString_123]"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mrtdst-items>
<rsrtDstAccAtt-items>
<RsRtDstAccAtt-list>
<tDn>/System/rpm-items/accesslist-items/Rule-list[name='SampleString_123']</tDn>
</RsRtDstAccAtt-list>
</rsrtDstAccAtt-items>
</mrtdst-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
match ip address SampleString_123
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 |
rtmapMatchRtDst | sys/rpm/rtmap-[Map_1]/ent-10/mrtdst |
rtmapRsRtDstAccAtt | sys/rpm/rtmap-[Map_1]/ent-10/mrtdst/rsrtDstAccAtt-[sys/rpm/accesslist-[SampleString_123]] |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapRsRtDstAccAtt Properties
The following table contains information about the rtmapRsRtDstAccAtt 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Address Match of a Route
Deleting the Address Match of a Route
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchRtDst": {
"children": [
{
"rtmapRsRtDstAccAtt": {
"attributes": {
"status": "deleted",
"tDn": "sys/rpm/accesslist-[SampleString_123]"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mrtdst-items>
<rsrtDstAccAtt-items>
<RsRtDstAccAtt-list nc:operation="delete">
<tDn>/System/rpm-items/accesslist-items/Rule-list[name='SampleString_123']</tDn>
</RsRtDstAccAtt-list>
</rsrtDstAccAtt-items>
</mrtdst-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
no match ip address SampleString_123
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 |
rtmapMatchRtDst | sys/rpm/rtmap-[Map_1]/ent-10/mrtdst |
rtmapRsRtDstAccAtt | sys/rpm/rtmap-[Map_1]/ent-10/mrtdst/rsrtDstAccAtt-[sys/rpm/accesslist-[SampleString_123]] |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapRsRtDstAccAtt Properties
The following table contains information about the rtmapRsRtDstAccAtt 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 |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Prepend to the AS-Path
Configuring Prepend to the AS-Path
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetPrepend": {
"attributes": {
"as": "123 "
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathprepend-items>
<as>123 </as>
</setaspathprepend-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
set as-path prepend 123
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 |
rtmapSetPrepend | sys/rpm/rtmap-[Map_1]/ent-10/setaspathprepend |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetPrepend Properties
The following table contains information about the rtmapSetPrepend 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 |
---|---|---|---|
as | string:Basic | As Path Prepend | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Prepend to the AS-Path
Deleting Prepend to the AS-Path
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetPrepend": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathprepend-items nc:operation="delete">
</setaspathprepend-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
no set as-path prepend 123
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 |
rtmapSetPrepend | sys/rpm/rtmap-[Map_1]/ent-10/setaspathprepend |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetPrepend Properties
The following table contains information about the rtmapSetPrepend 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 |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | 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:
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:
Configuring Prepend Last AS to the AS-Path
Configuring Prepend Last AS to the AS-Path
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetPrependLastAs": {
"attributes": {
"lastas": "6"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathlastas-items>
<lastas>6</lastas>
</setaspathlastas-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
set as-path prepend last-as 6
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 |
rtmapSetPrependLastAs | sys/rpm/rtmap-[Map_1]/ent-10/setaspathlastas |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetPrependLastAs Properties
The following table contains information about the rtmapSetPrependLastAs 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 |
---|---|---|---|
lastas | rtmap:RouteLastAs (scalar:Uint16) | LastAs | RANGE: [1 , 10] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Prepend Last AS to the AS-Path
Deleting Prepend Last AS to the AS-Path
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetPrependLastAs": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathlastas-items nc:operation="delete">
</setaspathlastas-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
no set as-path prepend last-as 6
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 |
rtmapSetPrependLastAs | sys/rpm/rtmap-[Map_1]/ent-10/setaspathlastas |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetPrependLastAs Properties
The following table contains information about the rtmapSetPrependLastAs 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 |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | 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:
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:
Configuring the Tag as an AS-Path Attribute
Configuring the Tag as an AS-Path Attribute
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetAsPathTag": {
"attributes": {
"tag": "enabled"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathtag-items>
<tag>enabled</tag>
</setaspathtag-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
set as-path tag
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 |
rtmapSetAsPathTag | sys/rpm/rtmap-[Map_1]/ent-10/setaspathtag |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetAsPathTag Properties
The following table contains information about the rtmapSetAsPathTag 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 |
---|---|---|---|
tag | rtmap:AdminSt (scalar:Enum8) | Set as path tag | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Tag as an AS-Path Attribute
Deleting the Tag as an AS-Path Attribute
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetAsPathTag": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathtag-items nc:operation="delete">
</setaspathtag-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map Map_1
no set as-path tag
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 |
rtmapSetAsPathTag | sys/rpm/rtmap-[Map_1]/ent-10/setaspathtag |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
rtmapSetAsPathTag Properties
The following table contains information about the rtmapSetAsPathTag 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 |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | 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:
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:
Setting Route Map Operations
Setting Route Map Operations
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "pol1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
}}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>pol1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
route-map pol1 permit 10
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-[pol1] |
rtmapEntry | sys/rpm/rtmap-[pol1]/ent-10 |
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] |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "63" |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Unsetting Route Map Operations
Unsetting Route Map Operations
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "pol1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"order": "10",
"status": "deleted"
}}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>pol1</name>
<ent-items>
<Entry-list nc:operation="delete">
<order>10</order>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(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.
no route-map pol1 permit 10
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-[pol1] |
rtmapEntry | sys/rpm/rtmap-[pol1]/ent-10 |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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 |
---|---|---|---|
order | rtflt:Order (scalar:Uint32) | Order | RANGE: [0 , 65535] |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | 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:
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:
Configuring IP Next Hop for a Route Map
Configuring IP Next Hop for a Route Map
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Pol1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetNh": {
"attributes": {
"addr": "1.1.1.1"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Pol1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<nh-items>
<SetNh-list>
<addr>1.1.1.1</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(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.
route-map Pol1
set ip next-hop 1.1.1.1
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-[Pol1] |
rtmapEntry | sys/rpm/rtmap-[Pol1]/ent-10 |
rtmapSetNh | sys/rpm/rtmap-[Pol1]/ent-10/nh-[1.1.1.1] |
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 |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an IP Next Hop Configured for a Route Map
Deleting an IP Next Hop Configured for a Route Map
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Pol1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetNh": {
"attributes": {
"addr": "1.1.1.1",
"status": "deleted"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Pol1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<nh-items>
<SetNh-list nc:operation="delete">
<addr>1.1.1.1</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(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.
route-map Pol1
no set ip next-hop 1.1.1.1
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-[Pol1] |
rtmapEntry | sys/rpm/rtmap-[Pol1]/ent-10 |
rtmapSetNh | sys/rpm/rtmap-[Pol1]/ent-10/nh-[1.1.1.1] |
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 string:Basic | The name of the object. | RANGE: Min: "1" Max: "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 |
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | 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:
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:
Configuring the Sequence to Insert From a Route-Map Entry
Configuring the Sequence to Insert From a Route-Map Entry
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "SampleString_123"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "1"
}}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>SampleString_123</name>
<ent-items>
<Entry-list>
<order>1</order>
<action>permit</action>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map SampleString_123 1
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-[SampleString_123] |
rtmapEntry | sys/rpm/rtmap-[SampleString_123]/ent-1 |
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] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Sequence to Insert From a Route-Map Entry
Deleting the Sequence to Insert From a Route-Map Entry
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "SampleString_123"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"order": "1",
"status": "deleted"
}}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>SampleString_123</name>
<ent-items>
<Entry-list nc:operation="delete">
<order>1</order>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no route-map SampleString_123 1
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-[SampleString_123] |
rtmapEntry | sys/rpm/rtmap-[SampleString_123]/ent-1 |
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 |
---|---|---|---|
order | rtflt:Order (scalar:Uint32) | Order | RANGE: [0 , 65535] |
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:
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:
Configuring Match First Hop Interface of Route
Configuring Match First Hop Interface of Route
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchRtIf": {
"attributes": {
"id": "eth1/2"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mrtif-items>
<MatchRtIf-list>
<id>eth1/2</id>
</MatchRtIf-list>
</mrtif-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
match interface ethernet 1/2
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 |
rtmapMatchRtIf | sys/rpm/rtmap-[Map_1]/ent-10/mrtif-[eth1/2] |
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] |
rtmapMatchRtIf Properties
The following table contains information about the rtmapMatchRtIf 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 |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Route If | 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:
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:
Deleting Match First Hop Interface of Route
Deleting Match First Hop Interface of Route
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchRtIf": {
"attributes": {
"id": "eth1/2",
"status": "deleted"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mrtif-items>
<MatchRtIf-list nc:operation="delete">
<id>eth1/2</id>
</MatchRtIf-list>
</mrtif-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
no match interface ethernet 1/2
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 |
rtmapMatchRtIf | sys/rpm/rtmap-[Map_1]/ent-10/mrtif-[eth1/2] |
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] |
rtmapMatchRtIf Properties
The following table contains information about the rtmapMatchRtIf 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 |
---|---|---|---|
id | nw:IfId (base:IfIndex) | Route If | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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:
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:
Configuring Match Address of Route or Match packet
Configuring Match Address of Route or Match packet
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchRtDstV6": {
"children": [
{
"rtmapRsRtDstV6AccAtt": {
"attributes": {
"tDn": "sys/rpm/accesslist-[SampleString_123]"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mrtdstv6-items>
<rsrtDstV6AccAtt-items>
<RsRtDstV6AccAtt-list>
<tDn>/System/rpm-items/accesslist-items/Rule-list[name='SampleString_123']</tDn>
</RsRtDstV6AccAtt-list>
</rsrtDstV6AccAtt-items>
</mrtdstv6-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
match ipv6 address SampleString_123
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 |
rtmapMatchRtDstV6 | sys/rpm/rtmap-[Map_1]/ent-10/mrtdstv6 |
rtmapRsRtDstV6AccAtt | sys/rpm/rtmap-[Map_1]/ent-10/mrtdstv6/rsrtDstV6AccAtt-[sys/rpm/accesslist-[SampleString_123]] |
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] |
rtmapRsRtDstV6AccAtt Properties
The following table contains information about the rtmapRsRtDstV6AccAtt 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Match Address of Route or Match packet
Deleting Match Address of Route or Match packet
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchRtDstV6": {
"children": [
{
"rtmapRsRtDstV6AccAtt": {
"attributes": {
"status": "deleted",
"tDn": "sys/rpm/accesslist-[SampleString_123]"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mrtdstv6-items>
<rsrtDstV6AccAtt-items>
<RsRtDstV6AccAtt-list nc:operation="delete">
<tDn>/System/rpm-items/accesslist-items/Rule-list[name='SampleString_123']</tDn>
</RsRtDstV6AccAtt-list>
</rsrtDstV6AccAtt-items>
</mrtdstv6-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
no match ipv6 address SampleString_123
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 |
rtmapMatchRtDstV6 | sys/rpm/rtmap-[Map_1]/ent-10/mrtdstv6 |
rtmapRsRtDstV6AccAtt | sys/rpm/rtmap-[Map_1]/ent-10/mrtdstv6/rsrtDstV6AccAtt-[sys/rpm/accesslist-[SampleString_123]] |
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] |
rtmapRsRtDstV6AccAtt Properties
The following table contains information about the rtmapRsRtDstV6AccAtt 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.
rtmapRsRtDstV6AccAtt Properties
The following table contains information about the rtmapRsRtDstV6AccAtt 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Match Entries of Mac Lists
Configuring Match Entries of Mac Lists
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchRtMacList": {
"children": [
{
"rtmapRsRtMacListAtt": {
"attributes": {
"tDn": "sys/rpm/maclist-[SampleString_123]"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mrtmaclist-items>
<rsrtMacListAtt-items>
<RsRtMacListAtt-list>
<tDn>/System/rpm-items/maclist-items/RuleMac-list[name='SampleString_123']</tDn>
</RsRtMacListAtt-list>
</rsrtMacListAtt-items>
</mrtmaclist-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
match mac-list SampleString_123
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 |
rtmapMatchRtMacList | sys/rpm/rtmap-[Map_1]/ent-10/mrtmaclist |
rtmapRsRtMacListAtt | sys/rpm/rtmap-[Map_1]/ent-10/mrtmaclist/rsrtMacListAtt-[sys/rpm/maclist-[SampleString_123]] |
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] |
rtmapRsRtMacListAtt Properties
The following table contains information about the rtmapRsRtMacListAtt 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 |
---|---|---|---|
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Match Entries of Mac Lists
Deleting Match Entries of Mac Lists
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapMatchRtMacList": {
"children": [
{
"rtmapRsRtMacListAtt": {
"attributes": {
"status": "deleted",
"tDn": "sys/rpm/maclist-[SampleString_123]"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<mrtmaclist-items>
<rsrtMacListAtt-items>
<RsRtMacListAtt-list nc:operation="delete">
<tDn>/System/rpm-items/maclist-items/RuleMac-list[name='SampleString_123']</tDn>
</RsRtMacListAtt-list>
</rsrtMacListAtt-items>
</mrtmaclist-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
no match mac-list SampleString_123
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 |
rtmapMatchRtMacList | sys/rpm/rtmap-[Map_1]/ent-10/mrtmaclist |
rtmapRsRtMacListAtt | sys/rpm/rtmap-[Map_1]/ent-10/mrtmaclist/rsrtMacListAtt-[sys/rpm/maclist-[SampleString_123]] |
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] |
rtmapRsRtMacListAtt Properties
The following table contains information about the rtmapRsRtMacListAtt 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 |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
tDn | reln:Dn reference:BinRef | The distinguished name of the target. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
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": {
"v4RedistUnchange": "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>
<v4RedistUnchange>enabled</v4RedistUnchange>
</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
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 Map_1
set ip 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
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] |
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 |
---|---|---|---|
v4RedistUnchange | rtmap:AdminSt (scalar:Enum8) | Set IPv4 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:
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:
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": {
"v4RedistUnchange": "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>
<v4RedistUnchange>disabled</v4RedistUnchange>
</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
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 Map_1
no set ip 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
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] |
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 |
---|---|---|---|
v4RedistUnchange | rtmap:AdminSt (scalar:Enum8) | Set IPv4 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:
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:
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
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 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
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] |
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 |
---|---|---|---|
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:
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:
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
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 Map_1
no 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
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] |
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 |
---|---|---|---|
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:
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:
Configuring Prepend to the AS-Path
Configuring Prepend to the AS-Path
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetPrepend": {
"attributes": {
"as": "123 "
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathprepend-items>
<as>123 </as>
</setaspathprepend-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
set as-path prepend 123
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 |
rtmapSetPrepend | sys/rpm/rtmap-[Map_1]/ent-10/setaspathprepend |
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] |
rtmapSetPrepend Properties
The following table contains information about the rtmapSetPrepend 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 |
---|---|---|---|
as | string:Basic | As Path Prepend | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Prepend to the AS-Path
Deleting Prepend to the AS-Path
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetPrepend": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathprepend-items nc:operation="delete">
</setaspathprepend-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
no set as-path prepend 123
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 |
rtmapSetPrepend | sys/rpm/rtmap-[Map_1]/ent-10/setaspathprepend |
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] |
rtmapSetPrepend Properties
The following table contains information about the rtmapSetPrepend 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 |
---|---|---|---|
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:
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:
Configuring Prepend Last AS to the AS-Path
Configuring Prepend Last AS to the AS-Path
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetPrependLastAs": {
"attributes": {
"lastas": "4"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathlastas-items>
<lastas>4</lastas>
</setaspathlastas-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
set as-path prepend last-as 4
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 |
rtmapSetPrependLastAs | sys/rpm/rtmap-[Map_1]/ent-10/setaspathlastas |
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] |
rtmapSetPrependLastAs Properties
The following table contains information about the rtmapSetPrependLastAs 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 |
---|---|---|---|
lastas | rtmap:RouteLastAs (scalar:Uint16) | LastAs | RANGE: [1 , 10] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Prepend Last AS to the AS-Path
Deleting Prepend Last AS to the AS-Path
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetPrependLastAs": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathlastas-items nc:operation="delete">
</setaspathlastas-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
no set as-path prepend last-as 4
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 |
rtmapSetPrependLastAs | sys/rpm/rtmap-[Map_1]/ent-10/setaspathlastas |
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] |
rtmapSetPrependLastAs Properties
The following table contains information about the rtmapSetPrependLastAs 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 |
---|---|---|---|
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:
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:
Configuring the Tag as an AS-Path Attribute
Configuring the Tag as an AS-Path Attribute
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetAsPathTag": {
"attributes": {
"tag": "enabled"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathtag-items>
<tag>enabled</tag>
</setaspathtag-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
set as-path tag
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 |
rtmapSetAsPathTag | sys/rpm/rtmap-[Map_1]/ent-10/setaspathtag |
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] |
rtmapSetAsPathTag Properties
The following table contains information about the rtmapSetAsPathTag 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 |
---|---|---|---|
tag | rtmap:AdminSt (scalar:Enum8) | Set as path tag | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Tag as an AS-Path Attribute
Deleting the Tag as an AS-Path Attribute
POST http://<mgmt0_IP>/api/mo/sys/rpm.json
{
"rpmEntity": {
"children": [
{
"rtmapRule": {
"attributes": {
"name": "Map_1"
},
"children": [
{
"rtmapEntry": {
"attributes": {
"action": "permit",
"order": "10"
},
"children": [
{
"rtmapSetAsPathTag": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<rpm-items>
<rtmap-items>
<Rule-list>
<name>Map_1</name>
<ent-items>
<Entry-list>
<order>10</order>
<action>permit</action>
<setaspathtag-items nc:operation="delete">
</setaspathtag-items>
</Entry-list>
</ent-items>
</Rule-list>
</rtmap-items>
</rpm-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
route-map Map_1
no set as-path tag
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 |
rtmapSetAsPathTag | sys/rpm/rtmap-[Map_1]/ent-10/setaspathtag |
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] |
rtmapSetAsPathTag Properties
The following table contains information about the rtmapSetAsPathTag 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 |
---|---|---|---|
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:
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: