Centralized installation manager (CIM) AdminTask commands

You can use the Jacl or Jython scripting languages to use the features of the centralized installation manager (CIM) with the wsadmin tool. Use the commands and parameters to install, uninstall, and manage various software packages and maintenance files.

Note: Several of the commands include an adminName parameter. This refers to the name of an administrator account on the remote target machine. For targets on distributed operating systems, this administrator account can be either the root account or a non-root account if the software package supports a non-root install. However, for targets on Windows operating systems the added requirement is that the user account must have administrative privileges in order to use CIM for remote installations.

installWASExtension

The installWASExtension command installs the specified WebSphere® Application Server extension package on a specified host that contains one or more WebSphere® Application Server, Network Deployment nodes. The nodes must be defined and part of the WebSphere Application Server, Network Deployment cell.

Note: This command is applicable if you have installed WebSphere Virtual Enterprise on your deployment manager node.

Target object

None.

Required parameters

-packageName
Specifies the name of the software package. (String, required)
-hostName
Specifies the domain-qualified host name of the remote host. (String, required)
-augment
Specifies a list of nodes to augment. Valid nodes are those defined on the host under the same installation location for WebSphere Application Server. Specify ALL_NODES as the keyword value to augment all of the nodes defined for the same installation location. (String, required)
-adminName
Specifies the administrative ID for the remote host. (String, required)
-acceptLicense
Specifies if the license agreement is accepted. Specify true to indicate that you reviewed and agreed to the terms of the IBM® International Program License Agreement accompanying this program. Otherwise, you cannot proceed with the installation of the program or component. (String, required)

Optional parameters

-installLocation
Specifies the path of the installation directory on the remote host. Specify this parameter only if there are multiple installation locations that exist within the current cell on the same host. (String, optional)
-featureList
Specifies a list of features to install on the remote target. (String, optional)
-adminPassword
Specifies the administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-privateKeyStore
Specifies the path to the private key file, which is located on the deployment manager. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-keyStorePassword
Specifies an optional password, also known as the passphrase, which is used to protect the private key file. (String, the parameter is required if a non-blank password is used to protect private key store.)
-specialParms
Specifies optional name-value pairs for other parameters that might be required. Obtain information about any name-value pairs from the provider of the software package. You can also use the showPackageInfo command to gather this information. (String, optional)
-tempDir
Specifies the location of the temporary directory on the target host. If this parameter is omitted, the centralized installation manager uses the default temporary directory of the target host. (String, optional)

Batch mode example usage:

Interactive mode example usage:

installSoftware

The installSoftware command installs the specified software package on the target host.

Use this command to install WebSphere Application Server, Network Deployment Version 7.0, packageName ND70, on remote workstations.

Target object

None.

Required parameters

-packageName
Specifies the name of the software package. (String, required)
-hostName
Specifies the domain-qualified host name of the remote host. (String, required)
-installLocation
Specifies the path to the installation directory on the remote host. Specify this parameter only if there are multiple installation locations that exist within the current cell on the same host. (String, required)
-adminName
Specifies the administrative ID for the remote host. (String, required)
-acceptLicense
Specifies if the license agreement is accepted. Specify true to indicate that you reviewed and agreed to the terms of the IBM® International Program License Agreement accompanying this program. Otherwise, you cannot proceed with the installation of the program or component. (String, required)

Optional parameters

-featureList
Specifies a list of features to install on the remote target. (String, optional) For the package ND70, available features are:
  • noFeature, for no feature
  • samplesSelected, for Application Server samples
  • languagepack.console.all, for language pack for administrative console
  • languagepack.server.all, for language pack for server runtime

The default features for this package are: languagepack.console.all and languagepack.server.all

