st_node_suspend

This job will suspend the specified node if possible (see below for prerequisites).
When a node is suspended it will not be marked as offline, but I/O operations
are not possible and no volume can be created on that node.
All volumes that contain the suspended node will be locked to prevent any I/O operation.
A suspended node is in a special state that can only be left when the node is either
restarted or manually resumed. This can for example be used to restart a node
without recovering the data.
If a suspended node is shut down physically, it will not be replaced with another node
and will not be recovered after it has been restarted.
Suspending a node may be denied if:

  • the node is offline, or
  • the node has active copy-on-demand maps, or
  • a volume that contains the node is currently in use.

Mandatory parameters

Parameter name Data type Description
nid integer Node ID

Optional parameters

There are no optional parameters.

Substitute parameters

There are no substitute parameters.

Allowed users

There are no defined allowed users.

Allowed groups

The following groups are allowed to run this job:

  • root
  • exaadm
  • exadbadm

Examples

The following examples show how to run this job in a Python program using XML-RPC or on the command line using confd_client.

conn.job_exec('st_node_suspend', {'params': {'nid': 11}})
confd_client st_node_suspend nid: 11