db_snapshot_backup_add_schedule

This job adds a database snapshot schedule for the given database. The database must be configured with a snapshot_sync_volume, which is used for the schedule.

Mandatory Parameters

Parameter Name Data Type Description
db_name string The name of an existing database.
backup_name string Name of backup task

Optional Parameters

Parameter Name Data Type Description
expire string, integer The expiration time for the snapshot using the format "#m #w #d #h" (ie, "1w 3d"). If not specified, the snapshot 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 snapshot 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 snapshot 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 snapshot 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 snapshot 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 snapshot 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

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_add_schedule', {'params': {'db_name': 'exa_db', 'backup_name': 'snapshot1', 'expire': '1w 3d', 'enabled': True, 'minute': '0', 'hour': '*', 'day': '*', 'month': '*', 'weekday': '*'}})
confd_client db_snapshot_backup_add_schedule db_name: exa_db backup_name: snapshot1 expire: '1w 3d' enabled: true minute: 0 hour: '*' day: '*' month: '*' weekday: '*'