Previous page

Next page

Locate page in Contents

Print this page

remove

Summary:

Removes a backup archive.

Request specification:

Name

Min/Max

Type

Description

remove

 

 

 

{

 

 

 

backup_id

0..1

backupid_type

The ID of the backup to be removed.

options

0..1

remove_optionsType

Removal options.

}

 

 

 

Returns:

OK/Error

Description:

If you are connected to the master node in a Virtuozzo group, the call can remove any backup stored on any physical node in a cluster. In all other cases, the call can remove only the backups that are stored locally. If you are connected to a slave node but want to remove a backup from a machine located elsewhere, you must connect to it directly and execute the call there.

To remove a specific backup, supply the backup ID using the backup_id element. If, at the same time, you'll also include the options/prev element, the call will automatically determine the server that the specified backup belongs to, and will remove all prior backups that belong to the same server.

To remove all of the backups for a specific server, specify its Server ID using the options/eid element.

Example 1:

Removing the specified backup archive.

<packet version="4.0.0">

<target>backupm</target>

<data>

<backupm>

<remove>

<backup_id>57c2cd6c-c02b-4645-bdb5-e883ea005896/20070219170146</backup_id>

</remove>

</backupm>

</data>

</packet>

Example 2:

Removing a backup archive and all the prior backups belonging to the same server.

<packet version="4.0.0">

<target>backupm</target>

<data>

<backupm>

<remove>

<backup_id>57c2cd6c-c02b-4645-bdb5-e883ea005896/20070219170146</backup_id>

<options>

<prev/>

</options>

</remove>

</backupm>

</data>

</packet>

Example 3:

Removing all backups belonging to the specified server.

<packet version="4.0.0">

<target>backupm</target>

<data>

<backupm>

<remove>

<options>

<eid>57c2cd6c-c02b-4645-bdb5-e883ea005896</eid>

</options>

</remove>

</backupm>

</data>

</packet>

Please send us your feedback on this help page