-adminPassword
Specifies the administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-privateKeyStore
Specifies the path to the private key file, which is located on the deployment manager. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-keyStorePassword
Specifies an optional password, also known as the passphrase, which is used to protect the private key file. (String, the parameter is required if a non-blank password is used to protect private key store.)
-specialParms
Specifies optional name-value pairs for other parameters that might be required. Obtain information about any name-value pairs from the provider of the software package. You can also use the showPackageInfo command to gather this information. (String, optional)
If global security is enabled for the WebSphere Application Server, Network Deployment cell, you must include the following parameters as specialParms:
  • DMGR_ADMIN_ID: Specify the administrator ID used to log in to the administrative console.
  • DMGR_ADMIN_PWD: Specify the password for the administrator ID used to log in to the administrative console.
Optionally, you can specify the following parameters with the specialParms parameter when you install WebSphere Application Server, Network Deployment Version 7.0:
  • DISABLE_OS_PREREQ_CHECKING : Specify true or false with this parameter to disable or enable prerequisite checking on the operating system.
  • USE_32BIT_IMAGE_ON_64BIT_OS : Specify true if you want to override the default behavior of using 64-bit installation image on 64-bit operating systems. This parameter has effect only if the software package includes a 32-bit image for the platform and machine architecture.
-tempDir
Specifies the location of the temporary directory on the target host. If this parameter is omitted, the centralized installation manager uses the default temporary directory of the target host. (String, optional)

Batch mode example usage:

Interactive mode example usage:

installWithResponseFile

The installWithResponseFile command installs the specified software package on the target host using parameters specified in a response file.

Target object

None.

Required parameters

-packageName
Specifies the name of the software package. (String, required)
-hostName
Specifies the domain-qualified host name of the remote host. (String, required)
-platformType
Specifies the operating system of the remote workstation. The valid types are: Windows, AIX, HP-UX, Linux, UNIX, OS400 or Solaris. This parameter is not case-sensitive. (String, required)
-responseFile
Specifies the relative path name of the response file on the deployment manager host that contains the parameters to be used for the installation operation. The response files for centralized installation are kept in the cim/responsefiles directory under the deployment manager profile root. The relative pathname is the pathname relative to this directory. (String, required)
-adminName
Specifies the administrative ID for the remote host. (String, required)
-acceptLicense
Specifies whether the terms of the license agreement are accepted. Specify true to indicate that you reviewed and agreed to the terms of the IBM® International Program License Agreement accompanying this program. Otherwise, you cannot proceed with the installation of the program or component. (String, required)

Optional parameters

-adminPassword
Specifies the administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-privateKeyStore
Specifies the path to the private key file, which is located on the deployment manager. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-keyStorePassword
Specifies an optional password, also known as the passphrase, which is used to protect the private key file. (String, the parameter is required if a non-blank password is used to protect private key store.)
-specialParms
Specifies optional name-value pairs for other parameters that might be required. Obtain information about any name-value pairs from the provider of the software package. You can also use the showPackageInfo command to gather this information. (String, optional)
-tempDir
Specifies the location of the temporary directory on the target host. If this parameter is omitted, the centralized installation manager uses the default temporary directory of the target host. (String, optional)

Batch mode example usage:

Interactive mode example usage:

installMaintenance

The installMaintenance command installs maintenance on the target host.

Target object

None.

Required parameters

-packageName
Specifies the name of the software package. (String, required)
-hostName
Specifies the domain-qualified host name of the remote host. (String, required)
-adminName
Specifies the administrative ID for the remote host. (String, required)
-acceptLicense
Specifies whether the terms of the license agreement are accepted. Specify true to indicate that you reviewed and agreed to the terms of the IBM® International Program License Agreement accompanying this program. Otherwise, you cannot proceed with the installation of the program or component. (String, required)

Optional parameters

