db_backup_add_schedule

This job adds a backup schedule to the given storage volume with the given level and expiration time.

Mandatory Parameters

Parameter Name Data Type Description
db_name string The name of an existing database.
backup_name string The name of the backup schedule
backup_volume_id integer The ID of the archive volume which will store the backups. backup_volume_id can 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 The name of the archive volume which will store the backups. backup_volume_name can substitute backup_volume_id.
expire string, integer The expiration time for the backup using the format "#m #w #d #h" (ie, "1w 3d"). If not specified, the backup will not expire.
enabled boolean When set to True, the schedule is enabled immediately. Otherwise, the schedule will not run until it is enabled.
minute string, integer Which minute the backup should run. The format is the same as minutes in cronjob (0 - 59 or *). If not specified, the default value is "0".
hour string, integer Which hour the backup should run. The format is the same as hours in cronjob (0 - 23 or *). If not specified, the default value is "*".
day string, integer Which day the backup should run. The format is the same as days in cronjob (1 - 31 or *). If not specified, the default value is "*".
month string, integer Which month the backup should run. The format is the same as months in cronjob (1 - 12 or *). If not specified, the default value is "*".
weekday string, integer Which weekday the backup should run. The format is the same as weekdays in cronjob (0 - 7 or the english name of the day or *). If not specified, the default value is "*".

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_add_schedule', {'params': {"db_name": "exa_db", "backup_name": "backup1", "backup_volume_name": "r0001", "enabled": true, "level": 0, "expire": "1w 3d", "hour": 0, "day": "*", "month": "*", "weekday": 0}})
confd_client -c db_backup_add_schedule -a '{"db_name": "exa_db", "backup_name": "backup1", "backup_volume_name": "r0001", "enabled": true, "level": 0, "expire": "1w 3d", "hour": 0, "day": "*", "month": "*", "weekday": 0}'