/
Export and Import Server Configuration

IBM DataPower Operations Dashboard v1.0.20.x

A newer version of this product documentation is available.

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

Export and Import Server Configuration

Owned by Avi Falah
Last updated: Dec 18, 2023
2 min read

The import script will override the target DPOD server configuration, run with caution.

Overview

Copying configuration between two instances of DPOD is useful for moving configuration between environments, synchronizing a DR Instance, or when reinstalling DPOD.
The following method allows users to export the configuration from one instance of DPOD and import it to another.
The configuration is divided into these categories and users can choose which categories to export:

Category

Configuration

UI Location

Category

Configuration

UI Location

Reports

Reports queries and metadata. Not including executions and results.

Web Console → Reports / Alerts → Reports

Alerts and Health Metrics

Alerts and Health Metrics. Not including executions and results.

Web Console → Reports / Alerts → Alerts

LDAP

LDAP connection properties.
Web Console and Admin console login settings.
System parameters with LDAP category.

Web Console → Manage → Customize → System Parameters (LDAP Category)

System Parameters

All System parameters.

Web Console → Manage → Customize → System Parameters

System Parameters Category

All System parameters related to a category provided by the user.

Web Console → Manage → Customize → System Parameters (provided category)

Users and Roles

Local users, roles and custom roles managed by DPOD.

Web Console → Manage → Security

Maintenance Plans

Metadata and plans of backup, synchronization and firmware upgrade tasks.

Web Console → Manage → Maintenance

Devices

Monitored Devices, Monitored Devices Groups.

Web Console → Manage → Topology

Custom Dashboards

Custom dashboards from both API-C and Gateways product views

Web Console → Dashboards → Custom
or
Web Console → Manage → Customize → Dashboards Editor

Cloud Agent

Cloud agent subscriptions.

Web Console → Manage → Topology

Custom Logo

Custom logo configured by user.

Web Console → Manage → Customize → User Interface

Prerequisites

  1. Two DPOD instances with the same version (one for export and one for import).

  2. Access to the server CLI with root user privileges.

  3. FTP / SSH access to allow fetching the export tar from the origin DPOD server.

  4. FTP / SSH access to allow uploading the export tar to the target DPOD server.

Configuration Export

To export the configuration into a file, run the export command on the origin DPOD server CLI.

See the following examples:

  • Export all the configuration (recommended):

    /app/scripts/app_configuration_export.sh -t <path to export tar file>

  • Export selected categories (one or more can be exported):

    /app/scripts/app_configuration_export.sh -t <path to export tar file> --devices --reports

  • Export a specific system parameters category:

    /app/scripts/app_configuration_export.sh -t <path to export tar file> --system-parameters-category 'Email SMTP'

  • Show help and list of available options and categories:

Configuration Import

To import the configuration from a file:

  1. Copy the export tar file, encryption key file and the md5 file created by the command on the origin server to the target server.

  2. Run the import command on the target DPOD server CLI:

Run the following command for help and list of available options:

 

Copyright © 2015 MonTier Software (2015) Ltd.