db_suspend_nodes

This job suspends the given nodes in the given database. Suspending a node means that the node is marked as unavailable, even though it continues to run. This can be used to perform maintenance on a node. If this is done to an active node while the database is running, the database will shutdown and restart with a reserve node instead (if configured).

Mandatory Parameters

Parameter Name Data Type Description
db_name string The name of an existing database.
node_list list List of node names that should be suspended in the given database, for example: ['n11', 'n12']

Optional Parameters

There are no optional parameters.

Substitute Parameters

There are no substitute parameters.

Allowed Users

The following users are allowed to run this job:

  • root

Allowed Groups

The following groups are allowed to run this job:

  • root
  • exaadm
  • exadbadm

Examples

The following code snippets show how to use this job using both Python (via XML-RPC) and on the command-line using confd_client.

conn.job_exec('db_suspend_nodes', {'params': {'db_name': 'exa_db', 'node_list': ['n12']}})
confd_client db_suspend_nodes db_name: exa_db node_list: '[n12]'