Versions Compared

Key

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

IBM DataPower Operations Dashboard contains an extensive set of parameters that let administrators fine-tune the system's behavior to the installation requirements.
The following sections describe those these parameters in detail. 

The parameters are accessible through the System Parameters page: [Manage->System→System Parameters].

Reports

These The following parameters determine DPOD's reporting behavior.

Parameter

Category

Default Value

Description

Enable Reports Emails SMTP *

Reports

true

Enables sending reports via SMTP

Enable Reports Emails SMTP WS *

Reports

false

Enables sending reports via a Web-Service

Enable Reports Output File *

Reports

false

Enables writing reports to a local file-system. By default (Defaults to /data/reports)

Fields to ignore in ElasticSearch response

Reports

doc_count_error_upper_bound,sum_other_doc_count

For internal use, do not change unless instructed to do so by product support.

  

...

Reports publishing

When sending the reports via SMTP or SMTP WS. the following parameters determine how those reports are sent.

When the SMTP or SMTP-WS is selected as the reporting behavior, all parameters relating this behavior must be provided.

...

The following parameters control configuration and connection to LDAP, used for role-based security.

When All parameters below are mandatory when enabling LDAP role-based security (by switching on the Enable LDAP parameter), then all parameters below are mandatory.
If LDAP RBM is disabled, all these parameters should be left blank.

Parameter

Category

Default Value

Description

LDAP Connection Name (DN)

LDAP

 

Username for connecting to the LDAP server (sometimes called “bind user”)

LDAP Connection PASSWORD

LDAP

 

Password for connecting to the LDAP server

LDAP Connection URL (ldap://IP:Port)

LDAP

 

Connection URL to connect to the LDAP server

Enable LDAP

LDAP

false

Whether the LDAP RBM is enabled.
Valid Values: true / false

LDAP Group Base Entry (e.g. OU)

LDAP

 

The top-most level of the LDAP hierarchy. Searching for LDAP groups starts from this point downward.

Ensure your the user configured above is authorized to connect to this point in the LDAP hierarchy.

LDAP Group Name Attribute

LDAP

 

LDAP Group Name Attribute

LDAP Group Search Filter ({0} - Authenticated User Name, {1} - Authenticated User DN)

LDAP

 

The LDAP filter expression to use when searching for a group's directory entry

 

LDAP Referral (ignore/follow)

LDAP

ignore

Define handling of JNDI referrals (see javax.naming.Context.REFERRAL for more information).
Valid values are:

  • ignore
  • follow
  • throw

Microsoft Active Directory often returns referrals. Set this parameter to follow If your installation is required to follow them.

Caution: if your DNS is not part of AD, the LDAP client lib might try to resolve your domain name in DNS to find another LDAP server.

LDAP User Base Entry (e.g. OU)

LDAP

 

The top-most level of the LDAP hierarchy. Searching for LDAP users starts from this point downward.

Ensure your the user configured above is authorized to connect to this point in the LDAP hierarchy.

LDAP User Search Filter ({0} - User Name)

LDAP

 

The LDAP filter expression to use when searching for a user's directory entry

...

ParameterCategoryDefaultDescription
Internal Alerts - Check Agents Interval in SecondsHealth300How often to check if whether DPOD's syslog and WS-M agents are up and working
Internal Alerts - Check Derby Interval in SecondsHealth300How often to check if whether DPOD's internal database is up and working
Internal Alerts - Check Dropped Syslogs Interval in SecondsHealth600How often to check if whether DPOD's syslog agents lost incoming messages
Internal Alerts - Check Dropped WS-M Messages Interval in SecondsHealth600How often to check if whether DPOD's WS-M agents lost incoming payloads
Internal Alerts - Check ES Interval in SecondsHealth300How often to check if whether DPOD's big data component is up and working
Internal Alerts - Check File System Interval in SecondsHealth300How often to check if whether DPOD's filesystem is out of space
Internal Alerts - Check Retention Interval in SecondsHealth300How often to check if whether DPOD's internal big data retention process is working
Internal Alerts - Send Email on AlertHealthfalseWhether or not to send an Email when a problem was detected by the internal health monitoring
Internal Alerts - Email Destination Address for AlertsHealthNo DefaultDestination Email address for sending internal health alerts
Internal Alerts - Send Syslog on AlertHealthfalseWhether or not to send a Syslog message when a problem was detected by the internal health monitoring
Interval in Seconds to Sample Logging TargetsHealth300How often to sample the DPOD's log targets in the monitored devices
Interval in Seconds to Sample Nodes Health StatisticsHealth300How often to collect statistics on DPOD's big data nodes
Interval in Seconds to Monitor Objects StatusHealth300How often to monitor enabled but down objects in the monitored devices
Object Status Monitor Should Only Check Common Object ClassesHealthtrue

By default, the Failed Objects dashboard (under the "explore" menu) will display displays only common object classes,
set this option to false to make it sample all object classes in the monitored devices

Interval in Seconds to Sample WSM Agents StatisticsHealth300How often to sample WS-M Agents in the monitored devices

...

Parameter

Category

Default

Description

Wiki Default New Service Contact Mail

Wiki

changeme@example.com

This value is configured as the service contact email when a new service is created

Wiki Default New Service Contact Name

Wiki

Contact Name

This value is configured as the service contact name when a new service is created

Wiki Default New Service Contact Phone

Wiki

+0-(000)-000-0000

This value is configured as the service contact phone number when a new service is created

Wiki Push REST Password

Wiki

 

Password for logging in to the REST service which updates the wiki

Wiki Push REST User

Wiki

MS

Username for logging in to the REST service which updates the wiki

Wiki Push REST API Version

Wiki

v1

Determines the WS request format version of the requests sent to the wiki portal. Manipulating this value can be used for backwards compatibility,
in cases when DPOD was updated but you still want to receive the older version format.

Note: This is for future use - Currently only v1 applies.

Wiki URL

Wiki

https://127.0.0.2/wiki/

URL of the wiki update service

...