IBM DataPower Operations Dashboard v1.0.15.0

A newer version of this product documentation is available.

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

Configuring Monitored Gateways

Each monitored gateway needs to be configured to send information to DPOD after added to DPOD. To configure a gateway, click its name in [Manage→Topology→Gateways].

This step changes or adds some of the monitored gateway objects. Please review the list of changes before you continue to perform these actions.

Gateway Details

The following details are displayed:

Field

Description

Field

Description

Host

IP Address used to access the gateway

SOMA port

The SOMA port configured on this gateway

Device Resources Monitoring

Whether Device resources monitoring is enabled on this gateway

Service Resources Monitoring

Whether Service resources monitoring is enabled on this gateway

Click on the Gateway Info button for more information, such as the firmware level, device type, serial number, features, etc.

Click on the Edit button to add the basic details of this gateway. See Adding Monitored Devices for more information.

Click on the Delete button to delete the monitored gateway from DPOD. The gateway will stop sending information to DPOD and DPOD will stop sampling the gateway. However, existing data of the gateway in DPOD (e.g.: transactional data, resources) will be kept.

Domains Tab

The Domains tab lists all the domains of a gateway. Click on a domain to view its details or to configure a specific domain (see below).

Setup Tab

The Setup tab allows to configure the gateway to send information to DPOD in order to collect and view transactional data.

If you wish to monitor transactions in the default domain, please follow the instructions in Monitoring Transactions in the Default Domain.

If you change DPOD's or the monitored device's IP address, you will need to repeat the setup.

The following sections are available:

Section

Details

Section

Details

Setup Syslog for device

Sets up the necessary configuration for the gateway to send gateway-level Syslog records to the selected agent.
This configuration should be executed once after installing the system or when you need to redirect the gateway-level Syslog messages to a different agent.
To setup the Syslog for a gateway, select a Syslog Agent from the drop-down list, and click the Setup Syslog button.

You can disable/enable this Syslog log target by clicking on the "Device Syslog Status" Enabled/Disabled buttons.

Note: This action changes your gateway configuration - please review changes.

Setup Syslog for all domains

Sets up the necessary configuration for all the domains to send domain-level Syslog records to the selected agent.
This configuration should be executed once after installing the system, when a new domain is created or when you need to redirect the gateway-level Syslog messages to a different agent.
To setup the log targets for all domains, select a Syslog Agent from the drop-down list, select analysis level from the drop-down list, and click the Setup Syslog button.

You can disable/enable all log targets by clicking on the "Domains Syslog Status" Enabled/Disabled buttons.

This will apply the same setup to all domains in the gateway. To select a different configuration for each domain, see the section "Domain Setup Tab" later on this page.

Limitation: DPOD does not support more than 125 domains per gateway. See Known Limitations. Trying to run this action on more than 125 domains can be unpredictable. If you have more than 125 domains, you MUST run "Setup Syslog" using the Domain Level procedure below.

Note: This action changes your gateway configuration - please review changes.

Auto Setup Domains

This feature will automatically detect and setup new domains created on the monitored gateway, this is especially useful for dynamically created API Connect domains.

Choose a Syslog agent and a WS-M agent that the domains should report to, select analysis level from the drop-down list, enter the domain pattern (use asterisk as wildcard) and click save.
DPOD will scan the monitored gateway every couple of minutes and will setup the new domain (you can change the interval from the system parameters page).

Setup WS-M for all domains

Sets up the necessary configuration for all the domains to send payload data to the selected agent.

This configuration should be executed once after installing the system, when a new domain is created or when you need to redirect the payloads to a different agent

Clicking the "Record Payload" link will take you to the Payload Capture page, where you can start a WS-M subscription.

This will apply the same setup to all domains in the gateway. To select a different configuration for each domain, see the section "Domain Setup Tab" later on this page.

Note: This action changes your gateway configuration - please review changes.

Note: This action does not enable the WS-M Agent on IDG. For security reasons, this can only be done from IDG.

Setup Certificate Monitor for gateway

The Certificate Monitor is used to provide alerts before certificate expiration available on expired certificate dashboard. Each gateway must be configured (at the gateway level) to enable certificate expiry alerts.

This configuration should be executed once after installing the system.

Consult the System Parameters List ("Certificate monitoring duration in days") for information regarding the time interval parameter.

Note: This action changes your gateway configuration - please review changes.

Settings Tab

The DevOps Services Portal settings allow configuring this gateway for the DevOps Services Portal. See DevOps Portal Setup and Customization for more information.

 

For each device, the user can define whether the device is displayed in the System Health dashboard, Damage Points Threshold and Total Warnings Threshold. See System Health for more information.

  • Damage Points Threshold - number of damage points that defines the device to be in an Error state

  • Total Warnings Threshold - total warnings that defines the device to be in an Error state

In addition, the user can set thresholds and damage points per health metric. Thresholds can be set only for metrics that support thresholds (such as Frequency or Flat-Line).

Domain Services Tab

Click on one of the domains in the Domains tab to list the services in this domain. Click on a service to display basic information about that service.

Domain Setup Tab

You can use specific domain level configuration in the following cases:

  1. Your architectural design dictates a different configuration for domains on the same gateway.

  2. You want to enable WS-M and syslog collection only for specific domains. 

Click on one of the domains in the Domains tab to set up that domain.

The following sections are available:

Section

Details

Section

Details

Setup Syslog

Sets up the necessary configuration for this domain to send domain-level Syslog records to the selected agent.
This configuration should be executed once after installing the system, or when the domain-level Syslog messages need to be redirected to a different agent.
To setup the log targets for this domain, select a Syslog Agent from the drop-down list, select analysis level from the drop-down list, and click the Setup Syslog button.

You can disable/enable this Syslog log target by clicking on the "Domain Syslog Status" Enabled/Disabled buttons.

Note: This action changes your gateway configuration - please review changes.

Setup WS-M

Sets up the necessary configuration for all the domains to send payload data to the selected agent.
This configuration should be executed once after installing the system, when a new domain is created or when the payloads need to be redirected to a different agent.

Clicking the "Record Payload" link will take you to the Payload Capture page, where you can start a WS-M subscription.

Note: This action changes your gateway configuration - please review changes.

Note: This action does not enable the WS-M Agent on IDG. For security reasons, this can only be done from IDG.

 

 

IBM DataPower Operations Dashboard (DPOD) v1.0.15.0