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 to back up and restore your system configuration.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!

These configuration backups are incompatible with those created with the Backup and configuration recovery utility, and vice versa.

...

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
  4. Use Windows command line to access the <Axxon One installation directory>\Axxon One\bin folder.
  5. Execute the following command:

    noformat
  6. ngpsh.exe backup backupJson [path_to_backup_folder] [node_name] [local] [shared] [license] [tickets]
  7. Where
  8. Parameters of the backupJson command:
    ParameterRequiredDescription
    path_to_backup_folder

Required parameter. 

  1. YesThe path to the folder where the backup is saved. Use double backslashes (\\) in the path

...

  1. node_name

Required parameter. 

...

  1. YesThe name of the server

...

  1. whose configuration you want to save

...

  1. local

...

  1. NoThis parameter saves the local configuration

...

  1. of the server (objects, their parameters,

...

  1. connections, and change history)
    sharedNoThis parameter saves the general configuration of the domain (

...

  1. users, layouts,

...

  1. and so on)
    license

...

Add it, if you need to save a license.

...

Add it, if you need to save the Axxon domain structure.

  1. NoThis parameter saves the license
    ticketsNoThis parameter saves the structure of the domain
    Example of a command:
    Code Block
    languageshell

An example:

...

  1. 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.

To automatically restore a configuration from backup, 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 restore a backup:

...

  1. Code Block
    languageshell
    ngpsh.exe backup restoreJson [path_to_backup_file] [node_name] [local] [shared] [license] [tickets] [deleteLocal] [deleteShared]

...

  1. Parameters of the restoreJson command:
    ParameterRequiredDescription

...

Add it, if you need to clear the local configuration from objects not present in the backup copy.

  1. path_to_backup_fileYesThe full path to the backup file (in JSON format). Use double backslashes (\\) in the path
    node_nameYesThe name of the server whose configuration you want to restore
    localNoThis parameter restores the local configuration of the server
    sharedNoThis parameter restores the general configuration of the domain
    licenseNoThis parameter restores the license
    ticketsNoThis parameter restores the structure of the domain
    deleteLocalNoThis parameter removes objects from the current local configuration that are not present in the backup (clean up before restoration)
    deleteSharedNoThis parameter removes objects from the current general configuration that are

...

  1. not present in the backup

...

An example:

  1. Example of a command:
    Code Block
    languageshell

...

  1. 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.