ibmint extract server command

Migrate your IBM® Integration Bus 10.0, IBM App Connect Enterprise 11.0, or IBM App Connect Enterprise 12.0 integration servers to IBM App Connect Enterprise 13.0 by using the ibmint extract server command. The command extracts configuration and resources to Version 13.0 on the same computer or a different computer.

Purpose

Extract configuration and resources for integration servers to IBM App Connect Enterprise 13.0 from IBM Integration Bus 10.0, IBM App Connect Enterprise 11.0, or IBM App Connect Enterprise 12.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, IBM App Connect Enterprise 11.0, or IBM App Connect Enterprise 12.0 system that is running on any previously supported platform to your IBM App Connect Enterprise 13.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 use this command to extract components from an integration node or managed integration server and recreate them in the work directory of an independent 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.

You cannot use this command to migrate independent integration servers. Independent integration servers that were created in IBM App Connect Enterprise 11.0 or IBM App Connect Enterprise 12.0 can be started in IBM App Connect Enterprise 13.0 without running the ibmint extract server command first.

If the integration server is then deployed or configured to use IBM App Connect Enterprise 13.0 features, it can no longer be run with IBM App Connect Enterprise 11.0 or IBM App Connect Enterprise 12.0. If there is a possibility that you will need to roll back the integration server to Version 11 or Version 12, ensure that you take a manual backup copy of the integration server's work directory before upgrading to Version 13.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 or V12 and run them on Version 13, 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.

Syntax

Read syntax diagramSkip visual syntax diagram ibmintextractserver --backup-file backup_file_name --input-integration-node integration_node_name --input-integration-server integration_server_name --output-work-directory work_directory_path --policy-project-namepolicy_project_name--overwrite-existing--default-applicationapplication_name--input-platformplatform_type--input-platform-ccsidccsid--do-not-rename-record-replay-source-topics--ignore-compiled-resource-typesresourceTypes--java-versionjavaVersion--tracetraceFileName

Parameters

--input-integration-node input_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.

--input-integration-server integration_server_name

(Required) 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 ibmint extract server on the target system.

--output-work-directory output_work_directory_path

(Required) 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 ibmint extract server command fails unless you specify the --overwrite-existing parameter, 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-name policy_project_name

(Optional) 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.

--overwrite-existing

(Optional) Deletes all content from the work directory if it already exists and is not empty on your IBM App Connect Enterprise 13.0 system before the ibmint extract server 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 ibmint extract server command is run for each integration server or integration node that contains independent resources.

--input-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.

--input-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.

--do-not-rename-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-resource-types 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.

--java-version javaVersion
(Optional) Override the major version of Java that will be used by any integration servers. Valid values are 17 and 8.
--trace traceFileName

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