rsdeploy
The command to deploy and remove packages, such as middleware, upgrade, file, or binary packages.
You must be a cluster administrator to run this command.
Synopsis
Description
Use rsdeploy command to remotely deploy packages to a specified host or group of hosts, view the status of current deployment or details about past deployments, cancel a deployment, or remotely uninstall a package.
- -h
Outputs command usage and exits.
- -V
Outputs product version and exits.
Subcommand synopsis
add package_name -p package_file [-o os_type] [-n] [-f] -u user_name -x password
Adds the package to the repository server.
- package_name
Specifies the package name.
The package name is used when running other rsdeploy commands. Enter a meaningful name, as this name, not the file name, identifies the package in the repository service.
The package name can contain up to 250 alphanumeric characters, including the characters "." and "_" Spaces and symbols are not allowed.
Notes:- A Windows limitation prohibits package names ending
with ". .". For example, running the command
mkdir a . .only creates the directory "a". - On Windows, the maximum length for a directory path is 260 characters. Do not use too long a value for package_name since the repository service uses Installation_top\eservice\rs\.cache\consumer_ID\package_name.pkg\ as the work directory for the package.
- A Windows limitation prohibits package names ending
with ". .". For example, running the command
- -p package_file
Specifies the package file to upload.
Package types can be one of the following: tar.Z, tar.gz, tgz, gz, taz, tar, jar, tar.zip, or zip.
- -o os_type
Specifies the operating system type, as matched to the host resource type.
Typical usage is to indicate an OS type. You do not need to indicate an OS type for homogeneous clusters (where all hosts in the cluster are either Windows hosts, or all hosts are running the same Linux® kernel).
- -n
Indicates that package verification is not required.
By default, all packages are validated to ensure they are acceptable for deployment. Packages provided by IBM® do not require verification.
- -f
Clears the package status for every host prior to installation.
Use this option to update the package status in cases where a manual change may have been done outside by circumventing the rsdeploy command. Ensures cached status is cleared, and the actual status is explicitly discovered. This is important as the package is installed only on those hosts that do not have the status "installed"; therefore, if a host reports an outdated status of "installed", then the package will not be installed when the command is issued.
- -u user_name
Specifies the EGO user name of the component to which you are issuing this command.
- -x password
Specifies the EGO user password of the component to which you are issuing this command.
cancel package_name -u user_name -x password
Cancels the remote deployment. Does not cancel in the middle of a package installation on a host, but stops installation on other hosts awaiting package installation.
- package_name
Specifies the package name.
- -u user_name
Specifies the EGO user name of the component to which you are issuing this command.
- -x password
Specifies the EGO user password of the component to which you are issuing this command.
install package_name [-c consumer_name -r resource_group] [-r resource_group] [-t host_name] [-f] -u user_name -x password
Initiates deployment of the package across specified hosts.
- package_name
Specifies the package name.
The name was assigned when the package was first added to the repository server.
- -c consumer_name
Specifies the consumer used to get an allocation to initiate the activity. The full consumer path is required, and must be preceded by a slash (for example, /ClusterServices/EGOClusterServices). The consumer path must be to a leaf consumer.
The consumer needs appropriate privileges/permissions to start a activity on the remote host. (Only a cluster administrator has access to all target hosts.)
Note: If you specify a consumer name in the command, you are required to also specify a resource group.- -r resource_group
Specifies the resource group containing all target hosts.
- -t host_name
Specifies host to which to install the package.
- -f
Clears the package status for every host prior to installation.
Use this option to update the package status in cases where a manual change may have been done outside by circumventing the rsdeploy command. Ensures cached status is cleared, and the actual status is explicitly discovered. This is important as the package is installed only on those hosts that do not have the status "installed"; therefore, if a host reports an outdated status of "installed", then the package will not be installed when the command is issued.
- -u user_name
Specifies the EGO user name of the component to which you are issuing this command.
- -x password
Specifies the EGO user password of the component to which you are issuing this command.
remove package_name [-o os_type] -u user_name -x password
Removes the package from the repository server.
- package_name
Specifies the package name.
- -o os_type
Specifies the operating system type, as matched to the host resource type.
Typical usage is to indicate an OS type. You do not need to indicate an OS type for homogeneous clusters (where all hosts in the cluster are either Windows hosts, or all hosts are running the same Linux kernel).
- -u user_name
Specifies the EGO user name of the component to which you are issuing this command.
- -x password
Specifies the EGO user password of the component to which you are issuing this command.
status package_name [-s all | allocating | waiting | active | done | error | cancelled] -u user_name -x password
Gets the status of deployments, including pending and completed deployments. Lists deployment errors.
- package_name
Specifies the package name.
- -s
Specifies for filtering criteria for retrieving the status of deployments.
all: Default filter. Retrieves the status on all deployments.
allocating: Retrieves the status on deployments awaiting an allocation from EGO.
waiting: Retrieves the status on deployments waiting for the remote agent to start.
active: Retrieves the status on deployments with agents started on remote machines.
done: Retrieves the status on deployments that have completed their package installations.
error: Retrieves the status on deployments that have received error messages.
cancelled: Retrieves the status on deployments that were canceled.
- -u user_name
Specifies the EGO user name of the component to which you are issuing this command.
- -x password
Specifies the EGO user password of the component to which you are issuing this command.
uninstall package_name [-c consumer_name -r resource_group] [-r resource_group] [-t host_name] -u user_name -x password
Uninstalls a package from the hosts.
- package_name
Specifies the package name to uninstall.
- -c consumer_name
Specifies the consumer used to get an allocation to initiate the activity. The full consumer path is required, and must be preceded by a slash (for example, /ClusterServices/EGOClusterServices). The consumer path must be to a leaf consumer.
The consumer needs appropriate privileges/permissions to start a activity on the remote host. (Only a cluster administrator has access to all target hosts.)
Note: If you specify a consumer name in the command, you are required to also specify a resource group.- -r resource_group
Specifies the resource group containing all target hosts.
- -t host_name
Specifies host to which to uninstall the package.
- -u user_name
Specifies the EGO user name of the component to which you are issuing this command.
- -x password
Specifies the EGO user password of the component to which you are issuing this command.
view -u user_name -x password
Lists the packages in the repository and their creation date.
- -u user_name
Specifies the EGO user name of the component to which you are issuing this command.
- -x password
Specifies the EGO user password of the component to which you are issuing this command.