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.

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.

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.
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):
Transaction ID, Service Name, Operation, Time, Device, Domain, Status, Client IP, Global Transaction ID, Elapsed, Payload

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

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.
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):
Transaction ID, Time, Device, Domain,  Catalog Name, Space Name, Product, Plan Name, API Name, API Version, APP Name, Method, URI, Status, HTTP Res. Code, Client IP, Global Transaction ID, Elapsed, Payload, 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

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

System Health Dashboard Sample Time Range (min.)

Device Health

5

See "Device Health Calculation" in System Health

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.

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.

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

true

See LDAP Configuration Script

LDAP Group Name Attribute Name

LDAP

cn

See LDAP Configuration Script

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
(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/lib/security/cacerts

Trust store full path

CA Trusted Keystore Type (JKS/PKCS12)

Security

JKS

Trust store type

Show Service Configuration Changes in Human Readable Form

ServiceConfig

true

whether to see only the property name that changed  or all the xml(which is hard to understand)

Interval in Hours to Compress Service Configuration Table

ServiceConfig

24

For internal use, do not change unless instructed to do so by product support.

Parameter

Category

Default

Description

Default CSV Date Format

Style

yyyy/MM/dd HH:mm:ss.SSS

Full date format

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/elegant)

Style

Light

Light, dark or elegant theme of the console UI screens

The Max Number of Filters Dropdown Values

User Interface

200

Auto-complete filter size limit

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

Internal Alerts - Send Email on Alert via Web Service

Health

false

Whether or not to send an Email via Web Service when a problem was detected by the internal health monitoring

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,
set this option to All to make it sample all object classes in the monitored gateways, or enter a custom list of comma separated classes

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)

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

Enable Api-Stats Category Mode

Transactions

false

Allow Monitoring Transactions in Default Domain

Transactions

false

Whether or not the "Support TX in the Default Domain" box will be displayed in the Monitored Devices→Setup page

Show Custom Transaction View Selection

Transactions

false

Whether or not the "Custom TX View" checkbox will be displayed in the Product Views  

Default Transactions Source (syslog/logical)

Transactions

syslog

If the "Custom TX View" is displayed, what will be the default for users on their first sign in.

Logical Transaction, Custom String 1 Table Header

Transactions

Custom String 1

The Table Header and Filter names for "Custom String 1" in the transactions page

Logical Transaction, Custom String 2 Table Header

Transactions

Custom String 2

The Table Header and Filter names for "Custom String 2" in the transactions page

Transaction Analysis Level - User Override Path

Transactions

(blank)

Where to take the user override file for the syslog analysis message groups, no value (blank) means there is no override file

Transaction Analysis Level - Max TPS

Transactions

Core, MemoryReqRes, B2B, error

The message group names and log level for the Max TPS analysis level,
The last parameter must be a valid log level name (debug, info, notice, warn. error, critic).
The values must be comma separated, lower, upper or mixed case are allowed.

Transaction Analysis Level - More TPS

Transactions

Core, MemoryReqRes, B2B, notice

The message group names and log level for the More TPS analysis level,
The last parameter must be a valid log level name (debug, info, notice, warn. error, critic).
The values must be comma separated, lower, upper or mixed case are allowed.

Transaction Analysis Level - Balanced

Transactions

Core, MemoryReqRes, B2B, MemActionLevel, notice

The message group names and log level for the Balanced analysis level,
The last parameter must be a valid log level name (debug, info, notice, warn. error, critic).
The values must be comma separated, lower, upper or mixed case are allowed.

Transaction Analysis Level - More Data

Transactions

Core, MemoryReqRes, B2B, MemActionLevel, ReqPayloadSize, ExtLatency, info

The message group names and log level for the More Data analysis level,
The last parameter must be a valid log level name (debug, info, notice, warn. error, critic).
The values must be comma separated, lower, upper or mixed case are allowed.

Transaction Analysis Level - Max Data

Transactions

Core, MemoryReqRes, B2B, MemActionLevel, ReqPayloadSize, ExtLatency, Sidecalls, info

The message group names and log level for the Max Data analysis level,
The last parameter must be a valid log level name (debug, info, notice, warn. error, critic).
The values must be comma separated, lower, upper or mixed case are allowed.

Size of next/previous transaction results

Transactions

default

The size of next/previous transaction results.
The default is the size of the transactions list page from where the user clicked on the transaction ID link.

Enable agents management

Agents

true

Set to true, unless using an External Self Service Console installation, in which case it should be false.

Time to Keep WS-M Payloads (1d, 1w, blank)

WSM

(blank)

Automatically delete WS-M payloads from store, possible values are 1d = one day, 1w = one week, no value = don't delete automatically

Is Internal Self Service Installation

System

true

Is the current DPOD installation an Internal Self Service Console - change this value only for external self service console scenarion

Internal Self Service Address

System

https://montier-management

The address of the internal Self Service Console - change this value only for external self service console scenarion

Internal Self Service Webserver Port

System

443

The port of the internal Self Service Console - change this value only for external self service console scenarion

Threshold in days to Clean HATS Task Execution Table

System

7

Threshold in days to cleanup HATS Task execution DB table

Threshold in MB to Clean HATS Task Execution Table

System

100

Threshold in MB to cleanup the HATS Task execution DB table

Threshold in MB to Clean Reports Execution Table

System

100

Threshold in MB to cleanup the reports execution DB table

Threshold in days to Clean Reports Execution Table

System

30

Threshold in days to cleanup the reports execution DB table

Threshold in MB to Clean Alerts Execution Table

System

200

Threshold in MB to cleanup the alerts execution DB table

Threshold in days to Clean Alerts Execution Table

System

30

Threshold in days to cleanup the alerts execution DB table

Threshold in MB to Clean Services Portal Execution Table

System

100

Threshold in MB to cleanup the services portal execution DB table

Threshold in MB to Clean Maintenance Plan Execution

System

100

Threshold in MB to cleanup the maintenance execution DB tables (backup, sync and firmware upgrade)

External Path for Customization Scripts and Files

System

/app/custom

The HTTP Address of the UI

System

(no default)

The URL used to access DPOD Web Console root context, e.g. https://dpod.example.com (without /op or /admin suffixes). This URL will be used to create URLs to DPOD Web Console that are embedded in emails sent by maintenance plans or sharing by email from the Web Console.

The HTTP Address of the UI - External (optional)

System

(no default)

The URL used to access DPOD Web Console root context from external networks, e.g. https://dpod.example.com (without /op or /admin suffixes). If this URL if specified, an additional link will be added to email addresses where "The HTTP Address of the UI" is used, to allow external users to have an additional link they can use instead of the internal link.

Experimental Features

Experimental

(no default)

For support use only, do not change unless advised by L2/L3 support