Summary:
Backs up a server. You may specify multiple servers to back up at the same time.
Request specification:
Name |
Min/Max |
Type |
Description |
|
|
|
|
|
|
|
|
|
|
Servers to backup. |
|
|
|
Backup options. |
|
|
|
Backup server connectivity information for remote backups. If this element is omitted, the default backup server configuration will be used. To retrieve the default configuration, use the |
|
|
|
|
|
Returns:
Name |
Min/Max |
Type |
Description |
|
|
Backup details. When backing up multiple servers, a mix of the backup and error information may be returned. |
Description:
The call provides a set of options that allow you to control the backup operation. The options include replacing a specific old backup archive, backing up only the directories that you need, excluding the files and directories that you don't need, setting the compression level, and others. See backup_optionsType
for the complete list of options.
Since a backup operation can take a significant amount of time, you may optionally include the progress="on"
attribute and specify the packet ID to receive the progress information. The progress information will be sent to your client program via a series of responses using the progress
packet.
Example:
Performing a full backup of the specified Virtuozzo Container. Setting a compression level to "high". Backing up to the default defined backup server.
Input
<packet progress="on" log="on" id="2" version="4.0.0">
<target>backupm</target>
<data>
<backupm>
<backup_env>
<env_list>
<eid>57c2cd6c-c02b-4645-bdb5-e883ea005896</eid>
</env_list>
<backup_options>
<type>0</type>
<compression>2</compression>
<description>RnVsbCBiYWNrdXAgMjAwNy0wMS0xMg==</description>
</backup_options>
</backup_env>
</backupm>
</data>
</packet>
Progress Messages
The following are some of the progress messages that we received in this example (the actual XML packets are not listed here for brevity):
Operation backup_env is started
Checking parameters
Dumping quota
Backup storage: preparing to backup
Adjusting backup type (full)
Backup storage: receiving backup file
Backing up private area.
// Some progress percent messages were received here...
Percent: 2
...
Percent: 54
...
Percent: 99
....
Backup storage: storing private backup data
Backup storage: filling resultant backup info
The following is the actual example of a packet containing a progress message.
<ns1:packet xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="2" time="2007-02-16T16:14:04+0000" type="1" priority="4000" version="4.0.0">
<ns1:origin>backupm</ns1:origin>
<ns1:target>vzclient3</ns1:target>
<ns1:dst>
<director>gend</director>
</ns1:dst>
<ns1:data>
<ns1:progress>
<ns1:op>backupm.backup_env</ns1:op>
<ns1:message>
<ns1:message>T3BlcmF0aW9uICVvcF9uYW1lJSBpcyAlc3RhdHVzJQ==</ns1:message>
<ns1:name></ns1:name>
<ns1:translate/>
<ns1:parameter>
<ns1:message>YmFja3VwX2Vudg==</ns1:message>
<ns1:name>op_name</ns1:name>
</ns1:parameter>
<ns1:parameter>
<ns1:message>c3RhcnRlZA==</ns1:message>
<ns1:name>status</ns1:name>
<ns1:translate/>
</ns1:parameter>
</ns1:message>
<ns1:status>1</ns1:status>
</ns1:progress>
</ns1:data>
<ns1:target>log_subscription</ns1:target>
<ns1:src>
<ns1:director>gend</ns1:director>
</ns1:src>
</ns1:packet>
Output
The following is a packet received on the backup operation completion. The packet contains the backup information, including the information about the server that was backed up, the backup ID, backup archive size, backup type, and other info.
<ns1:packet xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/backupm" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="7c45db0eb2t72aer488" time="2007-02-19T15:05:29+0000" priority="4000" version="4.0.0">
<ns1:origin>backupm</ns1:origin>
<ns1:target>vzclient3</ns1:target>
<ns1:dst>
<director>gend</director>
</ns1:dst>
<ns1:data>
<ns2:backupm>
<ns2:backup>
<ns2:eid>57c2cd6c-c02b-4645-bdb5-e883ea005896</ns2:eid>
<ns2:count>2</ns2:count>
<ns2:id>57c2cd6c-c02b-4645-bdb5-e883ea005896/20070219150134</ns2:id>
<ns2:time>2007-02-19T20:01:34+0000</ns2:time>
<ns2:size>12709275</ns2:size>
<ns2:type>0</ns2:type>
<ns2:storage_eid>89e27960-97b8-461f-902f-557b4b16784b</ns2:storage_eid>
<ns2:info>
<ns2:message></ns2:message>
<ns2:name></ns2:name>
<ns2:translate/>
<ns2:parameter>
<ns2:message>SG9zdC0xMDY=</ns2:message>
<ns2:name>hostname</ns2:name>
<ns2:translate/>
</ns2:parameter>
<ns2:parameter>
<ns2:message>MTAuMTMwLjEuNg==</ns2:message>
<ns2:name>ip</ns2:name>
<ns2:translate/>
</ns2:parameter>
<ns2:parameter>
<ns2:message>VGVzdC1WRTY=</ns2:message>
<ns2:name>name</ns2:name>
<ns2:translate/>
</ns2:parameter>
<ns2:parameter>
<ns2:message></ns2:message>
<ns2:name>os</ns2:name>
<ns2:parameter>
<ns2:message>TGludXg=</ns2:message>
<ns2:name>platform</ns2:name>
</ns2:parameter>
</ns2:parameter>
<ns2:parameter>
<ns2:message>ODllMjc5NjAtOTdiOC00NjFmLTkwMmYtNTU3YjRiMTY3ODRi</ns2:message>
<ns2:name>parent_eid</ns2:name>
<ns2:translate/>
</ns2:parameter>
<ns2:parameter>
<ns2:message>ZGhjcDAtNDAuc3cucnU=</ns2:message>
<ns2:name>parent_env_title</ns2:name>
<ns2:translate/>
</ns2:parameter>
<ns2:parameter>
<ns2:message>VGVzdC1WRTY=</ns2:message>
<ns2:name>title</ns2:name>
<ns2:translate/>
</ns2:parameter>
<ns2:parameter>
<ns2:message>dmlydHVvenpv</ns2:message>
<ns2:name>type</ns2:name>
</ns2:parameter>
</ns2:info>
</ns2:backup>
</ns2:backupm>
</ns1:data>
<ns1:src>
<ns1:director>gend</ns1:director>
</ns1:src>
</ns1:packet>