Retrieving Server-wide Backup Settings

The get-server-wide-settings operation is used to retrieve the server-wide backup settings.

Request Packet

A request XML packet retrieving backup settings includes the get-server-wide-settings operation node:

<packet>
  <backup-manager>
    <get-server-wide-settings/>
  </backup-manager>
</packet> 

The get-server-wide-settings node is required. Data type: NoneType.

 
Response Packet Structure

The get-server-wide-settings node of the response XML packet is presented by type BackupGetServerWideSettingsOutput (backup.xsd) and structured as follows:

get-server-wide-settings

The result node wraps the response retrieved from the server. Data type: resultFilterType (common.xsd).

The information about the backup settings is held by the settings node, which is presented by the complex type BackupServerWideSettings (backup.xsd). The node is structured as follows:

Response Sample

A positive response packet received from the server can look as follows:

<packet version="1.6.7.0">
  <backup-manager>
    <get-server-wide-settings>
      <result>
        <status>ok</status>
        <settings>
          <max-backup-files>12</max-backup-files>
          <max-backup-processes>10</max-backup-processes>
          <low-priority>false</low-priority>
          <do-not-compress>false</do-not-compress>
          <allow-local-ftp-backup>false</allow-local-ftp-backup>
          <keep-local-backup>true</keep-local-backup>
        </settings>
      </result>
    </get-server-wide-settings>
  </backup-manager>
</packet>