Versions Compared

Version Old Version 32 New Version Current
Changes made by

Assaf Cohen (Deactivated)

Sara Weisz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Before You Begin

Before adding new monitored devices to DPOD, you may backup the objects that the 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 DPODs IDG related configurationBefore you add a new monitored device to DPOD, ensure to perform the following:

  1. Check routing and access from a monitored device:
    The DataPower Gateway needs to route packets to DPOD Agents through the desired interface. Validate through the DataPower's [control panel->Troubleshooting->TCP Connection Test]
  2. Log-in to DPOD Web Console

Device Level Configuration

...

Warning

Adding a device with a locale other than EN may cause some DPOD features to not work as expected

...

make sure to Prepare your Monitored Devices.

Adding a Gateway to DPOD

Inside DPOD's Web Console, navigate to

...

the gateways page [Manage → Topology → Gateways] and click on “New”.

Info

If you wish to add a gateway tenant device, please review the “partial support for tenant feature” section in the Known Limitations page.

Enter the following information:

Field

Description

Name

The gateway name in DPOD (must be identical to the System Identifier

...

of the gateway).
It must meet the requirements detailed in 

...

Are there any restrictions when defining the DataPower "System Identifier"?.
If you wish to add a

...

gateway tenant device, enter the landlord's name

...

. DPOD will display the tenant's name as tenant@landlord.

...

Info

When updating the "Log Target Source Address" after the device was added and syslog was setup for the device , the user must setup the syslog for device again in order for the change to take effect on the monitored device (see next item "Setup Syslog For The New Monitored Device" ).

Configure The New Monitored Device

  1. Inside DPOD's Web Console, navigate to the devices list page [Manage->Devices->Monitored Devices]
  2. Click the name of the device you added in the previous step
  3. Click "Setup”s this do? how is this now 'configured'? are the following sections 'inside'?

Setup Syslog For The New Monitored Device

  1. Under "Syslog Setup for Device", select the correct Syslog Agent according to the architecture design, click "Setup Syslog for device" and wait until the action completes successfully.
    Image Removed 

Syslog setup for all domains

  1. Under "Syslog Setup for All Domains", select the correct Syslog Agent according to the architecture design, click "Setup Syslog for all domains" and wait until the action completes successfully.

Image Removed 
diagram to new-name

Tip
titlePerformance

Domains may be redirected to different Syslog agents according to the architecture design. If this is the case, set up each domain separately as documented below

Auto Setup Domains (Optional)

This feature will automatically detect and setup new domains created on the monitored device. This is especially useful for dynamically created API Connect domains.
Select a Syslog agent that the domains should report to, enter the domain pattern (use asterisk as wildcard) and click save.
DPOD will scan the monitored devices every 2 minutes and will setup the new domain. You may change the scan interval on the system parameters page. (A UI service restart is required after changing this interval)
For domains that match the auto setup pattern - DPOD will also try to detect if any domain was reset and setup it again.

Image Removed

...

Under "Domains WS-M Setup", select the correct WS-M Agent according to the architecture design. Click "Setup WS-M” and wait until the action completes successfully.
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

Image Removed

Extended Transaction setup (Optional)

Under "Extended Transaction Setup", click "Setup Extended Transaction for Device” and wait until the action completes successfully.

Warning

This step will MODIFY SERVICES PROCESSING POLICY. You must test and verify that the services are not affected by this change before setting this up on production environments.

Image Removed

Tip

This feature can be used at a service or domain level.

Certificate Monitor (Optional)

Under "Certificate Monitor", click "Setup Certificate Monitor for Device” and wait until the action completes successfully.
Consult the System Parameters List for information regarding the time interval parameter.

Image Removed

...

Configuring a specific domain (Optional)

  1. Navigate to the domain setup page  [Manage→ Devices→ Monitored Devices]
  2. Click the device name
  3. Click the domain name
  4. Click "Setup”
     
Tip

Domains may be redirected to different Syslog agents according to the architecture design. Additionally, you may choose to enable WS-M on specific domains only etc. If this is required, follow the steps below to configure specific domains. Otherwise you may skip this section

Syslog setup (Optional)

Under "Syslog Setup", select the correct Syslog Agent according to the architecture design, click "Setup Syslog" and wait until the action completes successfully.

WS-M setup (Optional)

Select the correct WS-M Agent according to the architecture design. Click "Setup WS-M” and wait until the action completes successfully.
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)

Under "Extended Transaction Setup for All Services", click "Setup Extended Transaction for all services” and wait until the action completes successfully.

...

Host Address

IP Address used to access the gateway.
If you wish to add a gateway tenant device, enter the tenant's host.

SOMA port

The SOMA port configured on this gateway.
If you wish to add a gateway tenant device, enter the tenant's SOMA port.

SOMA User Name

The user name used to access the monitored devices via SOMA.

SOMA Password

The password of the user name used to access the monitored devices via SOMA.

Log Target Source Address

IP Address of the gateway's log target source.
This should be the IP address of the ethernet interface of the gateway from which Syslog records should be sent to DPOD.
Usually, this IP address is the same as the IP address used for the Host field mentioned above, unless the gateway is in a different network than DPOD (e.g behind NAT).
If link aggregation interface is configured in the gateway, you may define its IP address as the log target source address to take advantage of the link aggregation benefits when sending Syslog records to DPOD.

Device Resources Monitoring

Whether Device resources monitoring is enabled on this gateway.
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.

Service Resources Monitoring

Whether Service resources monitoring is enabled on this gateway.

Once you click the Add button, DPOD will make sure it can connect to the monitored device and if successful, the gateway will be added to DPOD as a new monitored device.

Info

Each monitored gateway needs to be configured to send information to DPOD after added to DPOD. To configure the gateway, see Configuring Monitored Devices.