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 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_snapshot_backup_start', {'params': {'db_name': 'exa_db', 'expire': '1w'}})
confd_client db_snapshot_backup_start db_name: exa_db expire: 1w