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

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

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.

Dashboards

Parameter	Category	Default Value	Description

Parameter	Category	Default Value	Description
IDG Transactions Page Columns	Dashboards	Service Name, Operation, Time, Device, Domain, Status, Transaction ID, Client IP, Global Transaction ID, Elapsed, Payload	Controls which columns will appear in the Investigate->Transactions Page, you can omit or reorder the columns. Any mistakes in the input will cause the display to revert to the default value. The Payload field will not appear to users that does not have authorization to view payloads Possible values (not case sensitive): Service Name, Operation, Time, Device, Domain, Status, Transaction ID, Client IP, Global Transaction ID, Elapsed, Payload
IDG Raw Message Page Columns	Dashboards	Device, Domain, Category, Severity, Time, Direction, Object Type, Object Name, Transaction ID, Client IP, Message Code, Message	Controls which columns will appear in the Investigate→Raw Messages Page, you can omit or reorder the columns. Any mistake in the input will cause the display to revert to the default value. Possible values (not case sensitive): Device, Domain, Category, Severity, Time, Direction, Object Type, Object Name, Transaction ID, Client IP, Message Code, Message, Global Transaction ID, B2B Message ID, B2B From Partner ID, B2B to Partner ID, B2B from partner profile, B2B to Partner Profile,
APIC Transactions Page Columns	Dashboards	Time, Device, Catalog Name, Space Name, Product, Plan Name, API Name, API Version, APP Name, Method, URI, Status, Transaction ID, Client IP, Elapsed, Payload	Controls which columns will appear in the APIC Investigate->Transactions Page, you can omit or reorder the columns. Any mistakes in the input will cause the display to revert to the default value. The Payload field will not appear to users that does not have authorization to view payloads Possible values (not case sensitive): API Name, Time, Device, Catalog Name, Space Name, Operation ID, Client ID, OAuth Scope, Status, Transaction ID, Client IP, Global Transaction ID, Elapsed, Plan Name, Domain, Payload, Method, Gateway Type
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
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

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 behavior.

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.

Parameter	Category	Default Value	Description
From Address	Email	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.

See reports for more information

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

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		See LDAP Configuration Script
LDAP Connection Password	LDAP		See LDAP Configuration Script
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		See LDAP Configuration Script
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	See LDAP Configuration Script
LDAP Group Name Search Filter	LDAP		See LDAP Configuration Script
LDAP Group Name Attribute Name	LDAP	cn	See LDAP Configuration Script

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
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

TLS configuration information can be found in LDAP Configuration Script.

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.

Parameter

Category

Default Value

Description

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.

Recommended nterval is at least 900 (15 minutes).

Interval number to compress Configuration Table since massive update and delete occurs. Once a day