Restoring UI configuration data (on-prem)

Agile Service Manager includes a backup facility, which lets you backup UI configuration settings such as user preferences, topology tools, custom icons, relationship types, rules and advanced topology settings. This topic describes how to import previously exported (backed up) settings in order to restore your previous configurations.

Before you begin

You can only import and restore configuration settings that have been previously exported, as described in the Backing up UI configuration data (on-prem) topic

The tool detects the host, port, and tenant id for the Topology Service from the following environment variables:
  • TOPOLOGY_SERVICE_HOST
  • TOPOLOGY_SERVICE_PORT
  • TENANT_ID
Important: If you have a standard installation of Agile Service Manager core, and none of the default settings have been changed, the tool will work without you having to reset any of these environment variables. However, if you do have a non-standard installation, you need to reset these before running the tool.

About this task

Import syntax
This syntax applies to all backed up UI data other than custom filters.
The script can be found in the ASM_HOME/bin/ directory:
import_ui_config.sh
Example:
import_ui_config -file <input_file> [-overwrite] [-verbose]
Tip: For help: 
import_ui_config.sh -help
Import parameters
These parameters apply to all backed up UI data other than custom filters.
file
The -file parameter is the name of the backup file from which to import definitions. It must be a file name only with no directory paths included, and it must exist in the tools data directory (/opt/ibm/netcool/asm/data/tools/).
overwrite
By default, as the import tool reads the backup file it looks up each item in the topology service to see if it already exists. Any configuration definitions which already exist are not updated.
However, if you set the -overwrite flag, the existing definitions are overwritten with the values from the backup file.
verbose
The -verbose flag runs the tool in verbose mode, whereby extra log messages are printed to the shell during execution.
Useful if a problem occurs running the tool and you want to re-run it with extra information made available.
Restore script for filters
You can use a separate script to restore previously backed up custom filters. 
restore_filters.sh
This script restores filters from the 'aiops_filter.dump' file in the 'backup' directory:
/data/postgres/backup/aiops_filter.dump
Note: The backup and restore scripts for filters use the 'pg_dump' and 'pg_restore' postgres utilities. For more information, see the following sites:

Procedure

  1. To restore UI configuration data (other than custom filters):
    1. Using the syntax information provided, enter the file name of the previously exported backup file.
    2. Determine if any other <options> you need to set, such as the -overwrite flag.
    3. Run the import_ui_config command from your ASM_HOME/bin/ directory, as in the following example. 
      import_ui_config.sh <options>
    The Agile Service Manager UI configuration data is imported from the specified file in the /data/postgres/backup/ directory. If the -overwrite flag has been set, existing configuration data will be overwritten.
  2. To restore custom filters:
    1. Ensure that the new system into which you want to import the custom filters is running, including postgres.
    2. Move the 'aiops_filter.dump' backup file back to the following location in the new system:
      /data/postgres/backup/
    3. While the new system is running, and as the nasm user, run the following command: 
      restore_filters.sh