Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Creating a VRF

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "l3Inst": {
          "attributes": {
            "name": "VRF_1"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <inst-items>
    <Inst-list>
      <name>VRF_1</name>
    </Inst-list>
  </inst-items>
</System>

Configuring VRFs

Cisco NX-OS supports multiple virtual routing and forwarding instances (VRFs). Each VRF contains a separate address space with unicast and multicast route tables for IPv4 and IPv6 and makes routing decisions independent of any other VRF.

For more information, see the Cisco Nexus 9000 Series NX-OS Unicast Routing Configuration Guide

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Creating a VRF

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 VRF_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
l3Inst	sys/inst-{name}

l3Inst Properties

The following table contains information about the l3Inst 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: 128

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting VRF

CLI Command

no vrf context VRF_1

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

MO	DN
topSystem	sys
l3Inst	sys/inst-{name}

l3Inst Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 128
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a VRF Description

Creates a description of the VRF.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

vrf context switchpool-default
description Default VRF for user L3 routing shutdown

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

MO	DN
topSystem	sys
l3Inst	sys/inst-{name}

l3Inst Properties

Property Name	Data Type	Description	Values
descr	string:Basic	Description	A sequence of characters
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 128

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Querying a Pattern to Match (VRF)

CLI Output
switch# show running \| section vrf limit-resource vrf minimum 2 maximum 4096 use-vrf test_vrf vrf context VRF_1 address-family ipv4 unicast route-target import 1:2 mvpn route-target export 1:2 export map map1 import map map1 export vrf default map map1 vrf context VRF_2 rd 1:2 address-family ipv4 unicast export map map1 export vrf default map map1 allow-vpn vrf context foo address-family ipv4 unicast export vrf default map map1 allow-vpn vrf context management ip route 0.0.0.0/0 172.27.122.1 vrf context switchpool-default vrf context test1 address-family ipv4 unicast route-target import 1:2 mvpn vrf context v1 address-family ipv4 unicast route-target import 1:2 mvpn vrf member management vrf VRF_2 router-id 3.6.9.12

CLI Output

 switch# show running | section vrf    
  limit-resource vrf minimum 2 maximum 4096    
   use-vrf test_vrf    
 vrf context VRF_1    
  address-family ipv4 unicast    
   route-target import 1:2 mvpn    
   route-target export 1:2    
   export map map1    
   import map map1    
   export vrf default map map1    
 vrf context VRF_2    
  rd 1:2    
  address-family ipv4 unicast    
   export map map1    
   export vrf default map map1 allow-vpn    
 vrf context foo    
  address-family ipv4 unicast    
   export vrf default map map1 allow-vpn    
 vrf context management    
  ip route 0.0.0.0/0 172.27.122.1    
 vrf context switchpool-default    
 vrf context test1    
  address-family ipv4 unicast    
   route-target import 1:2 mvpn    
 vrf context v1    
  address-family ipv4 unicast    
   route-target import 1:2 mvpn    
  vrf member management    
   vrf VRF_2    
   router-id 3.6.9.12

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

MO	DN
l3Inst	sys/inst-{name}
rtctrlDom	sys/inst-{name}/dom-{name}
l3RsVrfMbr	sys/inst-{name}/rsvrfMbr-{[tDn]}
rtctrlDomAf	sys/inst-{name}/dom-{name}/af-{[type]}
rtctrlAfCtrl	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}
rtctrlRttP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}
rtctrlRttEntry	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/ent-{[rtt]}
rtctrlMapP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/rtctrlmap
rtctrlDomDefMapP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/rtctrldefmap

l3Inst Properties

Property Name	Data Type	Description	Values
adminState	l3:VrfAdminState (scalar:Enum8)	vrf Admin State	SELECTION: 1 - shutdown 2 - admin-up DEFAULT: admin-up
ctrlrId	aggregate:ControllerID (scalar:Uint32)	Controller ID	RANGE: [0 , 16] DEFAULT: 0
descr	string:Basic	Description	A sequence of characters
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
encap	base:Encap	Encap for this Context	SELECTION: unknown, vlan-%d or vxlan-%d
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 128
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)

rtctrlDom Properties

The following table contains information about the rtctrlDom 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
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rd	base:Community	Route Distinguisher
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

