Configurable Parameters and Settings

IBM DataPower Operations Dashboard v1.0.15.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at https://ibm.biz/dpod-docs.

Configurable Parameters and Settings

This page lists system parameters that are of interest in the appliance maintenance context. The parameters can be configured using the system parameters page.

Parameter

Description

Default Value

Parameter

Description

Default Value

Enable Backups

Global flag to enable or disable all backups. No backups will run when this flag is set to false

true

Enable Syncs

Global flag to enable or disable all configuration syncs. No syncs will run when this flag is set to false

true

Enable Firmware Upgrades

Global flag to enable or disable all firmware upgrades. No upgrades will run when this flag is set to false

true

Enable Secure Restores

Global flag to enable or disable all secure restores. No restores will run when this flag is set to false
As of DPOD v1.0.9, Secure-Restores are only available via the Appliance Migration feature and not as a stand-alone feature,
Disabling this option will disable Appliance Migrations from restoring the target gateway

true

Maintenance User Scripts Source Path

Location of the user Plan/Task Pre/Post scripts in the file system

/app/custom/scripts

Maintenance User Scripts Working Path

The user scripts' execution path. This is normally the same as the source path above

/app/custom/scripts

Maintenance Window Start Time (HH:MM)

Global value for the maintenance window start time. This value may be overridden in a specific plan's settings

22:00

Maintenance Window End Time (HH:MM)

Global value for the maintenance window end time. This value may be overridden in a specific plan's settings

06:00

Maintenance Syslog Notifications Destination Hostname

The hostname or IP address where syslog records are sent to

No Default

Maintenance Syslog Notifications Destination Port

The port where syslog records are sent to

60000

Maintenance Error Syslog Severity Field Value

The severity of error operations syslog records (such as "Plan Failed")

error

Maintenance Success Syslog Severity Field Value

The severity of success syslog records (Such as "Plan Finished Successfully")

info

Maintenance - Timeout in Seconds for Quiesce Operations

The timeout (in seconds) sent to the Quiesce operation when a quiesce operation was requested in the activity.
DPOD will add 3 minutes to this timeout and check if all domains quiesced within this period.

1800

Maintenance - Timeout in Seconds for Unquiesce Operations

The timeout (in seconds) for DPOD to wait until all domains unquiesce before marking the task as failed

DPOD will add 3 minutes to this timeout

1800

Maintenance - Timeout in Seconds for Restart Operations

The timeout (in seconds) for DPOD to wait for a device to restart before marking the task as failed

1800

Backups -  Destination Path

Destination path where DPOD saves its backup files.
This path must be a new dedicated mounted filesystem (mount point). Backups may not be stored on existing mount point created during DPOD's installation. User can use the Linux command "df -h" to make sure the path entered is a mounted mount point

/data/backups/store

Backups - Backup Store Free Space Threshold (Percent)

Before starting any backup, DPOD ensures that the destination path has enough free storage available.
When the percentage of free storage is less than this value, the backup will not proceed

10

Backups - DataPower Temp Free Space Threshold (Percent)

For Secure Backup - the backup will be first stored in the DataPower temp filesystem,
Before starting a secure backup, DPOD ensures that the temp DataPower filesystem has enough free storage available.
When the percentage of free storage is less than this value, the backup will not proceed

10

Maintenance - Max Minutes Before Marking Task as Canceled

The amount of time (in minutes) DPOD waits before marking a hung task as cancelled. This time is relative to the last status change on the task.
When DPOD marks such tasks as cancelled, other tasks may start executing on the device. (The task itself will not be interrupted)

60

Syncs -  Temp Files Path

Location where DPOD saves temporary exports and files used by the configuration sync tasks

/app/tmp/sync

Firmware Upgrade - Repository Path

Where DPOD should look for the firmware upgrade image files.
It is recommended that you set up a mount point and point the parameter to it.

Using the following DPOD paths and subfolders of those paths is not supported:

/app

/data

/logs

/installs

/var

/tmp

Firmware Upgrade - Local Node IP Address

The network address of DPOD that monitored device can access using SSH

No Default

Firmware Upgrade - OS User Name

DPOD OS user name for SCP access

productuser1

Firmware Upgrade - OS User Password

DPOD OS user password for SCP access

*******

Secure Restore - Seconds to Wait After Restart

When using Secure-Restore, how long to wait after detecting that the gateway is up and running, and before starting post-processing tasks (this time is required for the gateway to process its configuration)

As of DPOD v1.0.9, Secure-Restores are only available via the Appliance Migration feature and not as a stand-alone feature.

150

The HTTP Address of the UI

The URL prefix for your DPOD UI - for example: https://10.0.0.50 (everything before /op)
it will be used in the maintenance result emails

No Default

Backups - Max Minutes before Releasing Locks on Running Tasks

Maximum time to wait for maintenance task to finish before marking it as cancelled

Even when marked as cancelled the maintenance operation may still be executing on the Gateway.

60

 

IBM DataPower Operations Dashboard (DPOD) v1.0.15.0