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. |
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).
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 |
...
Parameter | Category | Default | Description |
---|---|---|---|
Internal Alerts - Check Agents Interval in Seconds | Health | 300 | How often to check if whether DPOD's syslog and WS-M agents are up and working |
Internal Alerts - Check Derby Interval in Seconds | Health | 300 | How often to check if whether DPOD's internal database is up and working |
Internal Alerts - Check Dropped Syslogs Interval in Seconds | Health | 600 | How often to check if whether DPOD's syslog agents lost incoming messages |
Internal Alerts - Check Dropped WS-M Messages Interval in Seconds | Health | 600 | How often to check if whether DPOD's WS-M agents lost incoming payloads |
Internal Alerts - Check ES Interval in Seconds | Health | 300 | How often to check if whether DPOD's big data component is up and working |
Internal Alerts - Check File System Interval in Seconds | Health | 300 | How often to check if whether DPOD's filesystem is out of space |
Internal Alerts - Check Retention Interval in Seconds | Health | 300 | How often to check if whether DPOD's internal big data retention process is working |
Internal Alerts - Send Email on Alert | Health | false | Whether or not to send an Email when a problem was detected by the internal health monitoring |
Internal Alerts - Email Destination Address for Alerts | Health | No Default | Destination Email address for sending internal health alerts |
Internal Alerts - Send Syslog on Alert | Health | false | Whether or not to send a Syslog message when a problem was detected by the internal health monitoring |
Interval in Seconds to Sample Logging Targets | Health | 300 | How often to sample the DPOD's log targets in the monitored devices |
Interval in Seconds to Sample Nodes Health Statistics | Health | 300 | How often to collect statistics on DPOD's big data nodes |
Interval in Seconds to Monitor Objects Status | Health | 300 | How often to monitor enabled but down objects in the monitored devices |
Object Status Monitor Should Only Check Common Object Classes | Health | true | By default, the Failed Objects dashboard (under the "explore" menu) will display displays only common object classes, |
Interval in Seconds to Sample WSM Agents Statistics | Health | 300 | How often to sample WS-M Agents in the monitored devices |
...
DPOD automatically creates a service configuration wiki for all monitored devices. DPOD collects configuration and transactional data, and when a configuration change was made (e.g. a new service was created) it sends a JSON file with all its configuration details to a wiki update service.
The parameters below determine where JSON requests are sent and some of their data.
Parameter | Category | Default | Description |
Wiki Default New Service Contact Mail | Wiki | 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, Note: This is for future use - Currently only v1 applies. |
Wiki URL | Wiki | URL of the wiki update service |
Consult Update Wiki service JSON (Deprecated) and its sub-sections JSON fields and JSON sample for detailed information about the wiki and JSON usage.
...