IBM DataPower Operations Dashboard v1.0.21.x

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.

ParameterDescriptionDefault Value
Enable BackupsGlobal flag to enable or disable all backups. No backups will run when this flag is set to falsetrue
Enable SyncsGlobal flag to enable or disable all configuration syncs. No syncs will run when this flag is set to falsetrue
Enable Firmware UpgradesGlobal flag to enable or disable all firmware upgrades. No upgrades will run when this flag is set to falsetrue
Enable Secure RestoresGlobal 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 PathLocation of the user Plan/Task Pre/Post scripts in the file system/app/custom/scripts
Maintenance User Scripts Working PathThe 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 settings22: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 settings06:00
Maintenance Syslog Notifications Destination HostnameThe hostname or IP address where syslog records are sent toNo Default
Maintenance Syslog Notifications Destination PortThe port where syslog records are sent to60000
Maintenance Error Syslog Severity Field ValueThe severity of error operations syslog records (such as "Plan Failed")error
Maintenance Success Syslog Severity Field ValueThe severity of success syslog records (Such as "Plan Finished Successfully")info
Maintenance - Timeout in Seconds for Quiesce OperationsThe 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 OperationsThe 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 OperationsThe timeout (in seconds) for DPOD to wait for a device to restart before marking the task as failed1800
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 CanceledThe 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 PathLocation where DPOD saves temporary exports and files used by the configuration sync tasks/app/tmp/sync
Firmware Upgrade - Repository PathWhere 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 AddressThe network address of DPOD that monitored device can access using SSHNo Default
Firmware Upgrade - OS User NameDPOD OS user name for SCP accessproductuser1
Firmware Upgrade - OS User PasswordDPOD OS user password for SCP access*******
Secure Restore - Seconds to Wait After RestartWhen 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 UIThe 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


Copyright © 2015 MonTier Software (2015) Ltd.