IBM DataPower Operations Dashboard v1.0.12.0

A newer version of this product documentation is available.

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

Device Management

Owned by Copy Page Tree
Last updated: Dec 22, 2019 by Assaf Cohen (Deactivated)
7 min read

The Gateways section under [Manage→Devices] provides access to the set of gateways monitored by DPOD. 

This step changes or add some of you monitored gateway objects. Please review the list of changes before you continue too perform this actions.

Gateways

This screen displays a table containing information on all the monitored gateways connected to DPOD's console, and lets an administrator perform several configuration tasks, at a gateway, domain or service level.
Each row in the table contains the following details about a single gateway (This information relates to the information entered when Adding Monitored Devices):

ColumnDescription
NameThe gateway name in DPOD
HostIP Address of the gateway
SOMA portThe SOMA port configured on this gateway
Log Target Source IP Address of the gateway's log target source
Device Resources MonitoringWhether Device resources monitoring is enabled on this gateway
Service Resources MonitoringWhether 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.

Gateway Level Configuration

The following steps let an administrator perform gateway-level configuration tasks:

  1. Click on one of the monitored gateways in the Monitored Devices table.
    The system displays the gateway details, and a list of all the domains on that gateway.
  2. Click the Setup link (found at the top of the table, next to the label ‘Domains’)
    The system displays a list of administrator tasks available for this gateway. Consult the tables at the end of this page to find details about the available tasks.

Domain Level Configuration

The following steps let an administrator perform domain-level configuration tasks:

  1. Click on one of the monitored gateways in the Monitored Gateways table. 
    The system displays the gateway details, and a list of all the domains on that gateway.
  2. Click on one of the domains to select it.
    The system displays the domain's details and a list of all services running on the selected domain.
  3. Click the Setup link (found at the top of the table, next to the label ‘Services’)
    The system displays a list of administrator tasks available for this domain. Consult the tables at the end of this page to find details about the available tasks.

Service Level Configuration

The following steps let an administrator perform service-level configuration tasks:

  1. Click on one of the monitored gateways in the Monitored Gateways table. 
    The system displays the gateway details, and a list of all the domains on that gateway.
  2. Click on one of the domains to select it.
    The system displays the domain's details and a list of all services running on the selected domain.
  3. Click on one of the services.
    The system displays the service's details and a list of all endpoints in the service
  4.  Click the Setup link (found at the top of the table, next to the label ‘Endpoints’)
    The system displays a list of administrator tasks available for this service. Consult the tables at the end of this page to find details about the available tasks.



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

Available Tasks (Operations)

Gateway Level Operation Details

The following tasks are available for gateway setup.

If you wish to monitor transactions in the default domain, please follow the instructions in this page.

Task (Operation)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 target by clicking on the "Device Syslog Status" Enabled/Disabled buttons.

Limitation: DPOD does not support transactions in the default domain. See /wiki/spaces/MS/pages/9306256.

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.

Limitation: DPOD does not support more than 125 domains per gateway. See /wiki/spaces/MS/pages/9306256 .

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 2 minutes and will setup the new domain (you can change the interval from the system parameters page. A UI service
restart is required after changing this interval)

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.

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. Each gateway must be configured (at the gateway level) to enable certificate expiry alerts.
This configuration should be executed once after installing the system.

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

Setup Extended Transactions for device

This option was deprecated and was replaced by a non-intrusive method, please do not use it unless advised by L2/L3 support.

Extended Transactions are used to track cross-machine transactions, i.e. messages which are forwarded from one monitored DataPower Gateway to another.
To use Extended Transactions, the gateways must be configured (at gateway level). Extended transactions can be configured through the Web Console.

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

This step changes some of your monitored device objects. Please review the list of changes before you continue with this action.

Domain Level Operation Details

The following tasks are available for domains setup.

Task (Operation)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 Syslog for a domain, select a Syslog Agent from the drop-down list, and click the Setup Syslog button.

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

Note: This action changes your device 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 device configuration - please review changes .

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

Setup Extended Transactions for all services

This option was deprecated and was replaced by a non-intrusive method, please do not use it unless advised by L2/L3 support.

Extended Transactions are used to track cross-machine transactions, i.e. messages which are forwarded from one monitored DataPower Gateway to another.
Choosing this option will enable support for extended transactions for services on this domain. This is performed by adding a new step to all the services, which inserts the Extended Transaction correlation ID into the message header. DPOD uses this correlation ID to track the extended transactions.

This configuration should be executed once after installing the system (either at a service or a domain level), or when you need to add extended transaction support for services in the domain. If extended transactions were previously enabled for some of the services in this domain, executing this will add the new step to new services only - the previously configured services will be unaffected.

Note: This action is intrusive and changes your service configuration and may require manual rollback - please review changes .

This step changes some of your monitored gateway objects. Please review the list of changes before you continue with this action.

Service Level Operation Details

The following task is available for services setup.

Task (Operation)Details
Setup Extended Transactions

This option was deprecated and was replaced by a non-intrusive method, please do not use it unless advised by L2/L3 support.

Extended Transactions are used to track cross-machine transactions, i.e. messages which are forwarded from one monitored DataPower Gateway to another.
Choosing this option will enable support for extended transactions for the service. This is performed by adding a new step to the service, which inserts the Extended Transaction correlation ID into the message header. DPOD uses this correlation ID to track the extended transactions.

This configuration should be executed once after installing the system (either at a service or a domain level), or when you need to add extended transaction support for services in the domain. Executing this again for a service that has already been enabled for extended transactions will not change its state.

Note: This action is intrusive and changes your service configuration and may require manual rollback - please review changes .

IBM DataPower Operations Dashboard (DPOD) v1.0.12.0