mqsiextractcomponents command

• Windows
• Linux®
• AIX®
• IBM z/OS® Container Extensions (zCX). Run this command by modifying and submitting the supplied JCL or by using an IBM z/OS console command.

Extract configuration and resources for integration nodes and managed integration servers to IBM App Connect Enterprise 12.0 from IBM Integration Bus 10.0 or IBM App Connect Enterprise 11.0.

You must have an installation of the product at both target and source versions, with the required component code installed, and you must run this command from the later version of the product.

You can use this command to extract configuration and resources from your IBM Integration Bus 10.0 or IBM App Connect Enterprise 11.0 system that is running on any previously supported platform to your IBM App Connect Enterprise 12.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.

You can choose to extract components from an integration node or from a managed 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.

Use this command to migrate integration nodes and managed integration servers, but not independent integration servers. Independent integration servers that were created in IBM App Connect Enterprise 11.0 can be started in IBM App Connect Enterprise 12.0 without running the mqsiextractcomponents command first. If the integration server is then deployed or configured to use IBM App Connect Enterprise 12.0 features, it can no longer be run with IBM App Connect Enterprise 11.0. If there is a possibility that you will need to roll back the integration server to IBM App Connect Enterprise 11.0, ensure that you take a manual backup copy of the integration server's work directory before upgrading to Version 12.0 (the mqsibackupbroker and mqsirestorebroker commands cannot be used for backing up independent integration server work directories). Although you can take independent integration servers that were created for Version 11 and run them on Version 12, integration server work directories are typically created as transient rather than long-term artifacts, and many users prefer to rebuild them when moving from one version to another.

--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 12.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 12.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 applies only 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 applies only 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.

--ignore-compiled-resources resourceTypes

(Optional) This parameter specifies a comma-separated list of compiled resource types that are ignored when they are found in the backup, so they are not extracted. You can specify any of the following resource types: ALL, MAP, BIR, and DPIF. This option is not supported with backups from IBM Integration Bus 10.0 or earlier, because compiled resources in backups from these versions are always ignored.

--integration-node-domain-group domainGroup

(Optional) The Windows domain group that is used to secure files in the shared workpath of a multi-instance integration node. This parameter is used only in conjunction with the --shared-workpath parameter, and applies only on Windows platforms.

--trace traceFileName

(Optional) Send verbose internal trace to the specified file.

Enter the command on a single line.

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

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