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 these parameters in detail.
...
The Appliance Maintenance (Backup, Sync and Firmware upgrade) system parameters are listed on a separate page.
APM
| Parameter | Category | Default Value | Description |
|---|---|---|---|
| APM Integration Syslog App Name | APM Integration | DPOD-MSC1 | Logical name used by APM to indentify DPOD. |
| APM Integration Target Syslog Host | APM Integration | 172.77.77.7 | APM's IP address or hostname |
| APM Integration Target Syslog Port | APM Integration | 60030 | APM's listening port |
| APM Integration Target Syslog Protocol | APM Integration | tcp | APM's listening protocol for Syslog |
| APM Integration Target Syslog SSL | APM Integration | false | Is conncetion secured? |
| APM Integration Events Publishing Enable | APM Integration | true | Activate / Disable integration between DPOD and APM installation. |
...
| Parameter | Category | Default Value | Description |
|---|---|---|---|
| Enable Queries Emails SMTP | Alerts | true | Enable / Disable publishing alerts via SMTP server |
| Enable Queries Emails SMTP WS | Alerts | false | Enable / Disable publishing alerts via Web Service |
| Fields to Ignore in ElasticSearch Response in Alerts | Alerts | doc_count_error_upper_bound,sum_other_doc_count | Field to omit from alert description |
| Enable Queries Output File | Alerts | false | Enable / Disable publishing alerts as file in local file system |
| Syslog Severity Field Value | Alerts | info | Syslog record message level. Possible values: debug, info, notice, warning, err, crit, alert, emerg |
| Alerts Syslog Server Hostname | Alerts | Syslog server hostname or IP address. | |
| Alerts Syslog Server Port | Alerts | Syslog server listening port. |
...
| Parameter | Category | Default Value | Description |
|---|---|---|---|
| System Health Dashboard Sample Time Range (min.) | Device Health | 5 | See "Device Health Calculation" in System Health |
Reports
The following parameters determine DPOD's reporting behaviorFor more information see reports or configuring sending reports in mail.
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. (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.
|
For more information see reports or configuring sending reports in mail.
Emails and SMTP (For report publishing, alerts, share, maintenanace plans etc)
When sending notifications via SMTP or SMTP WS. , the following parameters determine how those notifications are sent.
When SMTP or SMTP-WS is selected as the reporting behavior, all parameters relating this behavior must be provided. See reports for more information.
Parameter | Category | Default Value | Description | |
|---|---|---|---|---|
From Address | from@example.com | The from address used for the report email. | ||
SMTP Host | Email SMTP | smtp.example.com | Destination SMTP host | |
SMTP Password | Email SMTP | ******** | Password for logging in to the SMTP host. If no authentication required leave this field empty. | |
SMTP Port | Email SMTP | 465 | Destination SMTP host port | |
SMTP User | Email SMTP | mailer@example.com | Username for logging in to the SMTP host. If no authentication required leave this field empty. | |
| SMTP SSL Enabled | Email SMTP | true | Enable / Disable TLS/SSL | |
SMTP WS Endpoint URI | Email SMTP WS | /SMTPSender | Destination URI for sending reports via Web-Service | |
SMTP WS Host | Email SMTP WS | localhost | Destination hostname for sending reports via Web-Service | |
SMTP WS Port | Email SMTP WS | 8080 | Destination port for sending reports via Web-Service | |
SMTP WS Protocol | Email SMTP WS | HTTP | Protocol for accessing the Web-Service host Valid values: HTTP / HTTPS | |
SMTP WS User | Email SMTP WS | user | User used for sending reports via Web-Service. This value is sent using HTTP Basic Authentication. | |
SMTP WS Password | Email SMTP WS | ******** | Password used for sending reports via Web-Service. This value is sent using HTTP Basic Authentication. | |
...
LDAP
The following parameters control configuration and connection to an LDAP registry, used for role-based security.
...
Parameter | Category | Default Value | Description |
|---|---|---|---|
| Enable LDAP | LDAP | false | See LDAP Configuration Script |
| LDAP Connection URLs | LDAP | See LDAP Configuration Script | |
| Enable LDAP Host Name Verification | LDAP | true | See LDAP Configuration Script |
LDAP Connection Name (DN) | LDAP | ||
LDAP Connection Password | LDAP******** | ||
LDAP Referral (ignore/follow) | LDAP | ignore | See LDAP Configuration Script |
| LDAP User Search Base | LDAP | See LDAP Configuration Script | |
| LDAP User Search Filter | LDAP | See LDAP Configuration Script | |
LDAP User Name Attribute Name | LDAP | ||
| LDAP Group Search Base | LDAP | See LDAP Configuration Script | |
| LDAP Group Membership Search Filter | LDAP | See LDAP Configuration Script | |
LDAP Group Membership Search Nested | LDAP | true | |
| LDAP Group Name Search Filter | LDAP | true | |
LDAP Group Name Attribute Name | LDAP | cn |
...
The following parameters control authentication of monitored DataPower Gateways.
When DPOD collects data from monitored devices, it verifies that these are the correct devices using TLS; The DataPower certificate is authenticated against DPOD’s CA trust store, specified below.
Parameter | Category | Default Value | Description |
|---|---|---|---|
| Certificate Monitoring Duration in Days | Security | 60 | DataPower Gateways are able to send an alert a configurable number of days before certificates are about to expire. DPOD leverages this ability in the certificate monitoring screens. When a new monitored device is added to DPOD, the value in this parameter is copied to the corresponding parameter on the device. This value does not affect already-monitored devices. If you wish to change this in previously added devices, you need to do so manually. |
| Local User Registry Enabled | Security | false (for new installations v1.0.7+) true (when upgrading from v1.0.6) | When disabled, DPOD will not store any new user details in local repository to comply with Security complaince requirements (DPOD will not automatically delete any existing user details after changing the value of this parameter) |
TLS Level (TLSv1/TLSv1.1/TLSv1.2) | Security | TLSv1.2 | TLS level used to perform authentication |
CA Trusted Keystore Password | Security | ******** | Trust store password |
CA Trusted Keystore Full Path and Filename | Security | /app/java/jre/lib/security/cacerts | Trust store full path |
CA Trusted Keystore Type (JKS/PKCS12) | Security | JKS | Trust store type |
...
Configuration Changes Tracking
DPOD collects data about DataPower configuration changes from its monitored devices. It does this by pulling the complete configuration from the device, and comparing it to the last collected configuration. The parameters below control this mechanism.
Consult the table on System Services Management for more information about the types of agents in DPOD and the information they collect.
Parameter | Category | Default Value | Description |
|---|---|---|---|
Show Service Configuration Changes in Human Readable Form | ServiceConfig | true | whether to see only the property name that changed or all the xml(which is hard to understand) |
Interval in Hours to Compress Service Configuration Table | ServiceConfig | 24 | For internal use, do not change unless instructed to do so by product support. |
...
. |
Console UI Appearance
These parameters control the way data is displayed in DPOD's Console UI.
Parameter | Category | Default | Description |
| Default CSV Date Format | Style | yyyy/MM/dd HH:mm:ss.SSS | Full date format |
Default Full Date Format | Style | MM/dd/yyyy HH:mm:ss.SSS | Full date format |
Default Date Format with no Millis | Style | MM/dd/yyyy HH:mm:ss | Full date format, without milliseconds |
Default Date Format with no Year | Style | MM/dd HH:mm:ss.SSS | Full date format, without year |
Default Short Date Format | Style | MM/dd/yyyy | Short date format |
Default Theme (light/dark/elegant) | Style | Light | Light, dark or elegant theme of the console UI screens |
Internal Health
...
| Parameter | Category | Default | Description |
|---|---|---|---|
| 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 |
| Internal Alerts - Send Email on Alert via Web Service | Health | false | Whether or not to send an Email via Web Service when a problem was detected by the internal health monitoring |
| Object Status Monitor Class List (All, Default or a Custom List) | Health | Default | By default, the Failed Objects dashboard (under the "explore" menu) displays only common object classes, |
...
| Parameter | Category | Default | Description |
|---|---|---|---|
| Enable Api-Stats Category Mode | Transactions | false | |
| Allow Monitoring Transactions in Default Domain | Transactions | false | Whether or not the "Support TX in the Default Domain" box will be displayed in the Monitored Devices→Setup page |
| Show Custom Transaction View Selection | Transactions | false | Whether or not the "Custom TX View" checkbox will be displayed in the Product Views |
| Default Transactions Source (syslog/logical) | Transactions | syslog | If the "Custom TX View" is displayed, what will be the default for users on their first sign in. |
| Logical Transaction, Custom String 1 Table Header | Transactions | Custom String 1 | The Table Header and Filter names for "Custom String 1" in the transactions page |
| Logical Transaction, Custom String 2 Table Header | Transactions | Custom String 2 | The Table Header and Filter names for "Custom String 2" in the transactions page |
| Transaction Analysis Level - User Override Path | Transactions | (blank) | Where to take the user override file for the syslog analysis message groups, no value (blank) means there is no override file |
| Transaction Analysis Level - Max TPS | Transactions | Core, MemoryReqRes, B2B, error | The message group names and log level for the Max TPS analysis level, |
| Transaction Analysis Level - More TPS | Transactions | Core, MemoryReqRes, B2B, notice | The message group names and log level for the More TPS analysis level, The last parameter must be a valid log level name (debug, info, notice, warn. error, critic). The values must be comma separated, lower, upper or mixed case are allowed. |
| Transaction Analysis Level - Balanced | Transactions | Core, MemoryReqRes, B2B, MemActionLevel, notice | The message group names and log level for the Balanced analysis level, The last parameter must be a valid log level name (debug, info, notice, warn. error, critic). The values must be comma separated, lower, upper or mixed case are allowed. |
| Transaction Analysis Level - More Data | Transactions | Core, MemoryReqRes, B2B, MemActionLevel, ReqPayloadSize, ExtLatency, info | The message group names and log level for the More Data analysis level, The last parameter must be a valid log level name (debug, info, notice, warn. error, critic). The values must be comma separated, lower, upper or mixed case are allowed. |
| Transaction Analysis Level - Max Data | Transactions | Core, MemoryReqRes, B2B, MemActionLevel, ReqPayloadSize, ExtLatency, Sidecalls, info | The message group names and log level for the Max Data analysis level, The last parameter must be a valid log level name (debug, info, notice, warn. error, critic). The values must be comma separated, lower, upper or mixed case are allowed. |
Size of next/previous transaction results | Transactions | default | The size of next/previous transaction results. The default is the size of the transactions list page from where the user clicked on the transaction ID link. |
Miscellaneous Parameters
The following parameters control various other functions.
...