System management resource

The system management resource provides management of different management access methods, reboot/shutdown and diagnostic functions.

Child Topics

• System management objects

  The object model describing this resource contains the following objects.

• Reboot node

  Initiate a reboot of a cluster node. Any virtual servers running on the cluster node will be migrated to another node. The API call returns after initiating the reboot request, and does not wait for the reboot to complete.

• Shutdown node

  Initiate a shutdown of a cluster node. Any virtual servers running on the cluster node will be migrated to another node. Access to the node will be required to power it on again, either physically or via IPMI.

• Reboot cluster

  Initiate a reboot of all nodes in a cluster. All nodes will reboot simultaneously and access to all virtual servers will stop. There will be a short wait while all the nodes reboot and restart. The API call returns after initiating the reboot request, and does not wait for the reboot to complete.

• Reboot cluster sequentially

  Initiate a reboot of all nodes in a cluster, in sequence. All nodes will reboot one after the other, which should ensure that all virtual servers remain running while the cluster reboots. There will be short interruptions while the virtual servers migrate as the node they are running on reboots, and they migrate to another node. The API call returns after initiating the reboot request, and does not wait for the reboot to complete.

• Shutdown cluster

  Initiate a shutdown of all cluster nodes. Access to the nodes will be required to power it on again, either physically or via IPMI.

• Get boot details

  Get the details about the last boot for all nodes in a cluster, and their current uptimes.

• Get node boot details

  Get the details about the last boot for a specific cluster node, and its current uptime.

• Get diagnostics for all nodes

  Get diagnostics from all nodes within the cluster. This API call will not respond immediately, as the diagnostics need to be generated before download. The more nodes in the cluster, the longer the diagnostics may take.

• Get node diagnostics

  Get diagnostics from a specific cluster node.

• Get login banner

  Get the login banner contents, and enabled state. If enabled, the login banner is presented to any user who connects to the system via SSH or via the GUI.

• Reset login banner to default

  Reset the login banner contents to the default. The enabled status of the banner is not changed.

• Update login banner

  Update the login banner contents, and enabled state. If enabled, the login banner is presented to any user who connects to the system via SSH or via the GUI.

• Get SNMP access config

  Get SMNP management access configuration.

• Set SNMP access config

  Configure SNMP management access. SNMP provides read only access to various system resources.

• Get management access config

  Get the configuration of one of the system management services.

• Set management access config

  Set the configuration for one of the system management services.

• Get management users

  Get a list of all management users.

• Get management user

  Get details about a specific management user.

• Add management user

  Adds a new management user.

• Delete management user

  Delete a management user.

• Update management user password

  Change the password for a management user. Both the old password and a new password are required to change the password.

• Get access level

  Return the access level of the user/password combination or API key used when making the connection.

• Get registry file

  Downloads a copy of the system configuration registry file.