Article ID: 117943, created on Oct 14, 2013, last review on Jun 17, 2016

  • Applies to:
  • Virtual Automation

Question

How to backup a container via PVA XML API?

Answer

  • To backup a container via API to localhost, the following request should be used:

    <packet <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" version="4.0.0" log="on" progress="on" priority="2000" timeout_limit="20000000">
    <target>backupm</target>
    <data>
    <backupm>
    <backup_env>
    <env_list><eid>$CONTAINER_EID</eid></env_list>
    </backup_env>
    </backupm>
    </data>
    </packet>
    
  • To backup a container via API to network backup node, the following request should be used:

    <packet <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" version="4.0.0" log="on" progress="on" priority="2000" timeout_limit="20000000">
    <target>backupm</target>
    <data>
    <backupm>
    <backup_env>
    <env_list><eid>$CONTAINER_EID</eid></env_list>
    <backup_server xsi:type="ns1:connection_infoType">
    <ns1:protocol>SSL</ns1:protocol>
    <ns1:address>10.28.8.12</ns1:address>
    <ns1:port>4434</ns1:port>
    <ns1:login>
    <ns1:name>$BASE64_USERNAME</ns1:name>
    <ns1:realm>00000000-0000-0000-0000-000000000000</ns1:realm>
    </ns1:login>
    <ns1:password>$BASE64_PASSWD</ns1:password>
    </backup_server>
    <backup_options xsi:type="ns2:backup_optionsType">
    <ns2:compression>1</ns2:compression>
    <ns2:type>0</ns2:type>
    <ns2:include_list/>
    <ns2:exclude_list/>
    </backup_options>
    </backup_env>
    </backupm>
    </data>
    </packet>
    

Where

  • EID of the container "$CONTAINER_EID" can be obtained this way.
  • The credentials for a backup node should grant root access.
  • Login and password should be converted to base64 code. Replace "$BASE64_USERNAME" and "$BASE64_PASSWD" with appropriate values encoded in base64.

Also check this article to learn how to send API request to PVA agent.

NOTE: backup_options should be specified in order backup_server to work.

Search Words

backup

backup container to external backup node

request

xml api

319940068c5fa20655215d590b7be29b 2897d76d56d2010f4e3a28f864d69223

Email subscription for changes to this article
Save as PDF