infra_db_stop

Stops an existing database in the cluster and shutdown the instances.

Mandatory Parameters

Parameter name Data type Description
db_name string The name of the database you want to stop.

Optional Parameters

Parameter name Data type Description
logtimeout integer The time limit for rotating logs on all nodes that are being stopped. The default is 180 seconds (3min).
offload_enabled boolean Whether or not offload is enabled for this worker db
offload_force boolean All sessions which cannot be moved will have their currently running statements killed
offload_timeout integer The client/statement will wait up to timeout in seconds for the sessions to be moved.

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 examples show how to run this job in a Python program using XML-RPC or on the command line using confd_client.