l3RsVrfMbr Properties

The following table contains information about the l3RsVrfMbr 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
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
tDn	reln:Dn reference:BinRef	The distinguished name of the target.

rtctrlDomAf Properties

The following table contains information about the rtctrlDomAf 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
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
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

rtctrlAfCtrl Properties

The following table contains information about the rtctrlAfCtrl 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
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
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

rtctrlRttP Properties

The following table contains information about the rtctrlRttP 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
descr	naming:Descr string:Basic	The description of this configuration item.	RANGE: Min: "0" Max: "128"
name	pol:ObjName string:Basic	The name of the object.	RANGE: Min: "0" Max: "64"
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
type	rtctrl:RttPType (scalar:Enum8)	Type	SELECTION: 1 - import 2 - export DEFAULT: import

rtctrlRttEntry Properties

The following table contains information about the rtctrlRttEntry 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
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
rtt	base:Community	Route Target

rtctrlMapP Properties

The following table contains information about the rtctrlMapP 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
descr	pol:Descr	Description of the specified attribute
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
rtMap	string:Basic	Route Map	A sequence of characters

rtctrlDomDefMapP Properties

The following table contains information about the rtctrlDomDefMapP 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
allowVpn	scalar:Bool	Allow VPN to be considered for route leaking	SELECTION: true or false
descr	naming:Descr string:Basic	The description of this configuration item.	RANGE: Min: "0" Max: "128"
name	pol:ObjName string:Basic	The name of the object.	RANGE: Min: "0" Max: "64"
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
pfxLimit	scalar:Uint32	Default Vrf Prefix Limit	RANGE: [0 , 2147483647] DEFAULT: 0
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
rtMap	string:Basic	Route Map	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Querying VRF Information

Note: The CLI output only covers a subset of the model output.

CLI Output
switch# show vrf all VRF-Name VRF-ID State Reason VRF_1 3 Up -- VRF_2 4 Up -- default 1 Up -- foo 5 Up -- management 2 Up -- switchpool-default 6 Up -- test1 7 Up -- v1 8 Up --

CLI Output
switch(config)# show vrf interface Interface VRF-Name VRF-ID Site-of-Origin loopback0 default 1 -- loopback1 default 1 -- loopback2 default 1 -- Null0 default 1 -- Ethernet1/1 default 1 -- Ethernet1/2 default 1 -- Ethernet1/6 default 1 -- Ethernet1/7 default 1 -- mgmt0 management 2 --

CLI Output

switch(config)# show vrf interface

Interface VRF-Name VRF-ID Site-of-Origin
loopback0 default 1 --
loopback1 default 1 --
loopback2 default 1 --
Null0 default 1 --
Ethernet1/1 default 1 --
Ethernet1/2 default 1 --
Ethernet1/6 default 1 --
Ethernet1/7 default 1 --
mgmt0 management 2 --

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

MO	DN
l3Inst	sys/inst-{name}
rtctrlDom	sys/inst-{name}/dom-{name}
l3RsVrfMbr	sys/inst-{name}/rsvrfMbr-{[tDn]}
rtctrlDomAf	sys/inst-{name}/dom-{name}/af-{[type]}
rtctrlAfCtrl	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}
rtctrlRttP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}
rtctrlRttEntry	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/ent-{[rtt]}
rtctrlMapP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/rtctrlmap
rtctrlDomDefMapP	sys/inst-{name}/dom-{name}/af-{[type]}/ctrl-{[type]}/rttp-{type}/rtctrldefmap

l3Inst Properties