-fileList
Specifies a list of .pak maintenance files to install on the remote target. This parameter is ignored if you install a predefined maintenance package. (String, optional)
-installLocation
Specifies the path of the installation directory in which to install the package on the remote host. Specify this parameter only if there are multiple installation locations that exist within the current cell on the same host. (String, optional)
-adminPassword
Specifies the administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-privateKeyStore
Specifies the path to the private key file, which is located on the deployment manager. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-keyStorePassword
Specifies an optional password, also known as the passphrase, which is used to protect the private key file. (String, the parameter is required if a non-blank password is used to protect private key store.)
-tempDir
Specifies the location of the temporary directory on the target host. If this parameter is omitted, the centralized installation manager uses the default temporary directory of the target host. (String, optional)

Batch mode example usage:

Interactive mode example usage:

listPackagesForInstall

The listPackagesForInstall command lists all of the software packages that you can use the centralized installation manager to install.

Target object

None.

Required parameters

None.

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

listFeaturesForInstall

The listFeaturesForInstall command lists the available features of a software package that you can use the centralized installation manager to install.

None of the WebSphere Virtual Enterprise components provide separately installable features. This command returns an empty list when used against one of the WebSphere Virtual Enterprise components.

Target object

None.

Required parameters

-packageName
Specifies the name of the software package. (String, required)

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

showPackageInfo

The showPackageInfo command displays general information about a specific software package.

Target object

None.

Required parameters

-packageName
Specifies the name of the software package. (String, required)

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

showLicenseAgreement

The showLicenseAgreement command displays the license agreement associated with the specified installation package.

Target object

None.

Required parameters

-packageName
Specifies the name of the software package. (String, required)

Optional parameters

-showLicenseInfoOnly
Specifies that only the content of the license file is shown. The default is false. (String, required)

Batch mode example usage:

Interactive mode example usage:

getManagedNodesOnHostByInstallLoc

The getManagedNodesOnHostByInstallLoc command returns the names of the managed nodes that are defined in the current deployment manager cell. Issue this command when a host contains multiple installations of WebSphere Application Server, Network Deployment with nodes that are federated into the same cell.

Target object

The required target object is the host name of the workstation containing the managed nodes that are federated into the current deployment manager cell.

Required parameters

None.

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

listManagedNodesOnHost

The listManagedNodesOnHost command lists the managed nodes that are located on the federated host in the current deployment manager cell.

Target object

The required target object is the host name of the workstation containing the managed nodes that are federated into the current deployment manager cell.

Required parameters

None.

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

testConnectionToHost

The testConnectionToHost command verifies that a connection can be established from the deployment manager to the remote host by using an administrator ID and password for the remote host.

Target object

None.

Required parameters

-hostName
Specifies the name of the remote host. (String, required)
-platformType
Specifies the platform type of the remote host. The valid types are Windows, AIX, HP-UX, Linux, UNIX, OS400 or Solaris. This parameter is not case-sensitive. (String, required)
-adminName
Specifies the administrative ID for the remote host. (String, required)
-adminPassword
Specifies the administrative password for the remote host. (String, required)

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

testConnectionToHostUsingSSHKey

The testConnectionToHostUsingSSHKey command verifies that a connection can be established from the deployment manager to the remote host by using the Secure Shell (SSH) private key for the remote host.

Target object

None.

Required parameters

-hostName
Specifies the name of the remote host. (String, required)
-adminName
Specifies the administrative ID for the remote host. (String, required)
-privateKeyStore
Specifies the path to the private key file, which is located on the deployment manager. (String, required)

Optional parameters

-keyStorePassword
Specifies the optional password, also known as the passphrase, which is used to protect the private key file. (String, the parameter is required if a non-blank password is used to protect private key store.)

Batch mode example usage:

Interactive mode example usage:

installSSHPublicKeyOnHost

The installSSHPublicKeyOnHost command installs the administrative Secure Shell (SSH) public key on the remote host.

Target object

None.

Required parameters

-hostName
Specifies the name of the remote host. (String, required)
-adminName
Specifies the administrative ID for the remote host. (String, required)
-adminPassword
Specifies the administrative password for the remote host. (String, required)
-privateKeyStore
Specifies the path to the private key file, which is located on the deployment manager. (String, required)

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

