General information
You can use the ngpsh.exe utility and JSON commands for automated creation and restoration of configuration backup. This method is designed for automation of administration tasks and integration into scripts.
Automated creation of configuration backup
To create an automated backup of the configuration, do the following:
- Run the command prompt as administrator.
- Go to the utility directory by running the command:
cd <Axxon One installation directory>\AxxonOne\bin |
- Run the command to create a backup:
ngpsh.exe backup backupJson [path_to_backup_folder] [node_name] [local] [shared] [license] [tickets] |
Parameters of the backupJson command:
| Parameter | Required | Description |
|---|
| path_to_backup_folder | Yes | The path to the folder where the backup is saved. Use double backslashes (\\) in the path |
| node_name | Yes | The name of the server whose configuration you want to save |
| local | No | This parameter saves the local configuration of the server (objects, their parameters, connections, and change history) |
| shared | No | This parameter saves the general configuration of the domain (users, layouts, and so on) |
| license | No | This parameter saves the license |
| tickets | No | This parameter saves the structure of the domain |
Example of a command:
ngpsh.exe backup backupJson c:\\backups Server1 local |
Result:
A file named Server1.json is created in the c:\backups folder, containing the backup copy.
Automated restoration of configuration backup
Before performing any restore operations, make sure that you have a current backup in case you need to roll back. |
To automatically restore a configuration backup, do the following:
- Run the command prompt as administrator.
- Go to the utility directory by running the command:
cd <Axxon One installation directory>\AxxonOne\bin |
- Run the command to restore a backup:
ngpsh.exe backup restoreJson [path_to_backup_file] [node_name] [local] [shared] [license] [tickets] [deleteLocal] [deleteShared] |
Parameters of the restoreJson command:
| Parameter | Required | Description |
|---|
| path_to_backup_file | Yes | The full path to the backup file (in JSON format). Use double backslashes (\\) in the path |
| node_name | Yes | The name of the server whose configuration you want to restore |
| local | No | This parameter restores the local configuration of the server |
| shared | No | This parameter restores the general configuration of the domain |
| license | No | This parameter restores the license |
| tickets | No | This parameter restores the structure of the domain |
| deleteLocal | No | This parameter removes objects from the current local configuration that are not present in the backup (clean up before restoration) |
| deleteShared | No | This parameter removes objects from the current general configuration that are not present in the backup |
Example of a command:
ngpsh.exe backup restoreJson c:\\backups\Server1.json local |
Result:
The local configuration of Server1 is restored from the Server1.json file. Objects not present in the backup are removed from the current configuration.