WAS v8.0 > Install the application serving environment > Distributed operating systems > Centralized installation manager (CIM) > Use the centralized installation manager (CIM) to manage v6.1.x and 7.x


Centralized installation manager (CIM) AdminTask commands for v6.1.x and v7.x

This topic applies to WAS v6.1.x and 7.x only. For information about using CIM for v8.0, see Installation Manager jobs

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

The administrative tasks for the centralized installation manager include the following commands:

Several of the commands include an adminName parameter. This refers to the name of an administrator account on the remote target machine. For targets, 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 WAS extension package on a specified host that contains one or more WAS ND nodes. The nodes must be defined and part of the WAS ND cell.

This command is applicable if we have installed WebSphere Virtual Enterprise on your dmgr node.

Target object: None.


Required parameters:

-packageName

Software package. (String, required)

-hostName

Domain-qualified host name of the remote host. (String, required)

-augment

Nodes to augment. Valid nodes are those defined on the host under the same installation location for WAS. Specify ALL_NODES as the keyword value to augment all of the nodes defined for the same installation location. (String, required)

-adminName

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

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

Administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)

-privateKeyStore

Path to the private key file, which is located on the dmgr. 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. We can also use the showPackageInfo command to gather this information. (String, optional)

-tempDir

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 example...:


Interactive example...:



installSoftware

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

Use this command to install WAS ND v8.0, packageName ND80, on remote workstations.

Target object: None.


Required parameters:

-packageName

Name of the software package. (String, required)

-hostName

Domain-qualified host name of the remote host. (String, required)

-installLocation

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

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 ND80, 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

Administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)

-privateKeyStore

Path to the private key file, which is located on the dmgr. 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. We can also use the showPackageInfo command to gather this information. (String, optional)

If global security is enabled for the WAS ND cell, include the following parameters as specialParms:

  • DMGR_ADMIN_ID: Specify the administrator ID used to log in to the admin console.

  • DMGR_ADMIN_PWD: Specify the password for the administrator ID used to log in to the admin console.

Optionally, you can specify the following parameters with the specialParms parameter when you install WAS ND v8.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 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

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 example...:


Interactive example...:



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

Name of the software package. (String, required)

-hostName

Domain-qualified host name of the remote host. (String, required)

-platformType

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

Relative path name of the response file on the dmgr 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 dmgr profile root. The relative pathname is the pathname relative to this directory. (String, required)

-adminName

Administrative ID for the remote host. (String, required)

-acceptLicense

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

Administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)

-privateKeyStore

Path to the private key file, which is located on the dmgr. 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. We can also use the showPackageInfo command to gather this information. (String, optional)

-tempDir

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 example...:


Interactive example...:



installMaintenance

The installMaintenance command installs maintenance on the target host.

Target object: None.


Required parameters:

-packageName

Name of the software package. (String, required)

-hostName

Domain-qualified host name of the remote host. (String, required)

-adminName

Administrative ID for the remote host. (String, required)

-acceptLicense

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

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

Administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)

-privateKeyStore

Path to the private key file, which is located on the dmgr. 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

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 example...:


Interactive example...:



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 example...:


Interactive example...:



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

Name of the software package. (String, required)


Optional parameters None.


Batch example...:


Interactive example...:



showPackageInfo

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

Target object: None.


Required parameters:

-packageName

Name of the software package. (String, required)


Optional parameters: None.


Batch example...:


Interactive example...:



showLicenseAgreement

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

Target object: None.


Required parameters:

-packageName

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 example...:


Interactive example...:



getManagedNodesOnHostByInstallLoc

The getManagedNodesOnHostByInstallLoc command returns the names of the managed nodes that are defined in the current dmgr cell. Issue this command when a host contains multiple installations of WAS ND 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 dmgr cell.


Required parameters: None.


Optional parameters: None.


Batch example...:


Interactive example...:



listManagedNodesOnHost

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

Target object:

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


Required parameters: None.


Optional parameters: None.


Batch example...:


Interactive example...:



testConnectionToHost

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

Target object: None.


Required parameters:

-hostName

Name of the remote host. (String, required)

-platformType

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

Administrative ID for the remote host. (String, required)

-adminPassword

Administrative password for the remote host. (String, required)


Optional parameters: None.


Batch example...:


Interactive example...:



testConnectionToHostUsingSSHKey

The testConnectionToHostUsingSSHKey command verifies that a connection can be established from the dmgr to the remote host by using the SSH private key for the remote host.

Target object: None.


Required parameters:

-hostName

Name of the remote host. (String, required)

-adminName

Administrative ID for the remote host. (String, required)

-privateKeyStore

Path to the private key file, which is located on the dmgr. (String, required)


Optional parameters:

-keyStorePassword

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 example...:


Interactive example...:



installSSHPublicKeyOnHost

The installSSHPublicKeyOnHost command installs the administrative SSH public key on the remote host.

Target object: None.


Required parameters:

-hostName

Name of the remote host. (String, required)

-adminName

Administrative ID for the remote host. (String, required)

-adminPassword

Administrative password for the remote host. (String, required)

-privateKeyStore

Path to the private key file, which is located on the dmgr. (String, required)


Optional parameters: None.


Batch example...:


Interactive example...:



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 example...:


Interactive example...:



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 example...:


Interactive example...:



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 example...:


Interactive example...:



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 example...:


Interactive example...:



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. We must specify the same host name that you use for the installSoftware and uninstallSoftware commands.


Required parameters: None.


Optional parameters: None.


Batch example...:


Interactive example...:



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. We must specify the same host name that you use for the installSoftware command.


Required parameters: None.


Optional parameters: None.


Batch example...:


Interactive example...:



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. We must specify the same host name that you use for the uninstallSoftware command.


Required parameters: None.


Optional parameters: None.


Batch example...:


Interactive example...:



uninstallSoftware

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

Target object: None.


Required parameters:

-packageName

Name of the software package. (String, required)

-hostName

Domain-qualified host name of the remote host. (String, required)

-platformType

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

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

Administrative ID for the remote host. (String, required)


Optional parameters:

-adminPassword

Administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)

-privateKeyStore

Path to the private key file, which is located on the dmgr. 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 example...:


Interactive example...:



uninstallMaintenance

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

Target object: None.


Required parameters:

-packageName

Name of the software package. (String, required)

-hostName

Domain-qualified host name of the remote host. (String, required)

-adminName

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

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

Administrative password for the remote host. Specify either the adminPassword command or the privateKeyStore command to authenticate. (String, optional)

-privateKeyStore

Path to the private key file, which is located on the dmgr. 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 example...:


Interactive example...:


Use the centralized installation manager (CIM) to manage v6.1.x and 7.x

+

Search Tips   |   Advanced Search