Integration Server 11.1 | webMethods Package Manager CLI Reference | wpm CLI Commands | wpm update
 
wpm update
Updates the listed packages in the target installation to the specified version. If you do not specify a version, wpm updates the package to the highest version available in the source repository.
Synopsis
wpm update [package-name:version-number package-name2:version-number … package-nameN:version-number] [optional arguments]
where package-name is a space-separated list of Integration Server packages to update.
The version-number is optional. If version-number is not specified, IBM webMethods Package Manager looks for the highest numerical version number available in the source repository. IBM webMethods Package Manager first looks in the tags and branches, looking in branches only if -sb=true (the default), and then falls back to the main branch.
Arguments
The following table lists all available arguments available for the wpm update command and their descriptions:
Argument
Description
-r [git_repo]
The repository from which to update packages. The repository can be an absolute path to a GitHub repository, a URL, or an alias of a repository defined in the wpm.yml configuration file.
Optional if a single repository is defined in the wpm.yml configuration file. Required if the wpm.yml file does not define any repositories or defines more than one repository.
-u [username]
Username for the source repository from which to install packages. For a GitHub repository, specify a GitHub user name. For an IBM webMethods Package Registry repository, specify an Empower username.
Optional. Required when installing packages from a private GitHub repository or private IBM webMethods Package Registry repository.
-p [password]
Password, passphrase, or token for connecting to the source repository.
Required if password is not defined in the creds\password property or creds\passphrase property in the wpm.yml configuration file.
When working with a GitHub repository using basic authentication, specify a GitHub developer token.
When working with a GitHub repository using private keys, specify a passphrase.
When working with IBM webMethods Package Registry, specify an Empower password.
When creds\private_key_path is set in wpm.yml file or in -k argument, specify passphrase in wpm.yml configuration file or in the -p argument.
-k [private_key]
Relative or absolute path to the location of the private key file to use for SSH authentication with the remote GitHub repository. The relative path is relative to the location of the wpm launch script (usually \wpm\bin).
Required if SSH authentication is used and the creds\private_key_path property is not set in the wpm.yml configuration file.
-j [token]
OAuth token for obtaining packages from the GitHub repository or IBM webMethods Package Registry repository protected by token authorization.
Required only if remote GitHub repository or registry requires an OAuth token for authentication and jwt_token is not set in the wpm.yml file.
-ad {true|false}
Whether IBM webMethods Package Manager checks for dependent packages and automatically updates them.
If set to false or not present, wpm does not attempt to automatically update dependencies. All missing dependencies are listed as warnings in the output. If set to true, wpm attempts to update all dependent packages and reports errors for any it cannot update.
Optional. The default is false.
-sb {true|false}
Whether IBM webMethods Package Manager scans branches and tags in the repository for the specified version number of a packages. If set to true, wpm scans branches and tags; false scans only tags.
Optional. The default is true.
-kr {true|false}
Whether IBM webMethods Package Manager keeps the local repository or cleans it up after the wpm update command completes. A value of true keeps the repository; false indicates that IBM webMethods Package Manager deletes all the local repositories once the wpm update command completes successfully.
Keeping the local repository can be useful if multiple instances of Integration Server reside on the same machine and you want to update the packages in multiple instances or if different versions of the same package will be installed.
Use wpm clean to delete local repositories.
Optional. The default is false.
-ws [package-manager-server]
URL of the IBM webMethods Package Registry that contains the package to update.
Optional. Specify -ws argument when you want to update a package located on a IBM webMethods Package Registry and one of the following is true:
*The wpm.yml configuration file does not set a IBM webMethods Package Registry.
*You want to override the value configured in the wpm.yml configuration file.
*A wpm.yml file is not used with wpm
-wr [package-manager-registry]
Name of the registry in IBM webMethods Package Registry from which to update packages. The IBM webMethods Package Registry can contain multiple registries in addition to the default registry.
Optional. Supply -wr if also supplying -ws and you want to update packages from a registry other than the default registry. If the -wr argument is not supplied but the -ws argument is supplied, wpm uses the default registry for the update operation.
-d [target-installation]
Relative or absolute path to the target installation server. The relative path is relative to the location of the wpm launch script (usually \wpm\bin).
Required if all the following are true:
*The target_installation property is not set in the wpm.yml configuration file.
*The SAG home environment variable is not specified.
*IBM webMethods Package Manager is not in the same installation directory as the target server.
-ks {true|false}
Whether IBM webMethods Package Manager preserves the enabled or disabled state of a package. If the -ks argument is not supplied, wpm sets the state of a package as enabled. The -ks argument also affects any dependent packages.
Optional. The default is false.
Usage Notes
*The wpm update command does not activate the updated packages. You must restart Integration Server to activate the package.
*The wpm update command checks for any dependent packages and, if possible, updates them based on the value of the -ad argument. If wpm cannot update the dependent packages, it returns an error or a warning based on the value of the -ad argument.
*The wpm update command places the updated packages in Integration Server_directory/packages. It does not place packages in Integration Server_directory/[instance_name]/replicate/inbound.
*During package update, wpm compares the runtime version of the target Integration Server with the value of the target_server_version attribute in the package manifest. (The runtime version of an Integration Server is located in the MANIFEST.MF file located in Integration Server_directory\lib\wm-isserver.jar.) wpm does this to ensure that the functionality in the package is available in the target Integration Server. One of the following occurs during comparison:
*If the target_server_version attribute is present in the package and the destination Integration Server's runtime version is higher than or equal to the attribute value, wpm updates the package in the destination folder.
*If the target_server_version attribute is present in the package and the destination Integration Server's runtime version is lower than the attribute value, wpm cancels the update operation and adds an error to the operation result.
*If the target_server_version attribute is present in the package but wpm cannot determine the runtime version of the destination Integration Server, wpm cancels the update operation and adds an error to the operation result. wpm might be unable to detect a version number due to reasons such as an invalid destination location, a missing JAR file, or a corrupted JAR file
*If the target_server_version attribute is not present in the package, wpm does not check the runtime version of the destination Integration Server. Instead, wpm updates the package and writes a warning message in the operation result. The target_server_version attribute might be absent if the package was created in an Integration Server version that does not support the target_server_version attribute, which was added in Integration Server version 11.1.
*Argument values specified in the command override related property values in the wpm.yml configuration file.