db_backup_change_expiration
This job changes the expiration time of the given backup.
Mandatory parameters
Parameter name | Data type | Description |
---|---|---|
backup_volume_id | integer | ID of the archive volume storing the backup. Can be substituted by backup_volume_name. |
backup_files | string | Prefix of the backup files. The prefix is generally in the format "<db_name>/<id_#>/<level_#>", e.g. exa_db/id_1/level_0) |
expire_time | string | Expiration time for the backup in the format YYYY-MM-DD hh:mm:ss. If the value is blank, the backup will not expire. |
Optional parameters
Parameter name | Data type | Description |
---|---|---|
backup_volume_name | string | Name of the archive volume storing the backup. Can substitute backup_volume_id. |
Substitute parameters
The following 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 examples show how to run this job in a Python program using XML-RPC or on the command line using confd_client.