Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section


Column
width50%


Panel
borderColor#CCCCCC
bgColor#FFFFFF
titleBGColor#F0F0F0
borderStylesolid
titleOn the page:
Table of Contents



Column


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.

Note
titleAttention!

Backups created using the ngpsh.exe command-line utility aren't displayed in the Backup and restore utility and cannot be restored using the Backup and restore utility.

Automated creation of configuration backup

To create an automated backup of the configuration, do the following:

  1. Run the command prompt as administrator.
  2. Go to the utility directory by running the command:
    Code Block
    languageshell
    cd <Axxon One installation directory>\AxxonOne\bin

  3. Run the command to create a backup:
    Code Block
    languageshell
    ngpsh.exe backup backupJson [path_to_backup_folder] [node_name] [local] [shared] [license] [tickets]
    Parameters of the backupJson command:
    ParameterRequiredDescription
    path_to_backup_folderYesThe path to the folder where the backup is saved. Use double backslashes (\\) in the path
    node_nameYesThe name of the server whose configuration you want to save
    localNoThis parameter saves the local configuration of the server (objects, their parameters, connections, and change history)
    sharedNoThis parameter saves the general configuration of the domain (users, layouts, and so on)
    licenseNoThis parameter saves the license
    ticketsNoThis parameter saves the structure of the domain
    Example of a command:
    Code Block
    languageshell
    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

Note
titleAttention!

Before performing any restore operations, make sure that you have a current backup in case you need to roll back.

...