Cisco Nexus 3000 and 9000 Series NX-API REST SDK and API, Release 7.x

NX-OS 7(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Enabling OSPFv2

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "fmEntity": {
          "children": [
            {
              "fmOspf": {
                "attributes": {
                  "adminSt": "enabled"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <fm-items>
      <adminSt>enabled</adminSt>
  </fm-items>
</System>

Configuring OSPFv2

This section contains payload examples to demonstrate how to use the NX-API REST API to configure OSPFv2 on the Cisco Nexus 3000 and 9000 Series switches.

Guidelines and Restrictions

OSPFv2 operational support is not available through NX-API in releases earlier than Cisco NX-OS 7.0(3)I5(1).
When configuring interface settings in a POST operation, you must always specify the desired area. If no area attribute is specified, the operation is applied to area 1.
If an interface is configured with area="0.0.0.0", the REST GET for the interface MO shows area="backbone".
Operational information objects (status and statistics) are maintained only for a single OSPF instance. When multiple OSPF instances exist, operational information is not supported.
When configuring or querying an OSPFv2 interface, do not use the ospfInternalIf managed object. Use ospfIf instead.

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

Enabling OSPFv2

Note: This example was added in Release 7.0(3)I7(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.

feature ospf

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling OSPFv2

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

CLI Commands

no feature ospf

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/

Configuring Optional Parameters on an OSPFv2 Instance

You can configure optional parameters for OSPF.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

router ospf my_ospf
router-id 192.0.20.1
distance 25
log-adjacency-changes
maximum-paths 4
passive-interface default
name-lookup

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/

Configuring Networks in OSPFv2

You can configure a network to OSPFv2 by associating it through the interface that the router uses to connect to that network. You can add all networks to the default backbone area (Area 0), or you can create new areas using any decimal number or an IP address.

Prerequisite: The interface eth1/9 is already configured.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

interface eth1/9
ip address 192.0.20.1/16
ip router ospf 201 area 0.0.0.15 secondaries none
ip ospf cost 25
ip ospf dead-interval 50
ip ospf hello-interval 25
ip ospf mtu-ignore
ip ospf passive-interface
ip ospf priority 25
no ip ospf shutdown

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/

Configuring a Virtual Link

A virtual link connects an isolated area to the backbone area through an intermediate area.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

router ospf my_ospf
area 0.0.0.10 virtual-link 10.1.2.3
dead-interval 50
hello-interval 25
retransmit-interval 60
transmit-delay 2
authentication message-digest
message-digest-key 3 md5 asdflkj1234

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/