Powering Off a Module in the Switch

Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Powering off a Module in the Switch

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "platformEntity": {
          "children": [
            {
              "platformPoweroffEntity": {
                "children": [
                  {
                    "platformPoweroffModule": {
                      "attributes": {
                        "id": "1",
                        "poweroffStatus": "yes"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
  <pltfm-items>
    <poweroffEntity-items>
      <poweroffModule-items>
        <PoweroffModule-list>
          <id>1</id>
          <poweroffStatus>yes</poweroffStatus>
        </PoweroffModule-list>
      </poweroffModule-items>
    </poweroffEntity-items>
  </pltfm-items>
</System>

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.

poweroff module 1

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
platformEntity	sys/pltfm
platformPoweroffEntity	sys/pltfm/poweroffEntity
platformPoweroffModule	sys/pltfm/poweroffEntity/poweroffModule-{id}

platformPoweroffModule Properties

The following table contains information about the platformPoweroffModule 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	platform:moduleNumberSt (scalar:Uint16)	Module identifier for power off property	RANGE: [1 , 32]
poweroffStatus	platform:poweroffSt (scalar:Enum8)	Power off config state for the module [yes/no\]	SELECTION: 0 - no 1 - yes

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

Re-Powering on a Module in the Switch

Re-Powering a Module in the Switch