Use the WBIPreUpgrade command for WebSphere® ESB to
save the configuration of a previously installed version of WebSphere ESB into
a migration-specific backup directory.
Details
The WBIPreUpgrade command
saves selected files from the install_root and profile_root directories
to a backup directory you specify. The default
for profile_root is profiles/profile_name. The files copied will be in various subdirectories,
all copied by WBIPreUpgrade into the specified
backup directory. In addition, a logs subdirectory
is created, which contains new log files corresponding to the current
instance of running the WBIPreUpgrade command.
Depending on which version you are migrating from,
the
WBIPreUpgrade command backs up existing profiles
in
WebSphere Enterprise
Service Bus either
all at once or one at a time.
- If you are migrating from version 6.0.2.x,
the WBIPreUpgrade command backs up the existing
profiles in WebSphere Enterprise
Service Bus all
at once.
- If you are migrating from version 6.1.x,
the WBIPreUpgrade command backs up existing profiles
one at a time, and only those profiles identified using the -profileName parameter.
Restrictions
- If you are migrating from version 6.1.x,
the WBIPreUpgrade command inherits the following
limitations from the WebSphere Application Server
Network Deployment, version 6.1 backupConfig utilities:
- By default, all servers on the node stop before the backup is
made so that partially synchronized information is not saved.
- You must have root authority to perform migration.
- In a UNIX® or Linux® environment, the backupConfig command
does not save file permission or ownership information.
- When restoring a file, the restoreConfig command
uses the current umask and effective user ID (EUID) to set the permission
and ownership.
- You must stop the source deployment manager before starting the
migration. If you do not stop the source deployment manager, the WBIPreUpgrade command
stops it automatically.
If you are migrating on an i5/OS platform, the target
profile name must match the profile name of the source profile being
migrated.
If you are migrating on an i5/OS platform, the backUpConfig does
not save any private authorities on files and directories that you
might have configured on the source profile. Therefore, you must make
note of any such private authority that might exist on files and directories
under the config tree of the source profile, and then you must restore
these private authorities manually to the target profile after the WBIPostUpgrade command
has been run and the migration of the profile is complete.
Location
The command file is located in,
and should be run from, the install_dir/bin directory.
Authority
To run this command
script, your user profile must have *ALLOBJ authority.
Parameters
The parameters are as follows:
- backupDirectory
- This is a required parameter and must be the first parameter that
you specify. The value backupDirectory specifies
the name of the directory where the command script stores the saved
configuration and logs created during WBIPreUpgrade and WBIPostUpgrade.
This
is also the directory from which the WBIPostUpgrade command
reads the configuration.
If the directory does not exist, the WBIPreUpgrade command
script creates it.
- currentWebSphereDirectory
- This is a required parameter and must be the second parameter
that you specify. This can be any edition of WebSphere ESB for
which migration is supported.

The value
currentWebSphereDirectory specifies
the name of the profile root directory for the existing
WebSphere ESB profile
that you want to migrate. On
i5/OS, the format of
this directory path is as follows:
user_data_root/profiles/profile_name,
where
profile_name is the name of the profile and
user_data_root is
the default user data directory for
WebSphere ESB (
/QIBM/UserData/WebSphere/ESB). The profiles and profileRegistry subdirectories are created
under this directory when you install the product.
Note: The i5/OS platform is
supported only if you are migrating from version 6.1.x to version 6.2.


The value currentWebSphereDirectory specifies
the name of the installation root directory for the existing WebSphere ESB installation.
The
following directories are the defaults for
WebSphere ESB version 6.1.x.
A different, non-default path might have been used for your installation.
- If, for the prior installation, WebSphere Application Server and WebSphere ESB were
installed together during the same installation process: /QIBM/UserData/WebSphere/ProcServer/profiles/profile_name.
- If, for the prior installation, WebSphere Application Server was already
installed and WebSphere ESB was
installed over it: /QIBM/UserData/WebSphere/AppServer/V61/ND/profiles/profile_name.
- -password
- This is an optional parameter that is required if administrative
security is configured in the previous version of WebSphere ESB. The
value password specifies the password for the administrative
user name of the current WebSphere ESB (before
migration) installation.
- -profileName


Note: This parameter is not supported on the i5/OS platform.
If it is used, an invalid parameter exception will
be thrown.
This is an optional parameter for migrating from
specific profiles. The value profile_name specifies
the name of the profile created in the previous version of WebSphere ESB, from
which the script migrates your configuration. If the
-profileName parameter is not specified, the default profile will
be used. If no default profile is found, the system will report an
error.
Note: To ensure that the correct
profile is migrated, specify the profile name using this parameter
and do not rely on the default.
- -traceFile
Note: This parameter is ignored for WebSphere ESB version 6.1.x to version 6.2 migration.
This
is an optional parameter. The value file_name specifies
the name of the output file for trace information. Important: If you specify this parameter,
you must also specify the -traceString parameter. If you specify the
-traceFile parameter but do not specify the -traceString parameter,
the command uses the default trace depth, and stores the trace file
in the location you specify.
- -traceString
Note: This parameter is ignored for WebSphere ESB version 6.1.xto version 6.2 migration.
This
is an optional parameter. The value trace_spec specifies
the trace information that you want to collect. To gather all trace
information, specify "*=all=enabled" (with
quotation marks).
Important: If
you specify this parameter, you must also specify the -traceFile parameter.
If you specify the -traceString parameter but do not specify the -traceFile
parameter, the command creates a trace file by default and places
it in the backupDirectory/logs directory.
- -username
- This is an optional parameter that is required
if administrative security is configured in the previous version of WebSphere ESB. The
value userID specifies the administrative user
name of the current WebSphere ESB (before
migration) installation.
Logging
The WBIPreUpgrade command
displays status to the screen while it runs. It also saves a more
extensive set of logging information in the WBIPreUpgrade.timestamp.log file
written to the backupDirectory/logs directory,
where backupDirectory is the value specified for
the backupDirectory parameter. You can view the WBIPreUpgrade.profileName.timestamp.log file
with a text editor.