db_snapshot_backup_start
This job starts a database snapshot with the given expiration time. The database must be running to run this job.
Mandatory parameters
| Parameter name | Data type | Description |
|---|---|---|
| db_name | string | The name of an existing database which will have the snapshot. |
Optional parameters
| Parameter name | Data type | Description |
|---|---|---|
| expire | string | The expiration time for the snapshot using the format "#m #w #d #h" (ie, "1w 3d"). If no value is specified, the snapshot will not expire. |
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.
Python using XML-RPC