Property Name	Data Type	Description	Values
adminState	l3:VrfAdminState (scalar:Enum8)	vrf Admin State	SELECTION: 1 - shutdown 2 - admin-up DEFAULT: admin-up
bgpRd	l3:BgpRdBytes (base:Uint8Array)	bgp route distinguisher	ARRAY SIZE: 8
bgpRdDisp	string:Basic	BGP Route Distinguisher for Display	A sequence of characters
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
createTs	scalar:Date	vrf creation time	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
ctrlrId	aggregate:ControllerID (scalar:Uint32)	Controller ID	RANGE: [0 , 16] DEFAULT: 0
descr	string:Basic	Description	A sequence of characters
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
encap	base:Encap	Encap for this Context	SELECTION: unknown, vlan-%d or vxlan-%d
gsdbCtx	scalar:Uint32	gsdb context	RANGE: [0, 4294967295]
id	l3:VrfId (scalar:Uint16)	vrf id	RANGE: [0 , 65535] DEFAULT: 0
l3vmCfgFailedBmp	scalar:Bitmask64		SELECTION: -9223372036854775808ull - l3:InstmodTs_failed_flag 1024ull - l3:Instname_failed_flag 128ull - l3:Instscope_failed_flag 16ull - l3:InstmonPolDn_failed_flag 1ull - l3:InstadminState_failed_flag 2305843009213693952ull - l3:Instuid_failed_flag 256ull - l3:InstsecLbl_failed_flag 2ull - l3:InstctrlrId_failed_flag 32ull - l3:Instoui_failed_flag 4611686018427387904ull - l3:InstpersistentOnReload_failed_flag 4ull - l3:Instdescr_failed_flag 512ull - l3:InstvpnId_failed_flag 64ull - l3:InstresourceId_failed_flag 8ull - l3:Instencap_failed_flag DEFAULT: 0
l3vmCfgFailedTs	scalar:Uint64
l3vmCfgState	scalar:UByte
lastChgdTs	scalar:Date	last state change time	DATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
monPolDn	reference:BinRef	The monitoring policy for the Layer 3 instance object.
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 128
oldOperStQual	l3:VrfOperStateQual (scalar:Enum8)	old oper state reason	SELECTION: 1 - admin-down 2 - admin-down-pending 3 - delete-holddown 4 - delete-pending 5 - invalid 6 - create-pending DEFAULT: admin-down
operStQual	l3:VrfOperStateQual (scalar:Enum8)	oper state reason	SELECTION: 1 - admin-down 2 - admin-down-pending 3 - delete-holddown 4 - delete-pending 5 - invalid 6 - create-pending DEFAULT: admin-down
operState	l3:VrfOperState (scalar:Enum8)	The VRF operational state.	SELECTION: 1 - up 2 - down DEFAULT: down
oui	string:Basic	vrf oui	A sequence of characters
pending	scalar:Bool	pending operation status	SELECTION: true or false
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
prtclBmp	scalar:Uint32	protocols in a vrf	RANGE: [0, 4294967295]
resourceId	l3:VrfId (scalar:Uint16)	VRF ID	RANGE: [0 , 65535] DEFAULT: 0
scope	actrl:ScopeId (scalar:Uint32)	Scope of the context. It identifies the classId pool and all the epg/bd classIds belonging to this context needs to be allocated from this pool	RANGE: [1 , 0xffffff] DEFAULT: 1
secLbl	actrl:SecLbl (scalar:Uint16)	Security Label	RANGE: [1 , 0xfff]
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
uid	scalar:Uint16	A unique identifier for this object.
v4TibId	scalar:Uint32	ipv4 table id	RANGE: [0, 4294967295]
v4TibName	string:Basic	ipv4 table name	A sequence of characters
v4TibOldOperStQual	l3:VrfOperStateQual (scalar:Enum8)	ipv4 table old oper state reason	SELECTION: 1 - admin-down 2 - admin-down-pending 3 - delete-holddown 4 - delete-pending 5 - invalid 6 - create-pending DEFAULT: admin-down
v4TibOperStQual	l3:VrfOperStateQual (scalar:Enum8)	ipv4 table oper state reason	SELECTION: 1 - admin-down 2 - admin-down-pending 3 - delete-holddown 4 - delete-pending 5 - invalid 6 - create-pending DEFAULT: admin-down
v4TibOperState	l3:VrfOperState (scalar:Enum8)	ipv4 table operational state.	SELECTION: 1 - up 2 - down DEFAULT: down
v4TibPending	scalar:Bool	ipv4 table pending operation status	SELECTION: true or false
v4TibValid	scalar:Bool	ipv4 table valid	SELECTION: true or false
v6TibId	scalar:Uint32	ipv6 table id	RANGE: [0, 4294967295]
v6TibName	string:Basic	ipv6 table name	A sequence of characters
v6TibOldOperStQual	l3:VrfOperStateQual (scalar:Enum8)	ipv6 table old oper state reason	SELECTION: 1 - admin-down 2 - admin-down-pending 3 - delete-holddown 4 - delete-pending 5 - invalid 6 - create-pending DEFAULT: admin-down
v6TibOperStQual	l3:VrfOperStateQual (scalar:Enum8)	ipv6 table oper state reason	SELECTION: 1 - admin-down 2 - admin-down-pending 3 - delete-holddown 4 - delete-pending 5 - invalid 6 - create-pending DEFAULT: admin-down
v6TibOperState	l3:VrfOperState (scalar:Enum8)	ipv6 table Oper State	SELECTION: 1 - up 2 - down DEFAULT: down
v6TibPending	scalar:Bool	ipv6 table pending operation status	SELECTION: true or false
v6TibValid	scalar:Bool	ipv6 table valid	SELECTION: true or false
vpnId	string:Basic	vrf vpnId	A sequence of characters

