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

Configuring OSPFv3 Dead Interval

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ospfv3Entity": {
          "children": [
            {
              "ospfv3Inst": {
                "attributes": {
                  "name": "Test_1"
                },
                "children": [
                  {
                    "ospfv3Dom": {
                      "attributes": {
                        "name": "VRF_1"
                      },
                      "children": [
                        {
                          "ospfv3Area": {
                            "attributes": {
                              "id": "0.0.0.10"
                            },
                            "children": [
                              {
                                "ospfv3Vlink": {
                                  "attributes": {
                                    "deadIntvl": "63120",
                                    "nbrRtrId": "10.1.2.3"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "ospfv3Dom": {
                      "attributes": {
                        "name": "default"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <ospfv3-items>
    <inst-items>
      <Inst-list>
        <name>Test_1</name>
        <dom-items>
          <Dom-list>
            <name>VRF_1</name>
            <area-items>
              <Area-list>
                <id>0.0.0.10</id>
                <vlink-items>
                  <Vlink-list>
                    <nbrRtrId>10.1.2.3</nbrRtrId>
                    <deadIntvl>63120</deadIntvl>
                  </Vlink-list>
                </vlink-items>
              </Area-list>
            </area-items>
          </Dom-list>
          <Dom-list>
            <name>default</name>
          </Dom-list>
        </dom-items>
      </Inst-list>
    </inst-items>
  </ospfv3-items>
</System>

Configuring a Virtual Link Under a VRF for an OSPFv3 Instance

Configuring OSPFv3 Dead Interval

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.

router ospfv3 Test_1
  vrf VRF_1
   area 0.0.0.10 virtual-link 10.1.2.3
    dead-interval 63120

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
ospfv3Entity	sys/ospfv3
ospfv3Inst	sys/ospfv3/inst-Test_1
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-VRF_1
ospfv3Area	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10
ospfv3Vlink	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10/vlink-10.1.2.3
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-default

ospfv3Inst Properties

The following table contains information about the ospfv3Inst 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

ospfv3Dom Properties

The following table contains information about the ospfv3Dom 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

ospfv3Area Properties

The following table contains information about the ospfv3Area 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	ospfv3:AreaId (string:Basic)	Area Id as an integer or ip address	A sequence of characters

ospfv3Vlink Properties

The following table contains information about the ospfv3Vlink 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
deadIntvl	ospfv3:DeadIntvl (scalar:Uint32)	Dead interval, interval during which at least one hello packet must be received from a neighbor before the router declares that neighbor as down	RANGE: [0 , 65535] DEFAULT: unspecified
nbrRtrId	ip:RtrId (address:IPv4)	Router id associated with virtual link neighbor	Value must match ipv4 format

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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

Unconfiguring OSPFv3 Dead Interval

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

CLI Commands

router ospfv3 Test_1
  vrf VRF_1
   area 0.0.0.10 virtual-link 10.1.2.3
    no dead-interval 63120

Verifying a DME Configuration

MO	DN
topSystem	sys
ospfv3Entity	sys/ospfv3
ospfv3Inst	sys/ospfv3/inst-Test_1
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-VRF_1
ospfv3Area	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10
ospfv3Vlink	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10/vlink-10.1.2.3
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-default

ospfv3Inst Properties

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

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

ospfv3Area Properties

Property Name	Data Type	Description	Values
id	ospfv3:AreaId (string:Basic)	Area Id as an integer or ip address	A sequence of characters

ospfv3Vlink Properties

Property Name	Data Type	Description	Values
deadIntvl	ospfv3:DeadIntvl (scalar:Uint32)	Dead interval, interval during which at least one hello packet must be received from a neighbor before the router declares that neighbor as down	RANGE: [0 , 65535] DEFAULT: unspecified
nbrRtrId	ip:RtrId (address:IPv4)	Router id associated with virtual link neighbor	Value must match ipv4 format

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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 OSPFv3 Hello Interval

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

CLI Commands

router ospfv3 Test_1
  vrf VRF_1
   area 0.0.0.10 virtual-link 10.1.2.3
    hello-interval 11349

Verifying a DME Configuration

MO	DN
topSystem	sys
ospfv3Entity	sys/ospfv3
ospfv3Inst	sys/ospfv3/inst-Test_1
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-VRF_1
ospfv3Area	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10
ospfv3Vlink	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10/vlink-10.1.2.3
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-default

ospfv3Inst Properties

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

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

ospfv3Area Properties

Property Name	Data Type	Description	Values
id	ospfv3:AreaId (string:Basic)	Area Id as an integer or ip address	A sequence of characters

ospfv3Vlink Properties

Property Name	Data Type	Description	Values
helloIntvl	ospfv3:HelloIntvl (scalar:Uint16)	Interval between hello packets that OSPFv3 sends on the interface	RANGE: [1 , 65535] DEFAULT: 10
nbrRtrId	ip:RtrId (address:IPv4)	Router id associated with virtual link neighbor	Value must match ipv4 format

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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

Unconfiguring OSPFv3 Hello Interval

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

CLI Commands

router ospfv3 Test_1
  vrf VRF_1
   area 0.0.0.10 virtual-link 10.1.2.3
    no hello-interval 11349

Verifying a DME Configuration

MO	DN
topSystem	sys
ospfv3Entity	sys/ospfv3
ospfv3Inst	sys/ospfv3/inst-Test_1
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-VRF_1
ospfv3Area	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10
ospfv3Vlink	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10/vlink-10.1.2.3
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-default

ospfv3Inst Properties

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

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

ospfv3Area Properties

Property Name	Data Type	Description	Values
id	ospfv3:AreaId (string:Basic)	Area Id as an integer or ip address	A sequence of characters

ospfv3Vlink Properties

Property Name	Data Type	Description	Values
helloIntvl	ospfv3:HelloIntvl (scalar:Uint16)	Interval between hello packets that OSPFv3 sends on the interface	RANGE: [1 , 65535] DEFAULT: 10
nbrRtrId	ip:RtrId (address:IPv4)	Router id associated with virtual link neighbor	Value must match ipv4 format

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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 OSPFv3 Retransmit Interval

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

CLI Commands

router ospfv3 Test_1
  vrf VRF_1
   area 0.0.0.10 virtual-link 10.1.2.3
    retransmit-interval 65482

Verifying a DME Configuration

MO	DN
topSystem	sys
ospfv3Entity	sys/ospfv3
ospfv3Inst	sys/ospfv3/inst-Test_1
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-VRF_1
ospfv3Area	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10
ospfv3Vlink	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10/vlink-10.1.2.3
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-default

ospfv3Inst Properties

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

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

ospfv3Area Properties

Property Name	Data Type	Description	Values
id	ospfv3:AreaId (string:Basic)	Area Id as an integer or ip address	A sequence of characters

ospfv3Vlink Properties

Property Name	Data Type	Description	Values
nbrRtrId	ip:RtrId (address:IPv4)	Router id associated with virtual link neighbor	Value must match ipv4 format
reTxIntvl	ospfv3:ReTxIntvl (scalar:Uint16)	Retransmit interval, the time between LSA retransmissions	RANGE: [1 , 65535] DEFAULT: 5

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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

Unconfiguring OSPFv3 Retransmit Interval

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

CLI Commands

router ospfv3 Test_1
  vrf VRF_1
   area 0.0.0.10 virtual-link 10.1.2.3
    no retransmit-interval 65482

Verifying a DME Configuration

MO	DN
topSystem	sys
ospfv3Entity	sys/ospfv3
ospfv3Inst	sys/ospfv3/inst-Test_1
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-VRF_1
ospfv3Area	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10
ospfv3Vlink	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10/vlink-10.1.2.3
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-default

ospfv3Inst Properties

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

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

ospfv3Area Properties

Property Name	Data Type	Description	Values
id	ospfv3:AreaId (string:Basic)	Area Id as an integer or ip address	A sequence of characters

ospfv3Vlink Properties

Property Name	Data Type	Description	Values
nbrRtrId	ip:RtrId (address:IPv4)	Router id associated with virtual link neighbor	Value must match ipv4 format
reTxIntvl	ospfv3:ReTxIntvl (scalar:Uint16)	Retransmit interval, the time between LSA retransmissions	RANGE: [1 , 65535] DEFAULT: 5

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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

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

CLI Commands

router ospfv3 Test_1
  vrf VRF_1
   area 0.0.0.10 virtual-link 10.1.2.3
    transmit-delay 353

Verifying a DME Configuration

MO	DN
topSystem	sys
ospfv3Entity	sys/ospfv3
ospfv3Inst	sys/ospfv3/inst-Test_1
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-VRF_1
ospfv3Area	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10
ospfv3Vlink	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10/vlink-10.1.2.3
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-default

ospfv3Inst Properties

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

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

ospfv3Area Properties

Property Name	Data Type	Description	Values
id	ospfv3:AreaId (string:Basic)	Area Id as an integer or ip address	A sequence of characters

ospfv3Vlink Properties

Property Name	Data Type	Description	Values
nbrRtrId	ip:RtrId (address:IPv4)	Router id associated with virtual link neighbor	Value must match ipv4 format
txDelay	ospfv3:TxDelay (scalar:Uint16)	Transmit delay, estimated time needed to send an LSA update packet	RANGE: [1 , 450] DEFAULT: 1

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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

Unconfiguring OSPFv3 Packet Transmission Delay

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

CLI Commands

router ospfv3 Test_1
  vrf VRF_1
   area 0.0.0.10 virtual-link 10.1.2.3
    no transmit-delay 353

Verifying a DME Configuration

MO	DN
topSystem	sys
ospfv3Entity	sys/ospfv3
ospfv3Inst	sys/ospfv3/inst-Test_1
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-VRF_1
ospfv3Area	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10
ospfv3Vlink	sys/ospfv3/inst-Test_1/dom-VRF_1/area-0.0.0.10/vlink-10.1.2.3
ospfv3Dom	sys/ospfv3/inst-Test_1/dom-default

ospfv3Inst Properties

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

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

ospfv3Area Properties

Property Name	Data Type	Description	Values
id	ospfv3:AreaId (string:Basic)	Area Id as an integer or ip address	A sequence of characters

ospfv3Vlink Properties

Property Name	Data Type	Description	Values
nbrRtrId	ip:RtrId (address:IPv4)	Router id associated with virtual link neighbor	Value must match ipv4 format
txDelay	ospfv3:TxDelay (scalar:Uint16)	Transmit delay, estimated time needed to send an LSA update packet	RANGE: [1 , 450] DEFAULT: 1

ospfv3Dom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

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