IDOL Category Component 24.4
IDOL Category Component Help

# BackupServer

The `BackupServer` action creates a backup that you can use to restore the state of the server.

This action returns the file name of a backup file in the `autnresponse/responsedata/filename` tag. You can pass this value to the RestoreServer action to restore the server state from the backup.

You can use this action for the Content, Category, and Community components, but you must send the action to the component ACI port, rather than to the IDOL Proxy port.

NOTE: This is an administrative action that can be sent only by users that belong to an authorization role that allows the `Admin` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

## Example

    http://localhost:9020/action=BackupServer&path=./backups

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Path | The folder in which to save the backup file.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL IDOL Category Component 24.4

Topic Title: BackupServer