Backup and Restore

The com.prosyst.mbs.services.fim.backup.BackupAdmin functional item service provides operations for data backup and restore invocation using the available providers of the backup functionality in the system.

The BackupAdmin is registered with UID backup:admin and as a functional item service it is accessible through all the Functional Item Management local utilities and remote APIs. It has providers property containing the available backup providers in the system and the following operations:

• backup – forces the backup providers to backup their data on the provided location.
• restore – forces a set of providers to restore their data available on the provided location.

The parameters for the operations are:

• url – the data backup location. The currently supported protocols are file and http/https.
• providers – a set of providers if a partial data backup or restore is required.
• params – a set of parameters if needed for the location access or the data backup access.

   

  All the properties names starting with @ symbol are considered as configuration properties names. With HTTP protocol the rest of the properties are used as HTTP header parameters. These are pairs with a header name and a corresponding header value. The currently supported configuration properties are:

  • @method – specifies if the HTTP upload method should be PUT or POST. The default one is PUT.
  • @name – defines the content name if POST method is used. The default value is "backup".
  • @filename – defines the filename if POST method is used. The default value is the content name as a file name with zip file name extension, i.e. "<name>.zip".

For more information refer to the Java API.