Configuring MGMT Interfaces
You can use the management Ethernet interface to connect the device to a network for remote management using a Telnet client, the Simple Network Management Protocol (SNMP), or other management agents. The management port (mgmt0) is autosensing and operates in full-duplex mode at a speed of 10/100/1000 Mb/s.
For more information, see the Cisco Nexus 9000 Series NX-OS Interfaces Configuration Guide. https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/
Configuring a Description
Configuring a Description
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mgmtMgmtIf": {
"attributes": {
"descr": "SampleString_123",
"id": "mgmt0"
}}}]}}
{
imdata:[]
}
<System>
<mgmt-items>
<MgmtIf-list>
<id>mgmt0</id>
<descr>SampleString_123</descr>
</MgmtIf-list>
</mgmt-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface mgmt 0-0
description SampleString_123
Note: The property information for this example was added in Release 9.3(3).
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 |
mgmtMgmtIf | sys/mgmt-{[id]} |
mgmtMgmtIf Properties
The following table contains information about the mgmtMgmtIf 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 |
---|---|---|---|
descr | naming:Descr1024 (string:Basic) | descr | MAX SIZE: 254 |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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 a Description
Deleting a Description
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mgmtMgmtIf": {
"attributes": {
"descr": "",
"id": "mgmt0"
}}}]}}
{
imdata:[]
}
<System>
<mgmt-items>
<MgmtIf-list>
<id>mgmt0</id>
<descr></descr>
</MgmtIf-list>
</mgmt-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface mgmt 0-0
no description SampleString_123
Note: The property information for this example was added in Release 9.3(3).
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 |
mgmtMgmtIf | sys/mgmt-{[id]} |
mgmtMgmtIf Properties
The following table contains information about the mgmtMgmtIf 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 |
---|---|---|---|
descr | naming:Descr1024 (string:Basic) | descr | MAX SIZE: 254 |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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 IPv6 Stateless Address Autoconfig (For SLAAC)
Configuring IPv6 Stateless Address Autoconfig (For SLAAC)
POST http://<mgmt0_IP>/api/mo/sys/ipv6/inst.json
{
"ipv6Inst": {
"children": [
{
"ipv6Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ipv6If": {
"attributes": {
"autoconfig": "enabled",
"defaultRoute": "enabled",
"id": "mgmt0",
"useLinkLocalAddr": "disabled"
}}}]}}]}}
{
imdata:[]
}
<System>
<ipv6-items>
<inst-items>
<dom-items>
<Dom-list>
<name>default</name>
<if-items>
<If-list>
<id>mgmt0</id>
<autoconfig>enabled</autoconfig>
<defaultRoute>enabled</defaultRoute>
<useLinkLocalAddr>disabled</useLinkLocalAddr>
</If-list>
</if-items>
</Dom-list>
</dom-items>
</inst-items>
</ipv6-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface mgmt 0-0
ipv6 address autoconfig default
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 |
---|---|
ipv6Inst | sys/ipv6/inst |
ipv6Dom | sys/ipv6/inst/dom-default |
ipv6If | sys/ipv6/inst/dom-default/if-[mgmt0] |
ipv6Dom Properties
The following table contains information about the ipv6Dom 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. | RANGE: Min: "1" Max: "128" |
ipv6If Properties
The following table contains information about the ipv6If 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 |
---|---|---|---|
autoconfig | nw:AdminSt (scalar:Enum8) | IPv6 Stateless address autoconfig | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
defaultRoute | nw:AdminSt (scalar:Enum8) | Default Route Addition with Nexthop as RA Source Address | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
useLinkLocalAddr | nw:AdminSt (scalar:Enum8) | IPv6 Address Use Link Local Address | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
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 IPv6 Stateless Address Autoconfig (For SLAAC)
Deleting IPv6 Stateless Address Autoconfig (For SLAAC)
POST http://<mgmt0_IP>/api/mo/sys/ipv6/inst.json
{
"ipv6Inst": {
"children": [
{
"ipv6Dom": {
"attributes": {
"name": "default"
},
"children": [
{
"ipv6If": {
"attributes": {
"autoconfig": "disabled",
"id": "mgmt0",
"useLinkLocalAddr": "disabled"
}}}]}}]}}
{
imdata:[]
}
<System>
<ipv6-items>
<inst-items>
<dom-items>
<Dom-list>
<name>default</name>
<if-items>
<If-list>
<id>mgmt0</id>
<autoconfig>disabled</autoconfig>
<useLinkLocalAddr>disabled</useLinkLocalAddr>
</If-list>
</if-items>
</Dom-list>
</dom-items>
</inst-items>
</ipv6-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface mgmt 0-0
no ipv6 address autoconfig default
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 |
---|---|
ipv6Inst | sys/ipv6/inst |
ipv6Dom | sys/ipv6/inst/dom-default |
ipv6If | sys/ipv6/inst/dom-default/if-[mgmt0] |
ipv6Dom Properties
The following table contains information about the ipv6Dom 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. | RANGE: Min: "1" Max: "128" |
ipv6If Properties
The following table contains information about the ipv6If 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 |
---|---|---|---|
autoconfig | nw:AdminSt (scalar:Enum8) | IPv6 Stateless address autoconfig | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
useLinkLocalAddr | nw:AdminSt (scalar:Enum8) | IPv6 Address Use Link Local Address | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
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 MGMT Port as Auto
Configuring MGMT Port as Auto
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mgmtMgmtIf": {
"attributes": {
"id": "mgmt0",
"mediaType": "auto"
}}}]}}
{
imdata:[]
}
<System>
<mgmt-items>
<MgmtIf-list>
<id>mgmt0</id>
<mediaType>auto</mediaType>
</MgmtIf-list>
</mgmt-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.
interface mgmt 0
media-type auto
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 |
mgmtMgmtIf | sys/mgmt-[mgmt0] |
mgmtMgmtIf Properties
The following table contains information about the mgmtMgmtIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
mediaType | scalar:Enum8 | Configuring the interface media-type | DEFAULT: auto |
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 MGMT Port rj45
Configuring MGMT Port rj45
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mgmtMgmtIf": {
"attributes": {
"id": "mgmt0",
"mediaType": "rj45"
}}}]}}
{
imdata:[]
}
<System>
<mgmt-items>
<MgmtIf-list>
<id>mgmt0</id>
<mediaType>rj45</mediaType>
</MgmtIf-list>
</mgmt-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.
interface mgmt 0-0
media-type rj45
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 |
mgmtMgmtIf | sys/mgmt-[mgmt0] |
mgmtMgmtIf Properties
The following table contains information about the mgmtMgmtIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
mediaType | scalar:Enum8 | Configuring the interface media-type | DEFAULT: auto |
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 MGMT Port sfp
Configuring MGMT Port sfp
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mgmtMgmtIf": {
"attributes": {
"id": "mgmt0",
"mediaType": "sfp"
}}}]}}
{
imdata:[]
}
<System>
<mgmt-items>
<MgmtIf-list>
<id>mgmt0</id>
<mediaType>sfp</mediaType>
</MgmtIf-list>
</mgmt-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.
interface mgmt 0-0
media-type sfp
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 |
mgmtMgmtIf | sys/mgmt-[mgmt0] |
mgmtMgmtIf Properties
The following table contains information about the mgmtMgmtIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
mediaType | scalar:Enum8 | Configuring the interface media-type | DEFAULT: auto |
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: