IBM DataPower Operations Dashboard v1.0.13.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Backing Up and Restoring DPOD IDG Related Configuration

There might be cases where DPOD users would like the ability to remove DPOD related configuration from a monitored device (IDG). One such case would be a requirement for temporary monitoring of a non-production device for product demonstration.

There are two methods available to remove DPOD related configuration from monitored IDG devices:

  1. Manually, as describe in How to Uninstall DPOD from DataPower.
  2. Using the DPOD IDG configuration tool.

The DPOD IDG configuration tool is a simple tool that enables users to backup the DPOD related configuration of IDG before starting to monitor the IDG using DPOD.

If required, the tool can also be used remove the DPOD configuration from IDG monitored device.


Backing up the IDG configuration

To perform an IDG configuration backup, use the app_idg_pre_conf_bck.sh script located in the /app/scripts directory.

The script will back up the following IDG objects configuration:

  • XML management interface
  • WS-M agent configuration (default domain and appliaction domains)
  • Certificate monitor

The script parameters are :

Operation

Purpose

-i, --idg-ip

IDG xml management interface IP address or host name

-p, --idg-port

IDG xml management interface port

-u, --idg-user

IDG xml management interface username

-s, --idg-pass

IDG xml management interface user password

The script's backup directory and log file will be displayed in a message at the end of execution.

Example of the script execution :

app_idg_pre_conf_bck.sh -i 192.168.65.80 -p 5550 -u admin -s 123456


Removing DPOD configuration and restoring IDG objects based on the backup information

To remove the DPOD configuration from an IDG monitored device use the script app_idg_pre_conf_restore.sh located in the /app/scripts. directory.

If you did not run app_idg_pre_conf_bck.sh before installing DPOD - you can still remove some of the configuration automatically by running it now, and letting it backup the current configuration.
By doing so - the restore process will not revert the settings to the previous pre-DPOD state, but it will still automatically delete all DPOD's log targets and host aliases.

The script will restore the following IDG objects configuration based on the backup file :

  • XML management interface
  • WS-M agent configuration
  • Certificate monitor

Furthermore, the script will remove the following DPOD related configuration:

  • DPOD related host aliases
  • DPOD log targets
  • DPOD log category
  • Disable statistics
  • Remove two XSLT files deployed by DPOD to store directory

The script parameters are :

Operation

Purpose

-i, --idg-ip

IDG xml management interface IP address or host name

-p, --idg-port

IDG xml management interface port

-u, --idg-user

IDG xml management interface username

-s, --idg-pass

IDG xml management interface user password

-d, --backup-dir 

source backup directory

If you do not remember the backup directory's name - search the path /installs/system-backup for a sub folder with the device's ip address


As the original backed up configuration might have changed between the period of the backup and the restore, the script displays the backup data and provides the user with an opportunity to change the configuration to restore.

This is an example of the XML management interface restore menu:


The script's log file will be displayed in a message at the end of execution.


If multiple DPODs are installed, and one of them still needs to monitor the DataPower device, the script may have removed objects that belong to it.
In this case, you will need to setup syslog again for the device and domains for this other DPOD, see Adding Monitored Devices for more information


The script does not remove the following objects, and the user will have to remove them manually, unless there is another DPOD monitoring the device:
Log Category - msc-mon
Host Alias - MonTier_LogTarget_Source
Only in API Connect domains - Log Category - api-mon

IBM DataPower Operations Dashboard (DPOD) v1.0.13.0