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 (info, warn, error, etc) |
| 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 | 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 - 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 Should Only Check Common Object Classes | Health | true | 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. |
Auto-Generated Service Wiki
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,
in cases when DPOD was updated but you still want to receive the older version format.
Note: This is for future use - Currently only v1 applies.
...
Wiki URL
...
Wiki
...
...
URL of the wiki update service
...
| . |
DevOps Portal Parameters
| Parameter | Category | Default | Description |
|---|---|---|---|
| Path and Name of Local WSDL Analyze Script | ServicesPortal | /app/custom/scripts/download_wsdl_artifacts_sample.py | The path and name of the user configurable python script for analyzing local WSDL |
| Path and Name of Local WSDL Replace Script | ServicesPortal | /app/custom/scripts/replace_wsdl_references_sample.py | The path and name of the user configurable python script for replacing local WSDL references |
| Enable Services Portal Operations for non-Admin Users | ServicesPortal | true | Enable or disable access of non-admin users to DevOps portal actions |
| Temporary Device Name for WSDL Validations Operations | ServicesPortal | (no default) | Device name that will be used to create temporary services for WSDL validations, the device must be monitored by DPOD |
| Temporary Domain Name for WSDL Validations Operations | ServicesPortal | (no default) | Temporary domain name that will be used to create temporary services for WSDL validations The domain needs to exist, DPOD will not create it |
| Local WSDL Files Max Upload Size in KB | ServicesPortal | 300 | Upload size limit for each WSDL or XSD file used in Local WSDL Validation/Promotion. Change will take effect after hitting refresh in the browser's window. |
| Import Service Max Upload File Size in KB | ServicesPortal | 10000 | Upload size limit for the import file in KB |
| Import Service Deployment Policies Path | ServicesPortal | /tmp | The dropdown with the selection of deployment policy files will be read from this folder (ZIP, XML and XCFG files only) |
| Service Import Temp Working Path | ServicesPortal | /app/tmp/servicesportal/import | Import files and deployment policies will be copied and processed in this folder |
| Path and Name of Import Service Validation Script | ServicesPortal | /app/custom/scripts/import_service_validation.py | The path and name of the user configurable python script for validating the import file |
| Path and Name of Import Service Deployment Policy Script | ServicesPortal | /app/custom/scripts/import_service_deppolicy_selector.py | The path and name of the user configurable python script for overriding the user selected deployment policy |
| Deployment Policy is Mandatory for Import Service | ServicesPortal | true | Is deployment policy mandatory for imports |
...