rtctrlDom Properties

Property Name	Data Type	Description	Values
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63
operRd	base:Community	Operational Route Distinguisher
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rd	base:Community	Route Distinguisher
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
uid	scalar:Uint16	A unique identifier for this object.

l3RsVrfMbr Properties

Property Name	Data Type	Description	Values
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
forceResolve	scalar:Bool	Whether the relation should force pull the target.	SELECTION: true or false DEFAULT: false
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
parentSKey	naming:Name256 string:Basic	The secondary key of a relation source or target. This is used internally.	RANGE: Min: "0" Max: "256"
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rType	reln:ResolverType (scalar:Enum8)	Represents the type of resolver.	SELECTION: 1 - mo 2 - service 3 - local DEFAULT: mo
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
state	reln:State (scalar:Enum8)	Represents the state of the relationship.	SELECTION: 0 - unformed 1 - formed 2 - missing-target 4 - invalid-target DEFAULT: unformed
stateQual	reln:StateQual (scalar:Enum8)	Represents the state qualifier of the relationship.	SELECTION: 0 - none 1 - mismatch-target 2 - default-target DEFAULT: none
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
tCl	reln:ClassId scalar:Enum16	The class ID of the target object. This property is managed internally and should not be modified by the user.	SELECTION: 0 - unspecified 4 - connIf 5 - datetimeNtpSrcIf 13 - dhcpSourceIf 14 - dhcpSrcIf 15 - dhcpV6SourceIf 16 - dhcpV6SrcIf 17 - egressIf 18 - ingressIf 19 - ipSrcIf 20 - l1EthIf 26 - l3If 36 - pktOnPassiveIf 38 - rsactiveIf 39 - rtactiveIf 40 - rtlsNodeToIf 41 - srcIf 43 - vpcIf 44 - l3Inst 46 - rtregcomRule 47 - rtpfxRule 48 - rtmapMatchRtDst 396 - cnwAggrIf 401 - cnwPhysIf 2537 - lacpIf 2547 - arpIf 2557 - icmpv4If 2561 - mcpIf 2567 - stpIf 2637 - cdpIf 2641 - ndIf 2655 - ospfIf 2671 - icmpv6If 2687 - dhcpClientIf 2690 - dhcpRelayIf 2691 - dhcpPseudoIf 2692 - dhcpServerIf 2715 - igmpsnoopStRtrIf 2741 - lldpIf 2834 - isisIf 3372 - regressIf 3397 - l2InbandIf 3400 - l2ExtIf 3403 - l2BrIf 3560 - nwIf 3593 - ipv6If 3627 - l1PhysIf 3633 - mgmtMgmtIf 3659 - pcAggrIf 3677 - tunnelIf 3757 - sviIf 3761 - l3RtdIf 3767 - l3EncRtdIf 3784 - mgmtRtdMgmtIf 3787 - l3LbRtdIf 3794 - ipv4If 5751 - mldsnoopStRtrIf 5774 - bfdIf 5828 - ospfv3If 5854 - eigrpIf 6128 - hmmFwdIf 6371 - udldPhysIf 6464 - l1PhysIfExtended 6473 - pcAggrIfExtended 6477 - pcShadowAggrIfExtended 6478 - pcShadowAggrIf 6485 - vpcOrphanPort 6486 - vpcPeerLink 6508 - tunnelifIf 6655 - platformIf 6743 - dhcpDAIIf 6749 - dhcpIpsgIf 6752 - dhcpSnoopIf 6757 - hsrpIf 6762 - igmpExtIf 6763 - igmpIf 6801 - mplsIf 6886 - ospfInternalIf 6924 - pimIf 7003 - vrrpInterface 7011 - vrrpv3Interface 7126 - poePhysIf 7144 - isisInternalIf 7165 - sisfFhsIf 7190 - l2VfcIf 7432 - pim6If 7795 - srteIf 7810 - dhclientPhysIf 7812 - l3vmL3vmIf 7961 - pktmgrIf 7985 - sflowSflowFsDataSource 7999 - natIf 8053 - dot1xIf 8167 - igmpsnoopIntf 8201 - igmpMvrIf 8227 - mldIf 8289 - mplsldpIf 8440 - l1VethIf 8527 - mldsnoopIntf 8683 - mplsstripclMplsTA 8692 - tunnelencTunencIf DEFAULT: nwIf(3560)
tDn	reln:Dn reference:BinRef	The distinguished name of the target.
tSKey	nw:IfId base:IfIndex	An internal property that is used to maintain relationship between objects.
tType	reln:TargetType (scalar:Enum8)	The type of target.	SELECTION: 0 - name 1 - mo 2 - all DEFAULT: mo
uid	scalar:Uint16	A unique identifier for this object.

