db_start
Starts the database. The database must already exist and must not be running.
Mandatory Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| db_name | string | Name of an existing database to be started. |
Optional Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| maintenance | boolean | If set to True, the database is started in maintenance mode. This should only be done on recommendation from support. |
| timeout | integer | Number of seconds to wait for the database to be running. The default value is 0, which disables the timeout. If the timeout is reached, the operation is aborted. |
| cluster | string | Which database clusters should be started. 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.
Python using XML-RPC