Configuring a Virtual Link Under an OSPFv3 Instance
Configuring OSPFv3 Dead Interval
Configuring OSPFv3 Dead Interval
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "Test_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "0.0.0.10"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"deadIntvl": "61344",
"nbrRtrId": "10.1.2.3"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>Test_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>0.0.0.10</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.1.2.3</nbrRtrId>
<deadIntvl>61344</deadIntvl>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-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.
router ospfv3 Test_1
area 0.0.0.10 virtual-link 10.1.2.3
dead-interval 61344
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 |
| ospfv3Inst | sys/ospfv3/inst-Test_1 |
| ospfv3Dom | sys/ospfv3/inst-Test_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10 |
| ospfv3Vlink | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10/vlink-10.1.2.3 |
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 |
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:
Unconfiguring OSPFv3 Dead Interval
Unconfiguring OSPFv3 Dead Interval
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "Test_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "0.0.0.10"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"deadIntvl": "unspecified",
"nbrRtrId": "10.1.2.3"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>Test_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>0.0.0.10</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.1.2.3</nbrRtrId>
<deadIntvl>0</deadIntvl>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-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.
router ospfv3 Test_1
area 0.0.0.10 virtual-link 10.1.2.3
no dead-interval 61344
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 |
| ospfv3Inst | sys/ospfv3/inst-Test_1 |
| ospfv3Dom | sys/ospfv3/inst-Test_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10 |
| ospfv3Vlink | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10/vlink-10.1.2.3 |
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 |
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 OSPFv3 Hello Interval
Configuring OSPFv3 Hello Interval
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "Test_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "0.0.0.10"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"helloIntvl": "39897",
"nbrRtrId": "10.1.2.3"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>Test_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>0.0.0.10</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.1.2.3</nbrRtrId>
<helloIntvl>39897</helloIntvl>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-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.
router ospfv3 Test_1
area 0.0.0.10 virtual-link 10.1.2.3
hello-interval 39897
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 |
| ospfv3Inst | sys/ospfv3/inst-Test_1 |
| ospfv3Dom | sys/ospfv3/inst-Test_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10 |
| ospfv3Vlink | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10/vlink-10.1.2.3 |
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 |
|---|---|---|---|
| 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 |
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:
Unconfiguring OSPFv3 Hello Interval
Unconfiguring OSPFv3 Hello Interval
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "Test_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "0.0.0.10"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"helloIntvl": "10",
"nbrRtrId": "10.1.2.3"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>Test_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>0.0.0.10</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.1.2.3</nbrRtrId>
<helloIntvl>10</helloIntvl>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-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.
router ospfv3 Test_1
area 0.0.0.10 virtual-link 10.1.2.3
no hello-interval 39897
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 |
| ospfv3Inst | sys/ospfv3/inst-Test_1 |
| ospfv3Dom | sys/ospfv3/inst-Test_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10 |
| ospfv3Vlink | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10/vlink-10.1.2.3 |
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 |
|---|---|---|---|
| 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 |
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 OSPFv3 Retransmit Interval
Configuring OSPFv3 Retransmit Interval
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "Test_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "0.0.0.10"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"nbrRtrId": "10.1.2.3",
"reTxIntvl": "58591"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>Test_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>0.0.0.10</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.1.2.3</nbrRtrId>
<reTxIntvl>58591</reTxIntvl>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-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.
router ospfv3 Test_1
area 0.0.0.10 virtual-link 10.1.2.3
retransmit-interval 58591
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 |
| ospfv3Inst | sys/ospfv3/inst-Test_1 |
| ospfv3Dom | sys/ospfv3/inst-Test_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10 |
| ospfv3Vlink | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10/vlink-10.1.2.3 |
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 |
|---|---|---|---|
| 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 |
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:
Unconfiguring OSPFv3 Retransmit Interval
Unconfiguring OSPFv3 Retransmit Interval
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "Test_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "0.0.0.10"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"nbrRtrId": "10.1.2.3",
"reTxIntvl": "5"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>Test_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>0.0.0.10</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.1.2.3</nbrRtrId>
<reTxIntvl>5</reTxIntvl>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-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.
router ospfv3 Test_1
area 0.0.0.10 virtual-link 10.1.2.3
no retransmit-interval 58591
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 |
| ospfv3Inst | sys/ospfv3/inst-Test_1 |
| ospfv3Dom | sys/ospfv3/inst-Test_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10 |
| ospfv3Vlink | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10/vlink-10.1.2.3 |
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 |
|---|---|---|---|
| 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 |
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 OSPFv3 Packet Transmission Delay
Configuring OSPFv3 Packet Transmission Delay
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "Test_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "0.0.0.10"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"nbrRtrId": "10.1.2.3",
"txDelay": "207"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>Test_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>0.0.0.10</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.1.2.3</nbrRtrId>
<txDelay>207</txDelay>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-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.
router ospfv3 Test_1
area 0.0.0.10 virtual-link 10.1.2.3
transmit-delay 207
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 |
| ospfv3Inst | sys/ospfv3/inst-Test_1 |
| ospfv3Dom | sys/ospfv3/inst-Test_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10 |
| ospfv3Vlink | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10/vlink-10.1.2.3 |
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 |
|---|---|---|---|
| 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 |
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:
Unconfiguring OSPFv3 Packet Transmission Delay
Unconfiguring OSPFv3 Packet Transmission Delay
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "Test_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "0.0.0.10"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"nbrRtrId": "10.1.2.3",
"txDelay": "1"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>Test_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>0.0.0.10</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.1.2.3</nbrRtrId>
<txDelay>1</txDelay>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-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.
router ospfv3 Test_1
area 0.0.0.10 virtual-link 10.1.2.3
no transmit-delay 207
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 |
| ospfv3Inst | sys/ospfv3/inst-Test_1 |
| ospfv3Dom | sys/ospfv3/inst-Test_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10 |
| ospfv3Vlink | sys/ospfv3/inst-Test_1/dom-default/area-0.0.0.10/vlink-10.1.2.3 |
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 |
|---|---|---|---|
| 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 |
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:
Configure authentication ipsec spi spi_id md5 authentication key on a virtual link
Configure authentication ipsec spi spi_id md5 authentication key on a virtual link
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "TEST_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "3.3.3.3"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"nbrRtrId": "10.10.10.10"
},
"children": [
{
"ospfv3VlinkAuthNewP": {
"attributes": {
"authKey": "762bc328e3bdf23528634c34c4ee38d6e2113d0f74c1176d75968a592447ede0",
"authKeyEncrType": "3des",
"authType": "md5",
"spi": "4294967295"
}}}]}}]}}]}}]}}]}}
{
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>TEST_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>3.3.3.3</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.10.10.10</nbrRtrId>
<auth-items>
<authKey>762bc328e3bdf23528634c34c4ee38d6e2113d0f74c1176d75968a592447ede0</authKey>
<authKeyEncrType>3des</authKeyEncrType>
<authType>md5</authType>
<spi>4294967295</spi>
</auth-items>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-items>
</System>
Note: This example was added in Release 9.3(5).
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
area 3.3.3.3 virtual-link 10.10.10.10
authentication ipsec spi 4294967295 md5 3 762bc328e3bdf23528634c34c4ee38d6e2113d0f74c1176d75968a592447ede0
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 |
| ospfv3Inst | sys/ospfv3/inst-TEST_1 |
| ospfv3Dom | sys/ospfv3/inst-TEST_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3 |
| ospfv3Vlink | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3/vlink-10.10.10.10 |
| ospfv3VlinkAuthNewP | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3/vlink-10.10.10.10/auth |
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 |
|---|---|---|---|
| nbrRtrId | ip:RtrId (address:IPv4) | Router id associated with virtual link neighbor | Value must match ipv4 format |
ospfv3VlinkAuthNewP Properties
The following table contains information about the ospfv3VlinkAuthNewP 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 |
|---|---|---|---|
| authKey | ospfv3:AuthKey (string:Password) | Key used for authentication | |
| authKeyEncrType | ospfv3:AuthKeyEncrType (scalar:Enum8) | Authentication key encryption type which can be Cleartext, 3DES or CiscoType7 | SELECTION: 0 - cleartext 3 - 3des 7 - cisco-type-7 DEFAULT: cleartext |
| authType | ospfv3:AuthType (scalar:Enum8) | Authentication types which can be md5, sha1 or disable. | SELECTION: 0 - none 1 - md5 2 - sha1 3 - disable |
| spi | ospfv3:AuthSpi (scalar:Uint32) | Security Parameter Index | RANGE: [256 , 4294967295] |
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:
Delete authentication ipsec spi spi_id md5 authentication key on a virtual link
Delete authentication ipsec spi spi_id md5 authentication key on a virtual link
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "TEST_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "3.3.3.3"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"nbrRtrId": "10.10.10.10"
},
"children": [
{
"ospfv3VlinkAuthNewP": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}]}}]}}
{
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>TEST_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>3.3.3.3</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.10.10.10</nbrRtrId>
<auth-items nc:operation="delete">
</auth-items>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-items>
</System>
Note: This example was added in Release 9.3(5).
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
area 3.3.3.3 virtual-link 10.10.10.10
no authentication ipsec spi 4294967295 md5 3 762bc328e3bdf23528634c34c4ee38d6e2113d0f74c1176d75968a592447ede0
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 |
| ospfv3Inst | sys/ospfv3/inst-TEST_1 |
| ospfv3Dom | sys/ospfv3/inst-TEST_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3 |
| ospfv3Vlink | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3/vlink-10.10.10.10 |
| ospfv3VlinkAuthNewP | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3/vlink-10.10.10.10/auth |
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 |
|---|---|---|---|
| nbrRtrId | ip:RtrId (address:IPv4) | Router id associated with virtual link neighbor | Value must match ipv4 format |
ospfv3VlinkAuthNewP Properties
The following table contains information about the ospfv3VlinkAuthNewP 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:
Configure authentication ipsec spi spi_id sha1 authentication key on a virtual link
Configure authentication ipsec spi spi_id sha1 authentication key on a virtual link
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "TEST_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "3.3.3.3"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"nbrRtrId": "10.10.10.10"
},
"children": [
{
"ospfv3VlinkAuthNewP": {
"attributes": {
"authKey": "762bc328e3bdf23528634c34c4ee38d6e2113d0f74c1176de0d74f6a52d2265ad9f49aae9d7afc93",
"authKeyEncrType": "3des",
"authType": "sha1",
"spi": "4294967295"
}}}]}}]}}]}}]}}]}}
{
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>TEST_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>3.3.3.3</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.10.10.10</nbrRtrId>
<auth-items>
<authKey>762bc328e3bdf23528634c34c4ee38d6e2113d0f74c1176de0d74f6a52d2265ad9f49aae9d7afc93</authKey>
<authKeyEncrType>3des</authKeyEncrType>
<authType>sha1</authType>
<spi>4294967295</spi>
</auth-items>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-items>
</System>
Note: This example was added in Release 9.3(5).
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
area 3.3.3.3 virtual-link 10.10.10.10
authentication ipsec spi 4294967295 sha1 3 762bc328e3bdf23528634c34c4ee38d6e2113d0f74c1176de0d74f6a52d2265ad9f49aae9d7afc93
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 |
| ospfv3Inst | sys/ospfv3/inst-TEST_1 |
| ospfv3Dom | sys/ospfv3/inst-TEST_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3 |
| ospfv3Vlink | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3/vlink-10.10.10.10 |
| ospfv3VlinkAuthNewP | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3/vlink-10.10.10.10/auth |
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 |
|---|---|---|---|
| nbrRtrId | ip:RtrId (address:IPv4) | Router id associated with virtual link neighbor | Value must match ipv4 format |
ospfv3VlinkAuthNewP Properties
The following table contains information about the ospfv3VlinkAuthNewP 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 |
|---|---|---|---|
| authKey | ospfv3:AuthKey (string:Password) | Key used for authentication | |
| authKeyEncrType | ospfv3:AuthKeyEncrType (scalar:Enum8) | Authentication key encryption type which can be Cleartext, 3DES or CiscoType7 | SELECTION: 0 - cleartext 3 - 3des 7 - cisco-type-7 DEFAULT: cleartext |
| authType | ospfv3:AuthType (scalar:Enum8) | Authentication types which can be md5, sha1 or disable. | SELECTION: 0 - none 1 - md5 2 - sha1 3 - disable |
| spi | ospfv3:AuthSpi (scalar:Uint32) | Security Parameter Index | RANGE: [256 , 4294967295] |
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:
Delete authentication ipsec spi spi_id sha1 authentication key on a virtual link
Delete authentication ipsec spi spi_id sha1 authentication key on a virtual link
POST http://<mgmt0_IP>/api/mo/sys/ospfv3.json
{
"ospfv3Entity": {
"children": [
{
"ospfv3Inst": {
"attributes": {
"name": "TEST_1"
},
"children": [
{
"ospfv3Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ospfv3Area": {
"attributes": {
"id": "3.3.3.3"
},
"children": [
{
"ospfv3Vlink": {
"attributes": {
"nbrRtrId": "10.10.10.10"
},
"children": [
{
"ospfv3VlinkAuthNewP": {
"attributes": {
"status": "deleted"
}}}]}}]}}]}}]}}]}}
{
}
<System>
<ospfv3-items>
<inst-items>
<Inst-list>
<name>TEST_1</name>
<dom-items>
<Dom-list>
<name>default</name>
<area-items>
<Area-list>
<id>3.3.3.3</id>
<vlink-items>
<Vlink-list>
<nbrRtrId>10.10.10.10</nbrRtrId>
<auth-items nc:operation="delete">
</auth-items>
</Vlink-list>
</vlink-items>
</Area-list>
</area-items>
</Dom-list>
</dom-items>
</Inst-list>
</inst-items>
</ospfv3-items>
</System>
Note: This example was added in Release 9.3(5).
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
area 3.3.3.3 virtual-link 10.10.10.10
no authentication ipsec spi 10002 sha1 3 762bc328e3bdf23528634c34c4ee38d6e2113d0f74c1176de0d74f6a52d2265ad9f49aae9d7afc93
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 |
| ospfv3Inst | sys/ospfv3/inst-TEST_1 |
| ospfv3Dom | sys/ospfv3/inst-TEST_1/dom-default |
| ospfv3Area | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3 |
| ospfv3Vlink | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3/vlink-10.10.10.10 |
| ospfv3VlinkAuthNewP | sys/ospfv3/inst-TEST_1/dom-default/area-3.3.3.3/vlink-10.10.10.10/auth |
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 |
|---|---|---|---|
| nbrRtrId | ip:RtrId (address:IPv4) | Router id associated with virtual link neighbor | Value must match ipv4 format |
ospfv3VlinkAuthNewP Properties
The following table contains information about the ospfv3VlinkAuthNewP 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: