mqsibackupbroker command

Use the mqsibackupbroker command to back up the current configuration of an integration node.

Supported platforms

Windows
Linux® and UNIX systems
z/OS®. Run this command by customizing and submitting BIPBUBK; see Contents of the integration node PDSE.

Purpose

The mqsibackupbroker command creates a record of the current configuration of an integration node in a file, in compressed file format. You can use the file to restore the integration node at a later time, if required.

Usage notes

The command backs up of the following persistent configuration data associated with the integration node:

Deployed resources; message flows, dictionaries, JAR files, and other runtime resources that you have previously deployed in a BAR file.
Integration servers.
Integration node configuration; for example, configurable services.

The command does not back up the following resources:

Transient information; for example, inflight aggregations or collections.
Executable code, including resources that are associated with user-defined extensions (nodes, parsers, and exits).
Resources required by message flows to function correctly; for example, WebSphere® MQ queues and data stored in databases.

Use the backup file to restore an integration node on a computer that has an identical configuration; the operating system must be at the same level, and the integration node and queue manager names must be identical.

You can run this command for an integration node that is active. However, you must not take a backup while the integration node is processing configuration changes and deployments; the backup file created might contain incomplete information. If the file contains partial records, you cannot use it to restore the integration node at a later time.

To ensure that the backup is complete and correct, either take a backup when the integration node is not processing a configuration change (such as a deployment or change property) or when the integration node is stopped.

Authorization

For information about platform-specific authorizations, see the following topics:

If you have enabled integration node administration security, you must also set up the authority that is detailed in Tasks and authorizations for administration security.

Syntax

Parameters

integrationNodeName

(Required) The name of the integration node that you want to back up. You must specify the name as the first parameter.

-d directory

(Required) The directory in which the backup file is created. You must specify a directory that is on a file system that can be accessed by the computer on which you run this command.

-a archiveName

(Optional) The name of the backup (archive) file. The file is created in compressed file format. If you do not specify this parameter, the default name integrationNodeName_yyMMdd_HHmmss.zip is used.

-v traceFileName

(Optional) The location of a trace file that records details of the actions taken by the command.

-f

(Optional) Force incomplete backup files to be created if one or more parts of the integration node configuration cannot be read.

The command creates a backup file that contains all available information; if it cannot access some configuration detail, that subset of data is not saved. For example, if a message flow required exclusive access to a deployed resource, and the message flow is running, the deployed resource might not be included in the backup file.

If you do not specify this option, the command fails if it cannot create complete backup file.

Specify this option only if directed to do so by your IBM® service representative.

Examples

The following example backs up integration node IBNODE on Windows:

mqsibackupbroker IBNODE -d C:\MQSI\BACKUP -v C:\MQSI\BACKUP\trace.log