db_backup_modify_schedule

This job modifies the given backup schedule with new parameters. 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.
backup_name string The name of the backup schedule to be modified.

Optional Parameters

Parameter Name Data Type Description
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.
minute string, integer Which minute the backup should run. The format is the same as minutes in cronjob (0 - 59 or *).
hour string, integer Which hour the backup should run. The format is the same as hours in cronjob (0 - 23 or *).
day string, integer Which day the backup should run. The format is the same as days in cronjob (1 - 31 or *).
month string, integer Which month the backup should run. The format is the same as months in cronjob (1 - 12 or *).
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 *).
enabled boolean When set to True, the schedule is enabled immediately. Otherwise, the schedule will not run until it is enabled.

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_backup_modify_schedule', {'params': {'db_name': 'exa_db', 'backup_name': 'backup1', 'minute': '0', 'hour': '0', 'day': '*', 'month': '*', 'weekday': '0'}})
conn.job_exec('db_backup_modify_schedule', {'params': {'db_name': 'exa_db', 'backup_name': 'backup1', 'enabled': True}})
confd_client db_backup_modify_schedule db_name: exa_db backup_name: backup1 minute: 0 hour: 0 day: '*' month: '*' weekday: 0
confd_client db_backup_modify_schedule db_name: exa_db backup_name: backup1 enabled: true