db_backup_start

This job starts a backup of the given database to the given archive volume with given level and expiration time. The database must be running in order to write a backup.

Mandatory Parameters

Parameter Name Data Type Description
db_name string Name of an existing database to be backed up.
backup_volume_id integer ID of the archive volume which will store the backup. The archive volume can be either local or remote. This parameter may be substituted by backup_volume_name.
level integer The backup level (0,1,2,3,etc). Level 0 means a full backup, levels 1-9 are incremental backups.

Optional Parameters

Parameter Name Data Type Description
backup_volume_name string Name of the archive volume which will store the backup. The archive volume can be either local or remote. If both backup_volume_id and backup_volume_name are specified, backup_volume_id is used.
expire string The expiration time for the backup using the format "#m #w #d #h" (ie, "1w 3d"). If no value is specified, the backup will not expire.

Substitute Parameters

The below table describes what parameters can be substituted for another parameter.

Parameter Name Substitute Parameter
backup_volume_id backup_volume_name
backup_volume_name backup_volume_id

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_backup_start', {'params': {'db_name': 'exa_db', 'backup_volume_name': 'ArchiveVolume1', 'level': 0, 'expire': '1w'}})
confd_client db_backup_start db_name: exa_db backup_volume_name: ArchiveVolume1 level: 0 expire: 1w