Centralized installation manager administrative tasks

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

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.

Target object

None.

Required parameters
  • -packageName: Specifies the name of the software package. (String, required)
  • -hostName: Specifies the 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 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 parameter or the -privateKeyStore parameter to authenticate. (String, optional)
  • -privateKeyStore: Specifies the path to the private key file, which is located on the deployment manager. Specify either the -adminPassword parameter or the -privateKeyStore parameter to authenticate. (String, optional)
  • -keyStorePassword: Specifies an optional password, which is also known as the pass phrase, that is used to protect the private key file. (String. Required if a non-blank password is used to protect the key file.)
  • -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.

Target object

None.

Required parameters
  • -packageName: Specifies the name of the software package. (String, required)
  • -hostName: Specifies the 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, 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)
  • -featureList: Specifies features of WebSphere Application Server Community Edition Version 2.0 to install on the remote target. (String, required)

    Specify -ServerAndSDK to install WebSphere Application Server Community Edition and the IBM SDK together.

    Specify -ServerOnly to install WebSphere Application Server Community Edition without installing the IBM SDK.
    Optional: You can specify the directory that contains a supported Java software development kit (SDK) by issuing -JAVA_INSTALL_DIR with the -specialParms parameter. If you do not specify -JAVA_INSTALL_DIR, an attempt is made to locate an IBM SDK on the workstation by default. The request to install WebSphere Application Server Community Edition fails if the centralized installation manager cannot locate a SDK.
  • -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
  • -adminPassword: Specifies the administrative password for the remote host. Specify either the -adminPassword parameter or the -privateKeyStore parameter to authenticate. (String, optional)
  • -privateKeyStore: Specifies the path to the private key file, which is located on the deployment manager. Specify either the -adminPassword parameter or the -privateKeyStore parameter to authenticate. (String, optional)
  • -keyStorePassword: Specifies an optional password, which is also known as the pass phrase, that is used to protect the private key file. (String. Required if a non-blank password is used to protect the key file.)
  • -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)
    Optionally, you can specify the following with the -specialParms parameter when you install WebSphere Application Server Community Edition Version 2.0:
    • DISABLE_OS_PREREQ_CHECKING: Set the parameter to true to disable prerequisite checking on the operating system. Set the parameter to false to enable prerequisite checking on the operating system.
    • NODE_TO_MANAGE_WASCE: Issue this parameter to designate a node on the target host as the manager of WebSphere Application Server Community Edition. This parameter is required if the target host contains multiple nodes that are augmented for WebSphere Virtual Enterprise.

    By default, the centralized installation manager selects the appropriate version of the installation package to install based on the version of the operating system. For example, if both 32-bit and 64-bit binaries are included for a certain operating system and processor architecture, the centralized installation manager installs the 64-bit installation binaries on 64-bit operating systems. To override the default behavior and use the 32-bit installation binaries on 64-bit operating systems, set the USE_32BIT_IMAGE_ON_64BIT_OS parameter to true.

  • -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 name of the remote 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
  • -fileList: Specifies a list of 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 parameter or the -privateKeyStore parameter to authenticate. (String, optional)
  • -privateKeyStore: Specifies the path to the private key file, which is located on the deployment manager. Specify either the -adminPassword parameter or the -privateKeyStore parameter to authenticate. (String, optional)
  • -keyStorePassword: Specifies an optional password, which is also known as the pass phrase, that is used to protect the private key file. (String. Required if a non-blank password is used to protect the key file.)
  • -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.

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 list the managed nodes that are located on the federated host in the current deployment manager cell.

Target object

The required target object specifies the host name of the workstation containing the managed nodes that are federated into the 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 operating system of the remote workstation. The valid types are: Windows, AIX, HP-UX, Linux, UNIX, 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)
  • -keyStorePassword: Specifies the password, which is also known as the pass phrase, that is used to protect the private key file. (String. Required if a non-blank password is used to protect the key file.)

Optional parameters

None.

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)
  • -publicKeyStore: Specifies the path to the public key file, which is located on the deployment manager, in either Internet Engineering Task Force (IETF) standard format or OpenSSH format.

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 listRequestForTarget command lists all of the submitted installation and uninstallation requests for a specific host.

Target object

The required target object the host name of the target workstation. You must specify the same host name that you specify with 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 specify with the installSoftware 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 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, 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 parameter or the -privateKeyStore parameter to authenticate. (String, optional)
  • -privateKeyStore: Specifies the path to the private key file, which is located on the deployment manager. Specify either the -adminPassword parameter or the -privateKeyStore parameter to authenticate. (String, optional)
  • -keyStorePassword: Specifies an optional password, which is also known as the pass phrase, that is used to protect the private key file. (String. Required if a non-blank password is used to protect the key file.)

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 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 parameter or the -privateKeyStore parameter to authenticate. (String, optional)
  • -privateKeyStore: Specifies the path to the private key file, which is located on the deployment manager. Specify either the -adminPassword parameter or the -privateKeyStore parameter to authenticate. (String, optional)
  • -keyStorePassword: Specifies an optional password, which is also known as the pass phrase, that is used to protect the private key file. (String. Required if a non-blank password is used to protect the key file.)

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 specify with the uninstallSoftware command.

Required parameters

None.

Optional parameters

None.

Batch mode example usage

Interactive mode example usage


The URL for this topic is: