mqsiextractcomponents command

Migrate your IBM® Integration Bus Version 10.0 or Version 9.0 integration servers and integration nodes to IBM App Connect Enterprise Version 11.0 by using the mqsiextractcomponents command to extract configuration and resources to Version 11.0 on the same computer or a different computer.

Purpose

Extract integration server and integration node configuration and resources to IBM App Connect Enterprise Version 11.0 from IBM Integration Bus Version 10.0 or Version 9.0.

You must run this command from the later version of the product.

You must have an installation of the product at both target and source versions, with the required component code installed, to issue this command successfully.

You can use this command to extract configuration and resources from your IBM Integration Bus Version 10.0 or Version 9.0 system that is running on any previously supported platform to your IBM App Connect Enterprise Version 11.0 system that is running on Windows, Linux, or AIX.

Before you start to extract configuration and resources, stop the integration server and all active debug sessions in the IBM App Connect Enterprise Toolkit. You cannot extract message flows that are being debugged.

Usage notes

You can choose to extract components from an integration node or from an integration server. Extracting the configuration and resources from an integration node also extracts the configuration and resources of all the integration servers that are associated with the integration node. In either case, ensure that you run the mqsibackupbroker command on the source system and then transfer the backup file that is created to the computer to which you are extracting the configuration and resources.

Syntax

Extract integration node configuration and resources

Read syntax diagramSkip visual syntax diagram mqsiextractcomponents  --backup-file  backupfilename  --source-integration-node source_integration_node_name  --target-integration-node target_integration_node_name  --delete-existing-node  --shared-workpath shared_workpath_directory_path --workpath workpath_directory_path --default-application application_name --service-user-id userid --service-password password --source-platform platform_type --source-platform-ccsid ccsid --avoid-renaming-record-replay-source-topics

Extract integration server configuration and resources

Read syntax diagramSkip visual syntax diagram mqsiextractcomponents --source-integration-node  integration_node_name  --backup-file  backup_file_name  --source-integration-server  integration_server_name  --target-work-directory  work_directory_path  --policy-project policy_project_name --clear-work-directory  --default-application application_name --source-platform platform_type --source-platform-ccsid ccsid --avoid-renaming-record-replay-source-topics

Parameters

--source-integration-node source_integration_node_name

(Required) The name in the backup file of the integration node with which the integration server that you are migrating is associated.

If you are extracting configuration and resources from an integration server only, you must also specify the name of the integration node with which the integration server is associated.

--target-integration-node target_integration_node_name

(Required and exclusive to extraction of configuration and resources from an integration node only) The name of the integration node to which to write the extracted configuration and resources. If the integration node already exists, the mqsiextractcomponents command fails unless you specify --delete-existing-node in which case the existing integration node is deleted and a new integration node with the same name is created.

If you are extracting configuration and resources from an integration server only, you must also specify the name of the integration node with which the integration server is associated.

--source-integration-server integration_server_name

(Required and exclusive to extraction of configuration and resources from an integration server only) The name in the backup file of the integration server from which you are extracting configuration and resources.

--backup-file backup_file_name

(Required) The file path of the backup file that is created by running the mqsibackupbroker command on the source system prior to running the mqsiextractcomponents on the target system.

--workpath workpath_directory_path

(Optional and exclusive to extraction of configuration and resources from an integration node only) The directory into which internal data, such as installation logs, component details, and trace output is written for the target integration node.

--shared-workpath shared_workpath_directory_path

(Optional and exclusive to extraction of configuration and resources from an integration node only) The directory in which registry and configuration data is shared between multiple instances of the target integration node.

--target-work-directory target_work_directory_path

(Required and exclusive to extraction of configuration and resources from an integration server only) The workpath of the work directory to which the configuration and resources that are extracted from the integration server are written. If the work directory already exists, the mqsiextractcomponents command fails unless you specify --clear-work-directory in which case the configuration and resources are written to the work directory, overwriting any data that might be present in the directory.

--policy-project policy_project_name

(Optional and exclusive to extraction of configuration and resources from an integration server only) The name of the policy project for all extracted configurable service and resource manager data. Configurable services from the source system are converted to policies on the target system. The policy project resides in the run subfolder in the work directory on the target system.

If you do not specify a value for this parameter, policies are created in a policy project called DefaultPolicies.

--delete-existing-node

(Optional and exclusive to extraction of configuration and resources from an integration node) Deletes the integration node if it already exists on your IBM App Connect Enterprise Version 11.0 system before the mqsiextractcomponents command extracts the configuration and resources from the source system.

--clear-work-directory

(Optional and exclusive to extraction of configuration and resources from an integration server only) Deletes all content from the work directory if it already exists and is not empty on your IBM App Connect Enterprise Version 11.0 system before the mqsiextractcomponents command puts the configuration and resources from the source system there.

--default-application application_name

(Optional) This parameter is required if any independent resources are associated with the integration server or integration node. This parameter creates a new default application, and all independent resources that are associated with the integration server or integration node are moved into it. This new file structure is then saved, so the parameter is required only the first time that the mqsiextractcomponents command is run for each integration server or integration node that contains independent resources.

--service-user-id userid

(Optional) The user ID that is used when creating the Windows service definition. Defaults to 'LocalSystem'. This parameter only applies on Windows platforms.

--service-password password

(Optional) The password that is used when creating the Windows service definition. Defaults to a blank string because a password is not required by the default user ID of 'LocalSystem'. This parameter only applies on Windows platforms.

--source-platform platform-type

(Optional) The platform type where the backup was taken. This parameter is required only if the auto-detection fails. You can specify one of the following values: WinX64, LinuxX64, AIXPPC64, zOS, Linuxz64, LinuxPPC64, LinuxPPCLE64, SolarisSparc64, SolarisX64, HPUXIA64, MacOSX.

--source-platform-ccsid ccsid

(Optional) The default CCSID of the platform where the backup was taken. This parameter is required only if the auto-detection fails.

--avoid-renaming-record-replay-source-topics

(Optional) This parameter prevents the updating of topic strings to reference the new integration node or server. By default, when extracting DataCaptureSource configurable service definitions and creating record and replay source configuration, the topic strings for any topics that reference the source integration node (and source integration server when extracting a single server) are updated to reference the name of the new integration node or integration server. This parameter prevents the update from taking place.

Examples

Enter the command on a single line.

The following example shows extraction of configuration and resources from an IBM Integration Bus Version 10.0 integration server called myIntegrationServer1, which is associated with an integration node called IBNODEV10. The backup file that was created by running the mqsibackupbroker command at IBM Integration Bus Version 10.0 is called V10Backup01072018.zip

mqsiextractcomponents --source-integration-node IBNODEV10 --source-integration-server myIntegrationServer1 --backup-file C:\V10Backup\V10Backup01072018.zip --target-work-directory C:\ACEv11\ACEServ1 --policy-project-name C:\V10Backup\V11PolicyProject

The following example shows extraction of configuration and resources from an IBM Integration Bus Version 10.0 integration node called IBNODEV10 to an integration node called NEWV11NODE. The backup file that was created by running the mqsibackupbroker command at IBM Integration Bus Version 10.0 is called V10Backup01072018.zip

mqsiextractcomponents IBNODEV10 --backup-file V10Backup01072018.zip --source-integration-node IBNODEV10 --target-integration-node NEWV11NODE