Before You Begin

Before you add a new monitored device to DPOD, ensure to perform the following:

1. You may backup the objects that DPOD will alter during the configuration phase, such as the XML management interface, the WS-M agent, etc.
   For detailed information regarding IDG DPOD related objects backup and restore see Backing Up and Restoring DPOD IDG Related Configuration.
2. Check network routing and access from the monitored device.
   The DataPower Gateway needs to route packets to DPOD agents through the desired interface. You may validate this through the DataPower Web GUI: [Control panel → Troubleshooting → TCP Connection Test]
3. Make sure the device locale is set to EN. Adding a device with a locale other than EN may cause some DPOD features to not work as expected.

Add the Device to DPOD

1.  Inside DPOD's Web Console, navigate to the gateways page [Manage → Devices → Gateways] and click on “New”.
   
   
2. Enter the required information (consult Device Management for details):

   1. The device name must be identical to the System Identifier/Appliance Name of the DataPower Gateway as set in the Gateway itself.
      It must meet the requirements detailed in http://www-01.ibm.com/support/docview.wss?uid=swg21668456.

   2. If you wish to add a Tenant device, enter the landlord's name but use the tenant's SOMA host and port. DPOD will display the tenant's name as tenant@landlord.
   3. It is highly recommended to enable device resources monitoring. Disabling it will cause this device's health to be missing in System Health dashboard, as well as provide unexpected results in dashboards, reports and alerts that are based on this data.
3. Click “Add”
   
   

Configure the New Monitored Device

Right after adding the device, the "Setup" tab will be displayed, the tab is divided into six parts.

wing sections 'inside'?

1. Device Syslog Agent - select the desired Syslog Agent according to the architecture design, click "Setup Syslog" and wait until the action completes successfully.
   
   

2. Domains Syslog Agent

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

   Select the desired Analysis Level, select the Syslog agent according to the architecture design and click "Setup Syslog". The operation may take a few minutes.
   
   

3. Auto Setup Domains (Optional)
   This feature will automatically detect and setup new domains created on the gateway. This is especially useful for dynamically created API Connect domains.
   Select a Syslog agent that the domains should report to, select the desired Analysis Level, enter the domain pattern (you may use asterisk as wildcard) and click save.
   DPOD will scan the monitored devices every 2 minutes and will setup the new domain.
   For domains that match the auto setup pattern - DPOD will also try to detect if any domain was reset and setup it again.
   
   

4. Domains WS-M Setup (Optional)
   

   This section will apply the same setup too all domains in the device, to select a different configuration for each domain, see the section "Domain Level Configuration" later on this page.

   If you wish to record and view payloads, or to record API-C policy variables, select the desired WS-M Agent according to the architecture design and click "Setup WS-M”, the operation may take a few minutes.
   For supported WS-M payload capture services see IDG WS-M Payload Capture Support.
   Click on "Record Payload" to open the payload capture page where you can start capturing payloads
   
   

5. Certificate Monitor Setup (Optional)
   If you wish to use DPOD's expired certificate dashboard, click on "Setup Certificate Monitor" .
   Consult the System Parameters List ("Certificate monitoring duration in days") for information regarding the time interval parameter.
   
   

6. Extended Transaction Setup (Deprecated)
   This feature is deprecated and was replaced by a non-intrusive method.
   Please do not use this feature unless advised by L2/L3 support.

Domain Level Configuration (Optional)

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. 

Switch to the "domains" tab, a list of all domains will be retrieved from the gateway, click on the domain you wish to setup.

Syslog setup (Optional)

Select the desired Analysis Level, select the desired Syslog Agent according to the architecture design and click "Setup Syslog".

Domain WS-M setup (Optional)

Select the desired WS-M Agent according to the architecture design and click "Setup WS-M”.
For supported WS-M payload capture services see IDG WS-M Payload Capture Support.
Click on "Record Payload" to open the payload capture page where you can start capturing payloads

Extended Transaction setup for all services (Optional, Deprecated)

This feature is deprecated and was replaced by a non-intrusive method.
Please do not use this feature unless advised by L2/L3 support.