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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the OSPFv3 Instance Id

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
  "ospfv3Entity": {
    "children": [
      {
        "ospfv3If": {
          "attributes": {
            "id": "mgmt0",
            "instanceId": "1"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <ospfv3-items>
    <if-items>
      <If-list>
        <id>mgmt0</id>
        <instanceId>1</instanceId>
      </If-list>
    </if-items>
  </ospfv3-items>
</System>

Configuring OSPFv3 on a MGMT Interface

Configuring the OSPFv3 Instance Id

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.

interface mgmt 0-0
ospfv3 instance 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
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

The following table contains information about the ospfv3If 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)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
instanceId	ospfv3:InstanceID (scalar:UByte)	OSPFv3 instance identifier under interface	RANGE: [0 , 255] DEFAULT: 0

Related Documentation

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

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

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

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

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

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

Deleting the OSPFv3 Instance Id

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

CLI Commands

interface mgmt 0-0
no ospfv3 instance 1

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
instanceId	ospfv3:InstanceID (scalar:UByte)	OSPFv3 instance identifier under interface	RANGE: [0 , 255] DEFAULT: 0

Related Documentation

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

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

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

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

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

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

Configuring to Disable OSPF MTU Mismatch Detection

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

CLI Commands

interface mgmt 0-0
ospfv3 mtu-ignore

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
mtuIgnore	scalar:Bool	Disable OSPF MTU mismatch detection	SELECTION: true or false

Related Documentation

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

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

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

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

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

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

Deleting to Disable OSPF MTU Mismatch Detection

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

CLI Commands

interface mgmt 0-0
no ospfv3 mtu-ignore

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
mtuIgnore	scalar:Bool	Disable OSPF MTU mismatch detection	SELECTION: true or false

Related Documentation

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

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

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

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

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

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

Configuring Routing Update Supression on the Interface

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

CLI Commands

interface mgmt 0-0
ospfv3 passive-interface

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
passive	ospfv3:PassiveControl (scalar:Enum8)	Suppress routing updates on the interface	SELECTION: 0 - none 1 - enabled 2 - disabled DEFAULT: none

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 Routing Update Supression on the Interface

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

CLI Commands

interface mgmt 0-0
no ospfv3 passive-interface

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
passive	ospfv3:PassiveControl (scalar:Enum8)	Suppress routing updates on the interface	SELECTION: 0 - none 1 - enabled 2 - disabled DEFAULT: none

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 OSPF Shutdown on this Interface

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

CLI Commands

interface mgmt 0-0
ospfv3 shutdown

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
adminSt	nw:IfAdminSt scalar:Enum8	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled(1)
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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

Deleting OSPF Shutdown on this Interface

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

CLI Commands

interface mgmt 0-0
no ospfv3 shutdown

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
adminSt	nw:IfAdminSt scalar:Enum8	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled(1)
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

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

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

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

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

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

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

Configuring to Not Include Secondary IPv6 Addresses

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

CLI Commands

interface mgmt 0-0
ipv6 router ospfv3 SampleString_123 area 1 secondaries none

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
advSecondary	scalar:Bool	Advertise secondary IPv6 addresses	SELECTION: true or false DEFAULT: true
area	ospfv3:AreaId (string:Basic)	Area associated with interface	A sequence of characters
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
instance	ospfv3:InstanceName (naming:Name)	OSPFv3 instance name used with area command	MAX SIZE: 20

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 to Not Include Secondary IPv6 Addresses

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

CLI Commands

interface mgmt 0-0
no ipv6 router ospfv3 SampleString_123 area 1 secondaries none

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
advSecondary	scalar:Bool	Advertise secondary IPv6 addresses	SELECTION: true or false DEFAULT: true
area	ospfv3:AreaId (string:Basic)	Area associated with interface	A sequence of characters
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
instance	ospfv3:InstanceName (naming:Name)	OSPFv3 instance name used with area command	MAX SIZE: 20

Related Documentation

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

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

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

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

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

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

Configuring to Not Include Secondary IPv6 Addresses

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

CLI Commands

interface mgmt 0-0
ipv6 router ospfv3 SampleString_123 area 1.2.3.4 secondaries none

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
advSecondary	scalar:Bool	Advertise secondary IPv6 addresses	SELECTION: true or false DEFAULT: true
area	ospfv3:AreaId (string:Basic)	Area associated with interface	A sequence of characters
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
instance	ospfv3:InstanceName (naming:Name)	OSPFv3 instance name used with area command	MAX SIZE: 20

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 to Not Include Secondary IPv6 Addresses

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

CLI Commands

interface mgmt 0-0
no ipv6 router ospfv3 SampleString_123 area 1.2.3.4 secondaries none

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
advSecondary	scalar:Bool	Advertise secondary IPv6 addresses	SELECTION: true or false DEFAULT: true
area	ospfv3:AreaId (string:Basic)	Area associated with interface	A sequence of characters
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
instance	ospfv3:InstanceName (naming:Name)	OSPFv3 instance name used with area command	MAX SIZE: 20

Related Documentation

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

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

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

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

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

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

Configuring the OSPFv3 Router Priority

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

CLI Commands

interface mgmt 0-0
ospfv3 priority 3

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
prio	ospfv3:DesigPrio (scalar:UByte)	Router priority, used in determining the designated router on this network	RANGE: [0 , 255] DEFAULT: 1

Related Documentation

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

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

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

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

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

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

Deleting the OSPFv3 Router Priority

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

CLI Commands

interface mgmt 0-0
no ospfv3 priority 3

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
prio	ospfv3:DesigPrio (scalar:UByte)	Router priority, used in determining the designated router on this network	RANGE: [0 , 255] DEFAULT: 1

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 Packet Transmission Delay

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

CLI Commands

interface mgmt 0-0
no ospfv3 transmit-delay 383

Verifying a DME Configuration

MO	DN
ospfv3Entity	sys/ospfv3
ospfv3If	sys/ospfv3/if-[mgmt0]

ospfv3If Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
txDelay	ospfv3:TxDelay (scalar:Uint16)	Transmit delay, estimated time needed to send an LSA update packet	RANGE: [1 , 450] DEFAULT: 1

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