db_state

This job returns the current state of the given database. Some common states are 'Running' (meaning the database is online), 'Setup' (meaning the database is offline), 'Startup' (meaning the database is starting up), and 'Shutdown' (meaning the database is shutting down).

Mandatory parameters

Parameter name Data type Description
db_name string Name of an existing database.

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 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('db_state', {'params': {'db_name': 'exa_db'}})
confd_client db_state db_name: exa_db