db_stop

Stops a running database. The database nodes will remain online and available.

Mandatory Parameters

Parameter Name Data Type Description
db_name string Name of an existing database to be stopped.

Optional Parameters

Parameter Name Data Type Description
force boolean When set to True, the database is forced to shutdown. This should only be used if the database cannot shut down normally.
cluster string Which database clusters should be stopped. Can be a cluster name, '+all' or 'MAIN' (database name can be passed instead of 'MAIN')

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_stop', {'params': {'db_name': 'DB1'}})
conn.job_exec('db_stop', {'params': {'db_name': 'DB1', 'force': True}})
confd_client db_stop db_name: DB1
confd_client db_stop db_name: DB1 force: true