rtctrlDomAf Properties

Property Name	Data Type	Description	Values
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
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
uid	scalar:Uint16	A unique identifier for this object.

rtctrlAfCtrl Properties

Property Name	Data Type	Description	Values
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
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
uid	scalar:Uint16	A unique identifier for this object.

rtctrlRttP Properties

Property Name	Data Type	Description	Values
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
descr	naming:Descr string:Basic	The description of this configuration item.	RANGE: Min: "0" Max: "128"
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
name	pol:ObjName string:Basic	The name of the object.	RANGE: Min: "0" Max: "64"
operRttAuto	base:Community	Operational Route Target Import Auto Evpn
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
type	rtctrl:RttPType (scalar:Enum8)	Type	SELECTION: 1 - import 2 - export DEFAULT: import
uid	scalar:Uint16	A unique identifier for this object.

rtctrlRttEntry Properties

Property Name	Data Type	Description	Values
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
rtt	base:Community	Route Target
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
uid	scalar:Uint16	A unique identifier for this object.

rtctrlMapP Properties

Property Name	Data Type	Description	Values
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
descr	pol:Descr	Description of the specified attribute
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
rtMap	string:Basic	Route Map	A sequence of characters
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
uid	scalar:Uint16	A unique identifier for this object.

rtctrlDomDefMapP Properties

Property Name	Data Type	Description	Values
allowVpn	scalar:Bool	Allow VPN to be considered for route leaking	SELECTION: true or false
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
descr	naming:Descr string:Basic	The description of this configuration item.	RANGE: Min: "0" Max: "128"
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
name	pol:ObjName string:Basic	The name of the object.	RANGE: Min: "0" Max: "64"
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
pfxLimit	scalar:Uint32	Default Vrf Prefix Limit	RANGE: [0 , 2147483647] DEFAULT: 0
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
rtMap	string:Basic	Route Map	A sequence of characters
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
uid	scalar:Uint16	A unique identifier for this object.

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Shutdown

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.

vrf context VRF_1
shutdown

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
l3Inst	sys/inst-VRF_1

l3Inst Properties

Property Name	Data Type	Description	Values
adminState	l3:VrfAdminState (scalar:Enum8)	vrf Admin State	SELECTION: 1 - shutdown 2 - admin-up DEFAULT: admin-up
name	naming:Name256 string:Basic	The Layer 3 instance name.	RANGE: Min: "1" Max: "128"

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Configured Shutdown

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

CLI Commands

vrf context VRF_1
no shutdown

Verifying a DME Configuration

MO	DN
l3Inst	sys/inst-VRF_1

l3Inst Properties

Property Name	Data Type	Description	Values
adminState	l3:VrfAdminState (scalar:Enum8)	vrf Admin State	SELECTION: 1 - shutdown 2 - admin-up DEFAULT: admin-up
name	naming:Name256 string:Basic	The Layer 3 instance name.	RANGE: Min: "1" Max: "128"

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html