IBM DataPower Operations Dashboard v1.0.22.x
A newer version of this product documentation is available.
You are viewing an older version. View latest at https://ibm.biz/dpod-docs.
System Parameters List
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 parameters are accessible through the System Parameters page: [Manage → Customize → System Parameters].
Appliance Maintenance
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. |
Alerts
Parameter | Category | Default Value | Description |
|---|---|---|---|
Enable Alerts Emails SMTP | Alerts | true | Enable / Disable publishing alerts via SMTP server |
Enable Alerts Web Service | 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. |
Alerts Syslog Server Hostname | Alerts | Syslog server hostname or IP address. | |
Alerts Syslog Server Port | Alerts |
| Syslog server listening port. |
Alerts HTTP Headers | Alerts |
| Static HTTP headers that are added to all alerts (e.g.: "Authorization: ****", "User-Agent: abc", etc.). |
Alerts HTTP Aggregated Request | Alerts | true | Alerts can be sent as single HTTP requests (a single alert per HTTP request) or as aggregated requests (all alerts that were generated from the same execution will be sent in a single HTTP request as an array of alerts). |
Alerts HTTP URL | Alerts |
| URL (supported protocols are HTTP and HTTPS) which will be used as the endpoint for the alert HTTP request. The request will be a POST request. |
Alerts JSON Additional Fields | Alerts |
| Static fields (of type String) that are added to all alerts (e.g.: "systemId": "dpod-system-123"). |
Alerts JSON Fields Rename | Alerts |
| Allows renaming fields (e.g.: rename "description" to "details"). |
Dashboards
Parameter | Category | Default Value | Description |
|---|---|---|---|
IDG Transactions Page Columns | Dashboards | Transaction ID, Service Name, Operation, Time, Device, Domain, Status, Client IP, Global Transaction ID, Elapsed, Payload | Controls which columns will appear in the Investigate->Transactions Page, you can omit or reorder the columns. |
IDG Raw Message Page Columns | Dashboards | Transaction ID, Device, Domain, Category, Severity, Time, Direction, Object Type, Object Name, Client IP, Message Code, Message | Controls which columns will appear in the Investigate→Raw Messages Page, you can omit or reorder the columns. Possible values (not case sensitive): |
APIC Transactions Page Columns | Dashboards | Transaction ID, Time, Device, Catalog Name, Space Name, Product, Plan Name, API Name, API Version, APP Name, Method, URI, HTTP Res. Code, Client IP, Elapsed, Payload | Controls which columns will appear in the APIC Investigate->Transactions Page, you can omit or reorder the columns. Possible values (not case sensitive): |
Service URI Dashboard Percentiles (3 comma separated decimals) | Dashboards | 90.0, 95.0, 99.0 | Controls the percentiles shown in the rightmost columns of the Service URI Calls page and the API URI calls page, enter decimal values between 0-99.9 |
Service URL Dashboard Percentiles (3 comma separated decimals) | Dashboards | 90.0, 95.0, 99.0 | Controls the percentiles shown in the rightmost columns of the Service URL Calls page and the API URL calls page, enter decimal values between 0-99.9 |
API-C Policies Dashboard Percentiles (3 comma separated decimals) | Dashboards | 90.0, 95.0, 99.0 | Controls the percentiles shown in the rightmost columns of the API Policies page, enter decimal values between 0-99.9 |
APIC Recent Activity Page Latency Percentile | Dashboards | 90.0 | Controls the percentile shown in the APIC Recent Activity page, enter a decimal value between 0-99.9 |
Device Health
Parameter | Category | Default Value | Description |
|---|---|---|---|
System Health Dashboard Sample Time Range (min.) | Device Health | 5 | See "Device Health Calculation" in System Health |
Reports
For 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 Web Service | 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. |
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 |
Alerts/Reports Web Service Endpoint URI | Alerts/Reports Web Service | /SMTPSender | Destination URI for sending reports via Web-Service |
Alerts/Reports Web Service Host | Alerts/Reports Web Service | localhost | Destination hostname for sending reports via Web-Service |
Alerts/Reports Web Service Port | Alerts/Reports Web Service | 8080 | Destination port for sending reports via Web-Service |
Alerts/Reports Web Service Protocol | Alerts/Reports Web Service | HTTP | Protocol for accessing the Web-Service host Valid values: HTTP / HTTPS |
Alerts/Reports Web Service User | Alerts/Reports Web Service | user | User used for sending reports via Web-Service. This value is sent using HTTP Basic Authentication. |
Alerts/Reports Web Service Password | Alerts/Reports Web Service | 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.
The LDAP parameters should not be altered manually and should exactly match the values in the services configuration files.
Instead, use the LDAP Configuration Script which tests the parameters, encrypts the passwords and changes the configuration files in addition to System Parameters.
Parameter | Category | Default Value | Description |
|---|---|---|---|
Enable LDAP | LDAP | false | |
LDAP Connection URLs | LDAP | ||
Enable LDAP Host Name Verification | LDAP | true | |
LDAP Connection Name (DN) | LDAP | ||
LDAP Connection Password | LDAP | ||
LDAP Referral (ignore/follow) | LDAP | ignore | |
LDAP User Search Base | LDAP | ||
LDAP User Search Filter | LDAP | ||
LDAP User Name Attribute Name | LDAP | ||
LDAP Group Search Base | LDAP | ||
LDAP Group Membership Search Filter | LDAP | ||
LDAP Group Membership Search Nested | LDAP | true | |
LDAP Group Name Search Filter | LDAP | true | |
LDAP Group Name Attribute Name | LDAP | cn |
Monitored Devices Authentication
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 |
TLS Level (TLSv1/TLSv1.1/TLSv1.2) | Security |