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.

Prepare your Monitored Devices

The following steps are required before adding a monitored device to DPOD.

Obtain Credentials

DPOD requires credentials (user name and password) in order to access the monitored devices:

  1. The user account needs to be Privileged.
  2. It is highly recommended to create a dedicated user for DPOD in the gateway for the following reasons:
    1. It decouples DPOD user from other activities on the gateway. If a user is shared between several systems/components and gets locked/suspended because of another system/component, it will affect DPOD as well.

    2. It allows better auditing with the ability to identify all actions made by DPOD on the gateway.

  3. The user account needs to be defined as a local account in the gateway (not an LDAP account), otherwise DPOD will not be able to access the gateway in case of an LDAP issue (for sampling, fetching information, changing configuration, etc.).


Make sure the user account is valid by actually logging in to the DataPower's Web GUI with that user account. If the user cannot login (for example, when password expires) - DPOD will not be able to communicate with the gateway successfully.

Configure Network Time Protocol (NTP)

Ensure each of your monitored devices is configured to use NTP. 

DPOD should be configured to use the same NTP servers as your monitored device(s).

DPOD might produce inconsistent view of the system if its monitored devices do not use the same time synchronization source, as the reported time is based on the monitored device time.

Perform Required Configuration

The following steps needs to be performed on each of the monitored devices:

  1. Set IBM DataPower Gateway Appliance Name. This is defined on [Administration->Device->System Settings->Appliance Name].
    Important: Avoid using spaces in appliance names.
  2. Configure the services in the XML Management interface [Network->Management->XML Management Interface] as follows: 
    1. Enable SOAP Configuration Management
    2. Enable AMP Endpoint
    3. Enable SLM Endpoint
    4. Enable WS-Management Endpoint
    5. Firmware 6.X only - Disable (uncheck) SOAP Management URI
    6. Firmware 6.X only - Disable (uncheck) SOAP Configuration Management (v2004)
  3. Make sure the XML Management Interface is enabled

Backup the Monitored Device(s)

Before you Add Monitored Devices to DPOD, it is imperative that you take a backup of your entire system.
During the installation process DPOD will:

  • Create Log Targets once you will initiate that step

  • Enable system statistics
  • Create network aliases for DPOD
  • Perform other optional steps (e.g. Certificate Monitoring)

As all these actions potentially alter the system configuration, so a backup is paramount in case a restore is required later on.

Changes to a Monitored Device Made by DPOD

Please review this list before using the product.

Please review the changes that DPOD is about to perform to your Gateway and make sure they are acceptable.

You should be aware that not all the changes can be undone automatically and some may require manual intervention to revert.

Please refer to the uninstall procedure before you start.



IBM DataPower Operations Dashboard (DPOD) v1.0.13.0