Free trial

IBM DataPower

Learn how to monitor DataPower devices using the DataPower ActiveGate extension.

Prerequisites

  • A DataPower appliance with the XML Management Interface enabled
  • An Environment ActiveGate (version 1.155+) that has the ActiveGate plugin module installed and isn't used for synthetic or mainframe monitoring
    • 1 environment ActiveGate can typically support 30-50 DataPower devices

Interested in monitoring DataPower with DESK?

The quickest way to get started is by contacting a DESK ONE product specialist. Just click the chat button in the upper-right corner of the DESK menu bar.

Environment ActiveGate installation

ActiveGate plugin module installation

ActiveGate version 1.175+ has the plugin module installed by default.

Extension installation

  1. Obtain the install file (custom.remote.python.datapowerxml.zip). Don't rename the file.
  2. Unzip custom.remote.python.datapowerxml.zip to the plugin_deployment directory of your ActiveGate host.
  3. If the resulting directory structure isn't .\plugin_deployment\custom.remote.python.datapowerxml\, please make the neccessary changes.
  4. Restart the DESK Remote Plugin Module service.
    • On Linux, restart the service using the following commands with admin rights:
      • systemctl restart remotepluginmodule.service
    • On Windows, run these two commands in a Command Prompt launched as Admin:
      • sc stop "DESK Remote Plugin Module"
      • sc start "DESK Remote Plugin Module"
  5. Return to the DESK web UI. Click Settings, the Add new technology monitoring button, and finally the Add ActiveGate plugin button.
  6. Click the Upload plugin button and upload custom.remote.python.datapowerxml.zip.
  7. Enter the endpoint information requested for connecting to DataPower device:
    • Endpoint name: Meaningful and descriptive name
    • User: The username for the account connecting to the XML Management Interface
    • Password: The password for the account
    • URL to the XML Management Interface: The domain name entered will be used for differentiating the devices if there are multiple
    • Require a valid SSL certificate: Select if a valid SSL certificate is required. Note that even if the certificate validation is disabled the extension will still communicate via HTTPS, if the device is configured for that.
    • Path to a CA_BUNDLE file or directory: Add the absolute path to self-signed certificates of trusted CAs
    • Enable debug logging: Leave unchecked by default, can be checked if requested by DESK ONE in order to investigate an issue
    • Comma-separated domains: Allows for filtering of domains that are to be monitored
    • Comma-separated services: Allows for filtering of services that are to be monitored
    • Comma-separated interfaces: Allows for filtering of interfaces that are to be monitored
    • Comma-separated tasks: Allows for filtering of tasks that are to be monitored
    • Comma-separated XML managers: Allows for filtering of XML managers that are to be monitored
    • Comma-separated log targets: Allows for filtering of log targets that are to be monitored
    • Comma-separated additional IPs: Allows for filtering of additional IP addresses that are to be monitored
    • Name of the group: If the device is part of a cluster, enter the name here to group the devices in the DESK web UI.

Troubleshoot ActiveGate plugins

Metrics

The IP address of all network interfaces and the ports used by the services is automatically captured, as are the following metrics:

Device

  • Availability %
  • CPU load %
  • Crypto Engine % Fully operational

Disk

  • Free encrypted
  • Total encrypted
  • Free temporary
  • Total temporary
  • Free internal
  • Total internal

Log events (split by domain and logtarget)

  • Processed
  • Dropped
  • Processed

Network (split by interface)

  • Connections accepted
  • Received throughput
  • Transmitted throughput
  • Received packets
  • Transmitted packets
  • Recieved dropped packets
  • Transmitted dropped packets
  • Received errors
  • Transmitted errors

Services (split by service and domain)

  • Service calls
  • Response time
  • Availability (enabled, but status is not up)

System usage

  • Load %
  • Pending messages in queue

Tasks (split by tasks)

  • Load %
  • Pending messages in queue
  • CPU %
  • Memory %
  • File count

WSM Agent (split by domains)

  • Active subscribers
  • Records lost
  • Pending records queue
  • Complete records queue

XML Manager

  • HTTP connection requests