IBM DataPower Operations Dashboard v1.0.14.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Admin Console's List of Utilities

Owned by Avi Falah
Last updated: Aug 03, 2021
UtilityPurpose
Application
Stop/Start Services
Location: Admin Console → Utilities → Application → Stop/Start Services

Use this utility to stop or start services.
When starting a service with dependencies, all dependencies will be started as well.
When stopping a service with dependencies, all dependent services will be stopped as well.

The dependency order between services is

  1. Configuration database
  2. Store services
  3. Syslog agents
  4. WS-M agents
  5. Store retention service
  6. Device and service resource samplers
  7. Keepalive service and the maintenance service
  8. Web UI
  9. Reports and alerts
  10. Agent node
Generate Must Gather
Location: Admin Console → Utilities → Application → Must Gather

Use this utility to generate a compressed archive file containing information and logs in /tmp directory.

Change Agent TCP Port
Location: Admin Console → Utilities → Application →Change Agent TCP Port

Syslog and WS-M agents listen to predefined TCP ports:
Syslog agents: 60000-60009
WS-M agents: 60020-60029
Use this utility to change these default settings. Please make sure the required network connectivity (e.g. firewall rules) is available between monitored devices and the agents.

Backup Application
Location: Admin Console → Utilities → Application → Backup

Use this utility to backup the software, static configuration and user configuration data (internal DB).

LDAP Configuration
Location: Admin Console → Utilities → Application →LDAP Configuration

Use this utility to configure the system to authenticate users with LDAP registry or local user registry based on system internal database.

Available options:

  • Test LDAP Configuration: Only test if parameters file is valid and the application can connect to LDAP registry.
  • Update LDAP Configuration: Change system configuration to use the LDAP registry.
  • Disable LDAP Configuration: Change system configuration to use local user registry based on system internal database.
Replace the Encryption Key
Location: Admin Console → Utilities → Application → Encryption Key

The system encrypts sensitive data (stored in the database/files or sent via HTTP/S requests) with a random encryption key generated during the installation.
Use this page to generate a new random encryption key or to deploy a provided encryption key.

Available options:

  • Generate New Random Key
  • Deploy Provided Key

Store

Reallocating Unassigned Shards
Location: Admin Console → Utilities → Store →Reallocating Unassigned Shards

Reallocating unassigned shards might solve the following situations:

  1. An "Error Accessing Store" dialog is displayed after signing in to the system.
  2. In the Store page, the status of the cluster is RED with unassigned shards.

Use this utility to reallocate unassigned shards to a Store data node. The selected Store node must be a data node (a node of type "D" in the nodes table in the Web Console).

Update Store Allocation Configuration
Location: Admin Console → Utilities → Store → Store Allocation

Use this utility to update the application Store size definitions based on the current data file system size.

Cell Environment
Tune OS Parameters
Location: Admin Console → Utilities → Store → Tune OS Parameters

Use this utility to run operating system performance optimization utility.

IBM DataPower Operations Dashboard (DPOD) v1.0.14.0