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.
...
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 | 172.77.77.7 | Syslog server hostname or IP address. |
Alerts Syslog Server Port | Alerts | 60031 | Syslog server listening port. |
...
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. |
...
Parameter | Category | Default Value | Description | ||||
---|---|---|---|---|---|---|---|
Enable LDAP | Connection Name (DN)LDAP | Username for connecting to the LDAP server (sometimes called “bind user”)false | Whether the LDAP RBM is enabled. Valid Values: true / false | ||||
LDAP Connection | PASSWORDURLs | LDAP | Password for connecting to theOne or more 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 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 |
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 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 entryaddress(es), separated by commas | ||
Enable LDAP Host Name Verification | LDAP | true | Enable host name verification of certificates when using LDAPS | ||||
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 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 Search Base | LDAP | Location of user objects in the LDAP tree | |||||
LDAP User Search Filter | LDAP | The LDAP filter (using LDAP filter syntax) to search for usera user by its name, Use {0} as a placeholder for the user name entered in the login page | |||||
LDAP User Name Attribute Name | LDAP | The user attribute name that contains the name of that user (as entered in the login page) | |||||
LDAP Group Search Base | LDAP | Location of group objects in the LDAP tree | |||||
LDAP Group Membership Search Filter | LDAP | The LDAP filter (using LDAP filter syntax) to search for groups by a member user or a member group (in case of nested search), Use {0} as a placeholder for the full DN of the member user or the member group (in case of nested search) | |||||
LDAP Group Membership Search Nested | LDAP | true | Search for nested group membership (groups within groups)Search nested group members | ||||
LDAP Group Name Search Filter | LDAP | The LDAP filter (using LDAP filter syntax) to search for a group by its name, usually by the "cn" attribute, Use {0} as a placeholder for the group name | |||||
LDAP Group Name Attribute Name | LDAP | cn | The group attribute name that contains the name of that group |
For more information regarding DPOD and LDAP configuration, consult the sections under Configuring LDAP in the Admin Guide.
...
Parameter | Category | Default | Description |
---|---|---|---|
Internal Alerts - Check Agents Interval in Seconds | Health | 300 | How often to check 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 whether DPOD's internal database is up and working |
Internal Alerts - Check Dropped Syslogs Interval in Seconds | Health | 600 | How often to check whether DPOD's syslog agents lost incoming messages |
Internal Alerts - Check Dropped WS-M Messages Interval in Seconds | Health | 600 | How often to check whether DPOD's WS-M agents lost incoming payloads |
Internal Alerts - Check ES Interval in Seconds | Health | 300 | How often to check whether DPOD's big data component is up and working |
Internal Alerts - Check File System Interval in Seconds | Health | 300 | How often to check whether DPOD's filesystem is out of space |
Internal Alerts - Check Retention Interval in Seconds | Health | 300 | How often to check whether DPOD's internal big data retention process is working |
Internal Alerts - Check Log Targets Misconfig Interval in Seconds | Health | 43200 | How often to check whether the monitored gateways for misconfigured DPOD log targets |
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 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 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, |
Interval in Seconds to Sample WSM Agents Statistics | Health | 300 | How often to sample WS-M Agents in the monitored devices |
Internal Alerts REST API Service Host | Health | localhost | Host name / IP address of the maintenance housekeeping server to save and publish internal alerts. |
Internal Alerts REST API Service Port | Health | 8084 | Port of the maintenance housekeeping service to save and publish internal alerts. |
...