listKeyInstallationRecords

The listKeyInstallationRecords command lists the SSH public key installation records that the centralized installation manager maintains.

Target object

None.

Required parameters

None.

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

updateKeyInstallationRecords

The updateKeyInstallationRecords command updates the SSH public key installation records that the centralized installation manager maintains.

Target object

None.

Required parameters

None.

Optional parameters

-add
Adds a list of host names to the installation records. (String, optional)
-remove
Removes a list of host names from the installation records. (String, optional)

Batch mode example usage:

Interactive mode example usage:

listPendingRequests

The listPendingRequests command lists the submitted installation or uninstallation requests that are not started

Target object

None.

Required parameters

None.

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

listInProgressRequests

The listInProgressRequests command lists the installation or uninstallation requests that are in progress for completion.

Target object

None.

Required parameters

None.

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

listRequestsForTarget

The listRequestsForTarget command lists all of the submitted installation and uninstallation requests for a specific host.

Target object

The required target object is the host name of the target workstation. You must specify the same host name that you use for the installSoftware and uninstallSoftware commands.

Required parameters

None.

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

showLatestInstallStatus

The showLatestInstallStatus command lists all of the submitted installation requests for a specific host.

Target object

The required target object is the host name of the target workstation. You must specify the same host name that you use for the installSoftware command.

Required parameters

None.

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

showLatestUninstallStatus

The showLatestUninstallStatus command displays the status of the most recently submitted uninstallation request.

Target object

The required target object is the host name of the target workstation. You must specify the same host name that you use for the uninstallSoftware command.

Required parameters

None.

Optional parameters

None.

Batch mode example usage:

Interactive mode example usage:

uninstallSoftware

The uninstallSoftware command uninstalls the software package from the remote host.

Target object

None.

Required parameters

-packageName
Specifies the name of the software package. (String, required)
-hostName
Specifies the domain-qualified host name of the remote host. (String, required)
-platformType
Specifies the operating system of the remote workstation. The valid types are Windows, AIX, HP-UX, Linux, UNIX, OS400 or Solaris. This parameter is not case-sensitive. (String, required)
-installLocation
Specifies the path to the installation directory on the remote host. Specify this parameter only if there are multiple installation locations that exist within the current cell on the same host. (String, required)
-adminName
Specifies the administrative ID for the remote host. (String, required)

Optional parameters

-adminPassword
Specifies the administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-privateKeyStore
Specifies the path to the private key file, which is located on the deployment manager. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-keyStorePassword
Specifies an optional password, also known as the passphrase, which is used to protect the private key file. (String, the parameter is required if a non-blank password is used to protect private key store.)

Batch mode example usage:

Interactive mode example usage:

uninstallMaintenance

The uninstallMaintenance command uninstalls maintenance, such as fix packs and interim fixes, from the remote host.

Target object

None.

Required parameters

-packageName
Specifies the name of the software package. (String, required)
-hostName
Specifies the domain-qualified host name of the remote host. (String, required)
-adminName
Specifies the administrative ID for the remote host. (String, required)

Optional parameters

-fileList
Specifies a list of maintenance files to uninstall on the remote target. (String, optional)
-installLocation
Specifies the path to the installation directory on the remote host. Specify this parameter only if there are multiple installation locations that exist within the current cell on the same host. (String, optional)
-adminPassword
Specifies the administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-privateKeyStore
Specifies the path to the private key file, which is located on the deployment manager. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)
-keyStorePassword
Specifies an optional password, also known as the passphrase, which is used to protect the private key file. (String, the parameter is required if a non-blank password is used to protect private key store.)

Batch mode example usage:

Interactive mode example usage:




Related tasks
Using the centralized installation manager (CIM) to manage your environment
Reference topic Reference topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Feb 6, 2014 2:29:34 AM CST
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=compass&product=was-nd-dist&topic=rxml_cim_commands
File name: rxml_cim_commands.html