db_backups_delete

This job deletes the specified backup(s).

Mandatory Parameters

Parameter name Data type Description
db_name string Name of an existing database.
backup_list list List of IDs of backups to be deleted. A backup ID has the format "<volume_id> <path_to_backup> <db_name>", for example "1 exa_db/id_1/level_0/node_0/backup_201811061154 exa_db". This can be obtained from the return value of the job db_backup_list, under the key ID.

Optional Parameters

There are no optional parameters.

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 examples show how to run this job in a Python program using XML-RPC or on the command line using confd_client.

conn.job_exec('db_backups_delete', {'params': {'db_name': 'exa_db', 'backup_list': ['1 exa_db/id_1/level_0/node_0/backup_201811131114 exa_db']}})
conn.job_exec('db_backups_delete', {'params': {'db_name': 'exa_db', 'backup_list': ['1 exa_db/id_1/level_0/node_0/backup_201811131114 exa_db', '1 DB1/id_2/level_0/node_0/backup_201811201114 exa_db']}})
confd_client db_backups_delete db_name: exa_db backup_list: '[1 exa_db/id_1/level_0/node_0/backup_201811131114 exa_db]'
confd_client db_backups_delete db_name: exa_db backup_list: '[1 exa_db/id_1/level_0/node_0/backup_201811131114 exa_db, 1 DB1/id_2/level_0/node_0/backup_201811201114
    exa_db]'