Configuring a Router ID
Configuring an LDP Router-Id (Ethernet)
Configuring an LDP Router-Id (Ethernet)
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mplsldpLDP": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"mplsldpRouterId": {
"attributes": {
"if": "eth1/2"
}}}]}}]}}
{
imdata:[]
}
<System>
<ldp-items>
<adminSt>enabled</adminSt>
<routerid-items>
<if>eth1/2</if>
</routerid-items>
</ldp-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.
mpls ldp configuration
router-id ethernet 1/2
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 |
mplsldpLDP | sys/ldp |
mplsldpRouterId | sys/ldp/routerid |
mplsldpLDP Properties
The following table contains information about the mplsldpLDP 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 |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | The administrative state of the object or policy. | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
mplsldpRouterId Properties
The following table contains information about the mplsldpRouterId 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 |
---|---|---|---|
if | nw:IfId (base:IfIndex) | Specifies the preferred interface for determining the LDP router ID, which is typically determined the next time that the interface is shut down or the address is deconfigured | 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:
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:
Deleting an LDP Router-Id (Ethernet)
Deleting an LDP Router-Id (Ethernet)
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mplsldpLDP": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"mplsldpRouterId": {
"attributes": {
"status": "deleted"
}}}]}}]}}
{
imdata:[]
}
<System>
<ldp-items>
<adminSt>enabled</adminSt>
<routerid-items nc:operation="delete">
</routerid-items>
</ldp-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.
mpls ldp configuration
no router-id ethernet 1/2
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 |
mplsldpLDP | sys/ldp |
mplsldpRouterId | sys/ldp/routerid |
mplsldpLDP Properties
The following table contains information about the mplsldpLDP 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 |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | The administrative state of the object or policy. | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
mplsldpRouterId Properties
The following table contains information about the mplsldpRouterId 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:
Configuring an LDP Router-Id (Port Channel)
Configuring an LDP Router-Id (Port Channel)
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mplsldpLDP": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"mplsldpRouterId": {
"attributes": {
"if": "po123"
}}}]}}]}}
{
imdata:[]
}
<System>
<ldp-items>
<adminSt>enabled</adminSt>
<routerid-items>
<if>po123</if>
</routerid-items>
</ldp-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.
mpls ldp configuration
router-id port-channel 123
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 |
mplsldpLDP | sys/ldp |
mplsldpRouterId | sys/ldp/routerid |
mplsldpLDP Properties
The following table contains information about the mplsldpLDP 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 |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | The administrative state of the object or policy. | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
mplsldpRouterId Properties
The following table contains information about the mplsldpRouterId 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 |
---|---|---|---|
if | nw:IfId (base:IfIndex) | Specifies the preferred interface for determining the LDP router ID, which is typically determined the next time that the interface is shut down or the address is deconfigured | 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:
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:
Deleting an LDP Router-Id (Port Channel)
Deleting an LDP Router-Id (Port Channel)
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mplsldpLDP": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"mplsldpRouterId": {
"attributes": {
"status": "deleted"
}}}]}}]}}
{
imdata:[]
}
<System>
<ldp-items>
<adminSt>enabled</adminSt>
<routerid-items nc:operation="delete">
</routerid-items>
</ldp-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.
mpls ldp configuration
no router-id port-channel 123
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 |
mplsldpLDP | sys/ldp |
mplsldpRouterId | sys/ldp/routerid |
mplsldpLDP Properties
The following table contains information about the mplsldpLDP 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 |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | The administrative state of the object or policy. | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
mplsldpRouterId Properties
The following table contains information about the mplsldpRouterId 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:
Configuring an LDP Router-Id (Loopback)
Configuring an LDP Router-Id (Loopback)
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mplsldpLDP": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"mplsldpRouterId": {
"attributes": {
"if": "lo123"
}}}]}}]}}
{
imdata:[]
}
<System>
<ldp-items>
<adminSt>enabled</adminSt>
<routerid-items>
<if>lo123</if>
</routerid-items>
</ldp-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.
mpls ldp configuration
router-id loopback 123
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 |
mplsldpLDP | sys/ldp |
mplsldpRouterId | sys/ldp/routerid |
mplsldpLDP Properties
The following table contains information about the mplsldpLDP 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 |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | The administrative state of the object or policy. | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
mplsldpRouterId Properties
The following table contains information about the mplsldpRouterId 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 |
---|---|---|---|
if | nw:IfId (base:IfIndex) | Specifies the preferred interface for determining the LDP router ID, which is typically determined the next time that the interface is shut down or the address is deconfigured | 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:
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:
Deleting an LDP Router-Id (Loopback)
Deleting an LDP Router-Id (Loopback)
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mplsldpLDP": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"mplsldpRouterId": {
"attributes": {
"status": "deleted"
}}}]}}]}}
{
imdata:[]
}
<System>
<ldp-items>
<adminSt>enabled</adminSt>
<routerid-items nc:operation="delete">
</routerid-items>
</ldp-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.
mpls ldp configuration
no router-id loopback 123
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 |
mplsldpLDP | sys/ldp |
mplsldpRouterId | sys/ldp/routerid |
mplsldpLDP Properties
The following table contains information about the mplsldpLDP 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 |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | The administrative state of the object or policy. | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
mplsldpRouterId Properties
The following table contains information about the mplsldpRouterId 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:
Configuring Forced Change of the LDP Router Id
Configuring Forced Change of the LDP Router Id
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mplsldpLDP": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"mplsldpRouterId": {
"attributes": {
"force": "yes",
"if": "eth1/1"
}}}]}}]}}
{
imdata:[]
}
<System>
<ldp-items>
<adminSt>enabled</adminSt>
<routerid-items>
<force>true</force>
<if>eth1/1</if>
</routerid-items>
</ldp-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.
mpls ldp configuration
router-id ethernet 1/1 force
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 |
mplsldpLDP | sys/ldp |
mplsldpRouterId | sys/ldp/routerid |
mplsldpLDP Properties
The following table contains information about the mplsldpLDP 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 |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | The administrative state of the object or policy. | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
mplsldpRouterId Properties
The following table contains information about the mplsldpRouterId 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 |
---|---|---|---|
force | scalar:Bool | LDP router id force keyword enables the router ID to take effect more quickly | SELECTION: true or false DEFAULT: false |
if | nw:IfId (base:IfIndex) | Specifies the preferred interface for determining the LDP router ID, which is typically determined the next time that the interface is shut down or the address is deconfigured | 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:
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:
Deleting Forced Change of the LDP Router Id
Deleting Forced Change of the LDP Router Id
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mplsldpLDP": {
"attributes": {
"adminSt": "enabled"
},
"children": [
{
"mplsldpRouterId": {
"attributes": {
"status": "deleted"
}}}]}}]}}
{
imdata:[]
}
<System>
<ldp-items>
<adminSt>enabled</adminSt>
<routerid-items nc:operation="delete">
</routerid-items>
</ldp-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.
mpls ldp configuration
no router-id ethernet 1/1 force
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 |
mplsldpLDP | sys/ldp |
mplsldpRouterId | sys/ldp/routerid |
mplsldpLDP Properties
The following table contains information about the mplsldpLDP 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 |
---|---|---|---|
adminSt | nw:AdminSt (scalar:Enum8) | The administrative state of the object or policy. | SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled |
mplsldpRouterId Properties
The following table contains information about the mplsldpRouterId 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: