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 parameters in detail.
The parameters are accessible through the System Parameters page: [Manage->System→System Parameters].
Reports
These parameters determine DPOD's reporting behavior for DPOD.
Parameter | Category | Default Value | Explanation |
|---|---|---|---|
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 |
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.
|
| Note |
|---|
* |
...
Only one of the first three parameters |
...
should be set to true. |
More info: For more information see reports or configuring sending reports in mail.
Reports publishing
These When sending the reports via SMTP or SMTP WS. the following parameters determine where issued how those reports are sent.
If a given sending technology is enabled (e.g. send reports via SMTP), all parameters for that technology must be filledWhen the SMTP or SMTP-WS is selected as the reporting behavior, all parameters relating this behavior must be provided.
Parameter | Category | Default Value | Explanation |
|---|---|---|---|
From Address | from@example.com | The sender address which will appear in 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 |
SMTP Port | Email SMTP | 465 | Destination SMTP host port |
SMTP User | Email SMTP | mailer@example.com | User Username for logging in to the SMTP host |
| |||
SMTP WS Endpoint URI | Email SMTP WS | /DPODmontier/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. |
More info: see on reports
LDAP
These See reports for more information
LDAP
The following parameters control configuration and connection to LDAP, used for role-based security.
If When enabling LDAP role-based security is enabled – parameter “Enable LDAP” - (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 | Explanation |
|---|---|---|---|
LDAP Connection Name (DN) | LDAP |
| Username for connecting to LDAP server (sometimes called “bind user”) |
LDAP Connection PASSWORD | LDAP |
| Password for connecting to 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 user 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 user 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 |
TODO NN
Link to Planning and LDAP
Link to Installing and LDAP configuration
Link to RBM security and LDAP
For more information regarding DPOD and LDAP configuration, consult the sections under Working With LDAP in the Admin Guide.
Monitored devices authentication
These 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.(Check explanation and title.)
Parameter | Category | Default Value | Explanation |
|---|---|---|---|
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 |
TODO NN
Link to relevant section in security chapter, if there is oneTLS configuration information can be found in Configuring DPOD To Work With LDAP.
Configuration changes tracking
DPOD collects from monitored devices data concerning about DataPower configuration changes from its monitored devices. It does this by getting pulling the complete configuration from the device, and comparing it to the last collected configuration. The parameters below control this mechanism.
Parameter | Category | Default Value | Explanation |
|---|---|---|---|
Interval time to extract all service configuration and compare to last version; In Seconds; | ServiceConfig | 1800 | Determines how often monitored devices configuration is collected and compared to the last version.
It is recommended not to use a value under Recommended nterval is at least 900 (15 minutes). |
Interval number to compress Configuration Table since massive update and delete occurs. Once a day | ServiceConfig | v1 | For internal use, do not change unless instructed to do so by product support.
|
TODO NNLink to section HK - is v1 the real default value here? Also - Section about tracking configuration changes
Link to agents types and the data they collect
-I don't think we have it.
Consult the table on System Services Management for more information about the types of agents in DPOD and the information they collect.
Console UI appearance
The These parameters control the way data is displayed in the DPOD's Console UI. These are the default values, unless the user has defined another value.
Parameter | Category | Default | Explanation |
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) | Style | Light | Light or dark theme of the console UI screens |
Auto-generated service wiki
DPOD automatically creates a service configuration wiki for all monitored devices. DPOD collects configuration and transactional data, and if 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 | Explanation |
Wiki Default New Service Contact Mail | Wiki | This value is inserted configured as the service contact email the first time when a new service is created | |
Wiki Default New Service Contact Name | Wiki | Contact Name | This value is inserted configured as the service contact name the first time when a new service is created |
Wiki Default New Service Contact Phone | Wiki | +0-(000)-000-0000 | This value is inserted configured as the service contact phone number the first time 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 | User 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 WS request format to the wiki portal. This Manipulating this value can be used for backwards compatibility, For Note: This is for future use - Currently only v1 applies. |
Wiki URL | Wiki | URL of the wiki update service |
TODO NN
Link to how to operate this wiki, or some mention of the wiki functionality elsewhere
Link to JSON structure
...
Consult Update Wiki service JSON and its sub-sections JSON fields and JSON sample for detailed information about the wiki and JSON usage.
Miscellaneous parameters
The following parameters control various other functions.
Parameter | Category | Default Value | Explanation |
|---|---|---|---|
Enable agents management | Agents | trueIn an “External self-service console” installation, this should be false, otherwise, it should be true. (link to installation | types in chapter 2)Set to true, unless using an External Self Service Console installation, in which case it should be false. |
Certificate monitoring duration in days | Certificate Monitoring | 60 | DataPower can be set Gateways are able to send an alert a configurable amount 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 set on 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.
Link to task |
Default duration of WSM WS-M in minutes | WSM | 5 | This determines how long a WSM WS-M subscription remains enabled after being activated. Value The value is in minutes, with a maximum value is of 60.
Link to agent types |
3rd Parties Notice File Path | System | /installs/eula/NOTICE.txt | This is the location of licensing and notices files for 3rd party products used by DPOD. |
EULA File Path | System | /installs/eula/EULA.txt | The location of the DPOD EULA agreement. |