generateupgrade command (with Servers.xml file)
The generateupgrade command generates the configuration XML files for upgrading an existing Content Platform Engine. The generateupgrade command has two syntax formats, depending on whether you have a valid copy of the Servers.xml file in the directory where Content Platform Engine is installed. The command name is not case sensitive.
generateupgrade command syntax
Use the following syntax for the generateupgrade command if you have an
existing Servers.XML file with valid server information in the directory where
Content Platform Engine is installed
(ce_install_path).
Important: In the configmgr
profile specified with the -profile parameter, the
applicationserver.xml file must have the property
ApplicationServerVersion updated to reflect the value for the application
server where the Content Platform Engine upgrade runs. If the tool finds a value for
ApplicationServerVersion that is invalid for the targeted Content Platform Engine release, the generateUpgrade command fails with an error. Correct the
value in the applicationserver.xml file and run the
generateUpgrade command again.
The following syntax includes line breaks to format the command for reading. Enter the command
and options on a single line, without any line
breaks.
configmgr_cl generateupgrade -server server_name -profile myprofile -deploy deploy_type [-silent] [-force] [-help]generateupgrade command parameters
- -server server_name
- The -server server_name parameter indicates the server to create the upgrade profile for. Use the listservers command to display a list of valid server_name values before you run the generateupgrade command.
- -profile myprofile
- The -profile
myprofile parameter specifies the profile to use. The
myprofile value can be one of the following items:
- The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Platform Engine software is installed.
- The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/profiles/ce_was_tiv_db2.
- The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ce_was_tiv_db2.cfgp" or /opt/IBM/FileNet/ContentEngine/tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfgp.
Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ce_was_tiv_db2.cfgp".
- -silent
- The -silent parameter is optional. When -silent is specified, then no prompts or informational messages are displayed in the console, but the errors are written to the log. Failure messages and validation error messages are displayed as needed, such as messages about missing passwords or invalid port numbers. If you run the execute command to run all the tasks in a profile, and you specify the -silent parameter, you must also specify the -force parameter.
- -help
- The -help parameter is optional and displays a brief message on the command syntax instead of running the command.
generateupgrade command examples
- Generate the upgrade configuration files when Servers.xml file exists.
- The following command generates all the upgrade configuration
XML files for a server named ceserver1 from an existing Content Platform Engine for the profile UpgradeServer1
in the default profile directory:
configmgr_cl generateupgrade -server ceserver1 -profile UpgradeServer1 - Generate the upgrade configuration files when Servers.xml file exists, but does not have the deployment type.
- The following command generates all the upgrade configuration
XML files for a server named ceserver1 from an existing Content Platform Engine for the profile UpgradeServer1
in the default profile directory:
configmgr_cl generateupgrade -server ceserver1 -deploy cluster -profile UpgradeServer1 - Display the help for the generateupgrade command.
- The following command displays the help for the generateupgrade command:
configmgr_cl generateupgrade -help