Configuring Online Diagnostics

With online diagnostics, you can test and verify the hardware functionality of the device while the device is connected to a live network. The online diagnostics contain tests that check different hardware components and verify the data path and control signals. Disruptive online diagnostic tests (such as the disruptive loopback test) and nondisruptive online diagnostic tests (such as the ASIC register check) run during bootup, line module online insertion and removal (OIR), and system reset. The nondisruptive online diagnostic tests run as part of the background health monitoring, and you can run these tests on demand. Online diagnostics are categorized as bootup, runtime or health-monitoring diagnostics, and on-demand diagnostics. Bootup diagnostics run during bootup, health-monitoring tests run in the background, and on-demand diagnostics run once or at user-designated intervals when the device is connected to a live network.

For more information, see the Cisco Nexus 9000 Series NX-OS System Management Configuration Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Configuring a Diagnostic Monitoring Test

Configuring a Diagnostic Monitoring Test

POST http://<mgmt0_IP>/api/mo/sys/gold.json

{
  "goldEntity": {
    "children": [
      {
        "goldConfig": {
          "attributes": {
            "diagMonitorModuleAll": "enabled"
}}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <config-items>
      <diagMonitorModuleAll>enabled</diagMonitorModuleAll>
    </config-items>
  </gold-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.

diagnostic monitor module all


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.

MODN
goldEntity sys/gold
goldConfig sys/gold/config


goldConfig Properties

The following table contains information about the goldConfig 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 NameData TypeDescriptionValues
diagMonitorModuleAllgold:AdminSt
(scalar:Enum8)		Diagnostic Monitor Module All Diagnostic AllSELECTION:
0 - default
1 - enabled
2 - disabled
DEFAULT: default


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 a Diagnostic Monitoring Test

Unconfiguring a Diagnostic Monitoring Test

POST http://<mgmt0_IP>/api/mo/sys/gold.json

{
  "goldEntity": {
    "children": [
      {
        "goldConfig": {
          "attributes": {
            "diagMonitorModuleAll": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <config-items>
      <diagMonitorModuleAll>disabled</diagMonitorModuleAll>
    </config-items>
  </gold-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.

no diagnostic monitor module all


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.

MODN
goldEntity sys/gold
goldConfig sys/gold/config


goldConfig Properties

The following table contains information about the goldConfig 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 NameData TypeDescriptionValues
diagMonitorModuleAllgold:AdminSt
(scalar:Enum8)		Diagnostic Monitor Module All Diagnostic AllSELECTION:
0 - default
1 - enabled
2 - disabled
DEFAULT: default


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 the Skip All Bootup Test

Configuring the Skip All Bootup Test

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "goldEntity": {
          "attributes": {
            "diagBootLevel": "bypass"
}}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <diagBootLevel>bypass</diagBootLevel>
  </gold-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.

diagnostic bootup level bypass


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.

MODN
topSystem sys
goldEntity sys/gold


goldEntity Properties

The following table contains information about the goldEntity 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 NameData TypeDescriptionValues
diagBootLevelgold:bootLevel
(scalar:Enum8)		Module Diagnostic Bootup LevelSELECTION:
0 - bypass
1 - complete
2 - minimal
DEFAULT: complete


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 the Skip All Bootup Test

Unconfiguring the Skip All Bootup Test

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "goldEntity": {
          "attributes": {
            "diagBootLevel": "complete"
}}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <diagBootLevel>complete</diagBootLevel>
  </gold-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.

no diagnostic bootup level bypass


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.

MODN
topSystem sys
goldEntity sys/gold


goldEntity Properties

The following table contains information about the goldEntity 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 NameData TypeDescriptionValues
diagBootLevelgold:bootLevel
(scalar:Enum8)		Module Diagnostic Bootup LevelSELECTION:
0 - bypass
1 - complete
2 - minimal
DEFAULT: complete


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 the Complete Diagnostic Level

Configuring the Complete Diagnostic Level

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "goldEntity": {
          "attributes": {
            "diagBootLevel": "complete"
}}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <diagBootLevel>complete</diagBootLevel>
  </gold-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.

diagnostic bootup level complete


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.

MODN
topSystem sys
goldEntity sys/gold


goldEntity Properties

The following table contains information about the goldEntity 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 NameData TypeDescriptionValues
diagBootLevelgold:bootLevel
(scalar:Enum8)		Module Diagnostic Bootup LevelSELECTION:
0 - bypass
1 - complete
2 - minimal
DEFAULT: complete


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 the Complete Diagnostic Level

Unconfiguring the Complete Diagnostic Level

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "goldEntity": {
          "attributes": {
            "diagBootLevel": "complete"
}}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <diagBootLevel>complete</diagBootLevel>
  </gold-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.

no diagnostic bootup level complete


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.

MODN
topSystem sys
goldEntity sys/gold


goldEntity Properties

The following table contains information about the goldEntity 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 NameData TypeDescriptionValues
diagBootLevelgold:bootLevel
(scalar:Enum8)		Module Diagnostic Bootup LevelSELECTION:
0 - bypass
1 - complete
2 - minimal
DEFAULT: complete


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 the Minimal Diagnostic Level

Configuring the Minimal Diagnostic Level

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "goldEntity": {
          "attributes": {
            "diagBootLevel": "minimal"
}}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <diagBootLevel>minimal</diagBootLevel>
  </gold-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.

diagnostic bootup level minimal


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.

MODN
topSystem sys
goldEntity sys/gold


goldEntity Properties

The following table contains information about the goldEntity 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 NameData TypeDescriptionValues
diagBootLevelgold:bootLevel
(scalar:Enum8)		Module Diagnostic Bootup LevelSELECTION:
0 - bypass
1 - complete
2 - minimal
DEFAULT: complete


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 the Minimal Diagnostic Level

Unconfiguring the Minimal Diagnostic Level

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "goldEntity": {
          "attributes": {
            "diagBootLevel": "complete"
}}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <diagBootLevel>complete</diagBootLevel>
  </gold-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.

no diagnostic bootup level minimal


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.

MODN
topSystem sys
goldEntity sys/gold


goldEntity Properties

The following table contains information about the goldEntity 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 NameData TypeDescriptionValues
diagBootLevelgold:bootLevel
(scalar:Enum8)		Module Diagnostic Bootup LevelSELECTION:
0 - bypass
1 - complete
2 - minimal
DEFAULT: complete


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 a Diagnostic Test

Configuring a Diagnostic Test

POST http://<mgmt0_IP>/api/mo/sys/gold/config.json

{
  "goldConfig": {
    "children": [
      {
        "goldModuleConfig": {
          "attributes": {
            "modId": "1"
          },
          "children": [
            {
              "goldTestMonitor": {
                "attributes": {
                  "id": "1",
                  "monitorStatus": "enabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <config-items>
      <module-items>
        <ModuleConfig-list>
          <modId>1</modId>
          <test-items>
            <TestMonitor-list>
              <id>1</id>
              <monitorStatus>enabled</monitorStatus>
            </TestMonitor-list>
          </test-items>
        </ModuleConfig-list>
      </module-items>
    </config-items>
  </gold-items>
</System>

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

To determine the available tests, run show diagnostic content module 1; this displays the diagnostic test suite attribute and a table that lists the tests that you can run. The tests are identified by an ID number and by a name. The example payload on the right demonsrates a request to run a diagnostic test for USB (ID 1). Note that the test table below indicates that the testing interval is not applicable for USB.

CLI Output
Switch# show diagnostic content module 1
Diagnostics test suite attributes:
B/C/* - Bypass bootup level test / Complete bootup level test / NA
P/*   - Per port test / NA
M/S/* - Only applicable to active / standby unit / NA
D/N/* - Disruptive test / Non-disruptive test / NA
H/O/* - Always enabled monitoring test / Conditionally enabled test / NA
F/*   - Fixed monitoring interval test / NA
X/*   - Not a health monitoring test / NA
E/*   - Sup to line card test / NA
L/*   - Exclusively run this test / NA
T/*   - Not an ondemand test / NA
A/I/* - Monitoring is active / Monitoring is inactive / NA


Module 1: 72x40G Ethernet Module (Active)


                                                   Testing Interval



ID     Name                               Attributes      (hh:mm:ss)




    

  1. USB--------------------------->     CNX*T     -NA-
    2. 

  2. NVRAM------------------------->     N***A     00:05:00
    3. 

  3. RealTimeClock----------------->     N***A     00:05:00
    4. 

  4. PrimaryBootROM---------------->     N***A     24:00:00
    5. 

  5. SecondaryBootROM-------------->     N***A     24:00:00
    6. 

  6. BootFlash--------------------->     N***A     00:30:00
    7. 

  7. SystemMgmtBus----------------->     MN****A     00:00:30
    8. 

  8. OBFL-------------------------->     CN****A     00:30:00
    9. 

  9. ACT2-------------------------->     N***A     00:30:00
    10. 

  10. Console----------------------->     N***A     00:00:30
    11. 

  11. FpgaRegTest------------------->     N***A     00:00:30
    12. 

  12. Mce--------------------------->     N***A     01:00:00
    13. 

  13. ASICRegisterCheck------------->     N***A     00:00:20
    14. 

  14. AsicMemory-------------------->     CDX*T     -NA-
    15. 

  15. Pcie-------------------------->     CNX*T     -NA-
    16. 

  16. PortLoopback------------------>     PNXE*     -NA-
    17. 

  17. L2ACLRedirect----------------->     PN*EA     00:01:00
    18. 

  18. BootupPortLoopback------------>     CPN**XET*     -NA-
    19.


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.

diagnostic monitor module 1 test 1


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.

MODN
goldConfig sys/gold/config
goldModuleConfig sys/gold/config/module-1
goldTestMonitor sys/gold/config/module-1/test-1


goldTestMonitor Properties

The following table contains information about the goldTestMonitor 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 NameData TypeDescriptionValues
idgold:Id
(scalar:Uint32)		GOLD Health Monitoring Test IdRANGE: [0, 4294967295]
monitorStatusgold:AdminSt
(scalar:Enum8)		Health Monitor StatusSELECTION:
0 - default
1 - enabled
2 - disabled
DEFAULT: default


goldModuleConfig Properties

The following table contains information about the goldModuleConfig 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 NameData TypeDescriptionValues
modIdgold:Id
(scalar:Uint32)		GOLD helath monitoring Module IdRANGE: [0, 4294967295]


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 an USB Diagnostic Test

Unconfiguring an USB Diagnostic Test  

POST http://<mgmt0_IP>/api/mo/sys/gold/config.json

{
  "goldConfig": {
    "children": [
      {
        "goldModuleConfig": {
          "attributes": {
            "modId": "1"
          },
          "children": [
            {
              "goldTestMonitor": {
                "attributes": {
                  "id": "1",
                  "monitorStatus": "disabled"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <config-items>
      <module-items>
        <ModuleConfig-list>
          <modId>1</modId>
          <test-items>
            <TestMonitor-list>
              <id>1</id>
              <monitorStatus>disabled</monitorStatus>
            </TestMonitor-list>
          </test-items>
        </ModuleConfig-list>
      </module-items>
    </config-items>
  </gold-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.

no diagnostic monitor module 1 test 1


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.

MODN
goldConfig sys/gold/config
goldModuleConfig sys/gold/config/module-1
goldTestMonitor sys/gold/config/module-1/test-1


goldModuleConfig Properties

The following table contains information about the goldModuleConfig 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 NameData TypeDescriptionValues
modIdgold:Id
(scalar:Uint32)		GOLD helath monitoring Module IdRANGE: [0, 4294967295]


goldTestMonitor Properties

The following table contains information about the goldTestMonitor 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 NameData TypeDescriptionValues
idgold:Id
(scalar:Uint32)		GOLD Health Monitoring Test IdRANGE: [0, 4294967295]
monitorStatusgold:AdminSt
(scalar:Enum8)		Health Monitor StatusSELECTION:
0 - default
1 - enabled
2 - disabled
DEFAULT: default


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 the Hour, Minute, and Seconds for a Diagnostic Test

Configuring the Hour, Minute, and Seconds for a Diagnostic Test  

POST http://<mgmt0_IP>/api/mo/sys/gold/config.json

{
  "goldConfig": {
    "children": [
      {
        "goldModuleConfig": {
          "attributes": {
            "modId": "1"
          },
          "children": [
            {
              "goldTestMonitor": {
                "attributes": {
                  "id": "2",
                  "testInterval": "00:05:00"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <config-items>
      <module-items>
        <ModuleConfig-list>
          <modId>1</modId>
          <test-items>
            <TestMonitor-list>
              <id>2</id>
              <testInterval>00:05:00</testInterval>
            </TestMonitor-list>
          </test-items>
        </ModuleConfig-list>
      </module-items>
    </config-items>
  </gold-items>
</System>

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

To determine the available tests, run show diagnostic content module 1; this command displays the diagnostic test attribute legend and a table that lists the tests that you can run. The tests are identified by an ID number and by a name. The example payload on the right demonsrates configuring the diagnostic test interval for NVRAM (ID 2).

CLI Output
Switch# show diagnostic content module 1
Diagnostics test suite attributes:
B/C/* - Bypass bootup level test / Complete bootup level test / NA
P/*   - Per port test / NA
M/S/* - Only applicable to active / standby unit / NA
D/N/* - Disruptive test / Non-disruptive test / NA
H/O/* - Always enabled monitoring test / Conditionally enabled test / NA
F/*   - Fixed monitoring interval test / NA
X/*   - Not a health monitoring test / NA
E/*   - Sup to line card test / NA
L/*   - Exclusively run this test / NA
T/*   - Not an ondemand test / NA
A/I/* - Monitoring is active / Monitoring is inactive / NA


Module 1: 72x40G Ethernet Module (Active)


                                                   Testing Interval



ID     Name                               Attributes      (hh:mm:ss)




    

  1. USB--------------------------->     CNX*T     -NA-
    2. 

  2. NVRAM------------------------->     N***A     00:05:00
    3. 

  3. RealTimeClock----------------->     N***A     00:05:00
    4. 

  4. PrimaryBootROM---------------->     N***A     24:00:00
    5. 

  5. SecondaryBootROM-------------->     N***A     24:00:00
    6. 

  6. BootFlash--------------------->     N***A     00:30:00
    7. 

  7. SystemMgmtBus----------------->     MN****A     00:00:30
    8. 

  8. OBFL-------------------------->     CN****A     00:30:00
    9. 

  9. ACT2-------------------------->     N***A     00:30:00
    10. 

  10. Console----------------------->     N***A     00:00:30
    11. 

  11. FpgaRegTest------------------->     N***A     00:00:30
    12. 

  12. Mce--------------------------->     N***A     01:00:00
    13. 

  13. ASICRegisterCheck------------->     N***A     00:00:20
    14. 

  14. AsicMemory-------------------->     CDX*T     -NA-
    15. 

  15. Pcie-------------------------->     CNX*T     -NA-
    16. 

  16. PortLoopback------------------>     PNXE*     -NA-
    17. 

  17. L2ACLRedirect----------------->     PN*EA     00:01:00
    18. 

  18. BootupPortLoopback------------>     CPN**XET*     -NA-
    19.


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.

diagnostic monitor interval module 1 test 2 hour 00 min 05 second 00


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.

MODN
goldConfig sys/gold/config
goldModuleConfig sys/gold/config/module-1
goldTestMonitor sys/gold/config/module-1/test-2


goldModuleConfig Properties

The following table contains information about the goldModuleConfig 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 NameData TypeDescriptionValues
modIdgold:Id
(scalar:Uint32)		GOLD helath monitoring Module IdRANGE: [0, 4294967295]


goldTestMonitor Properties

The following table contains information about the goldTestMonitor 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 NameData TypeDescriptionValues
idgold:Id
(scalar:Uint32)		GOLD Health Monitoring Test IdRANGE: [0, 4294967295]
testIntervalgold:TestTime
(string:Basic)		Health Monitor Test IntervalA sequence of characters
DEFAULT: n/a


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 the Hour, Minute, and Seconds for an NVRAM Diagnostic Test

Unconfiguring the Hour, Minute, and Seconds for an NVRAM Diagnostic Test  

POST http://<mgmt0_IP>/api/mo/sys/gold/config.json

{
  "goldConfig": {
    "children": [
      {
        "goldModuleConfig": {
          "attributes": {
            "modId": "1"
          },
          "children": [
            {
              "goldTestMonitor": {
                "attributes": {
                  "id": "2",
                  "testInterval": "default"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <gold-items>
    <config-items>
      <module-items>
        <ModuleConfig-list>
          <modId>1</modId>
          <test-items>
            <TestMonitor-list>
              <id>2</id>
              <testInterval>default</testInterval>
            </TestMonitor-list>
          </test-items>
        </ModuleConfig-list>
      </module-items>
    </config-items>
  </gold-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.

no diagnostic monitor interval module 1 test 2 hour 00 min 05 second 00


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.

MODN
goldConfig sys/gold/config
goldModuleConfig sys/gold/config/module-1
goldTestMonitor sys/gold/config/module-1/test-2


goldModuleConfig Properties

The following table contains information about the goldModuleConfig 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 NameData TypeDescriptionValues
modIdgold:Id
(scalar:Uint32)		GOLD helath monitoring Module IdRANGE: [0, 4294967295]


goldTestMonitor Properties

The following table contains information about the goldTestMonitor 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 NameData TypeDescriptionValues
idgold:Id
(scalar:Uint32)		GOLD Health Monitoring Test IdRANGE: [0, 4294967295]
testIntervalgold:TestTime
(string:Basic)		Health Monitor Test IntervalA sequence of characters
DEFAULT: n/a


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

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