Add Backup Server

To create a backup server where users will be able to store backups and templates, use the following request:

POST /settings/backup_servers.xml
POST /settings/backup_servers.json

XML Request Example

curl -i -X POST -u account_email:API_key http://onapp.test/settings/backup_servers.xml -d '<backup_server><label>az_val</label><enabled>1</enabled><capacity>40</capacity><ip_address>172.0.0.1</ip_address><backup_ip_address>192.168.123.1</backup_ip_address><integrated_storage>1</integrated_storage></backup_server>' -H 'Accept: application/xml' -H 'Content-type: application/xml'

JSON Request Example

curl -i -X POST -u account_email:API_key http://onapp.test/settings/backup_servers.json -d '{"backup_server":{"label":"az_val", "enabled":"1", "capacity":"40", "ip_address":"172.0.0.1","backup_ip_address":"192.168.123.1", "integrated_storage":"1"}}' -H 'Accept: application/json' -H 'Content-type: application/json'

Where:

label* – backup server label

ip_address* – valid Ipv4 address

backup_server_ip_address - provisioning network IP address

capacity* – set the backup server capacity

enabled – set the "enabled" as 1 if you want the backup server to be enabled, or 0 if you want it to be disabled. If you skip the enabled parameter, the backup server will be disabled by default.

integrated_storage - set to 1 to enable integrated storage on the backup server, or 0 if you want it to be disabled. If you skip this parameter, the integrated storage will be disabled by default.

XML Output Example

<backup_server>
<label>az_val_1</label>
<created_at type="datetime">2012-02-10T15:14:53Z</created_at>
<updated_at type="datetime">2012-02-10T15:14:53Z</updated_at>
<backup_ip_address>192.168.123.1</backup_ip_address>
<backup_server_group_id nil="true"></backup_server_group_id>
<id type="integer">25</id>
<enabled type="boolean">true</enabled>
<backups type="array"/>
<capacity type="integer">40</capacity>
<ip_address>172.0.0.2</ip_address>
<integrated_storage type="boolean">false</integrated_storage>
</backup_server>


Page History

v.6.1 Edge 2

  • added the integrated_storage parameter