Response file commands

You can use this reference table to learn more about response file commands.

Note: The offering id value refers to package id in the provided examples: id='offering id'.

Response file commands Description

Response file commands	Description
Profile <profile id='the profile (package group) id' installLocation='the install location of the profile'> <data key='key1' value='value1'/> <data key='key2' value='value2'/> </profile>	A profile is an installation location. Use the profile command to create a package group or installation location. If the specified package group exists, then the command has no effect. Currently, when creating the profile, the silent install creates two installation contexts: one for Eclipse and one for native. You can use the <data> element to set profile properties. The following list contains the currently supported keys and related values: The eclipseLocation key specifies an existing Eclipse location value, such as `c:\myeclipse\eclipse`.
Repositories <server> <repository location='http://example/ repository/'> <repository location="file:/C:/ repository/"> <!--add more repositories below--> <...> </server>	Use this command to specify the repositories that are used during a silent installation. Use a URL or UNC path to specify remote repositories; or use directory paths to specify local repositories.
Install <install> <offering profile= 'profile id' features= 'feature ids' id= 'offering id' version= 'version' selected='true'></offering> <!--add more offerings below> <...> </install>	Use the install command to specify the installation packages to install. The profile ID must match an existing profile or a profile created by the set profile command. Feature IDs can be optionally specified by a comma-delimited list. For example: 'feature1, feature2'. If no feature IDs are specified, the default features are installed. Note: Required features are installed even when they are not explicitly specified in the comma-delimited list. The `selected` attribute is optional. By default, `selected` is set to true. When `selected` is set to false, silent install does not install the package. While running in the wizard mode, the package displays in the package selection page but is not selected initially. The version number is not required. If no version is specified, the Installation Manager installs the latest product with the specified ID. For example, to install Product A version 1.0: <server> <repository location="http://productA/version10/repository/"> </server> <install> <offering profile= 'HCL CCM' features= 'main_feature' id= 'com.hcl.productA'</offering> </install> For example, to install Product A version 1.0.1: <server> <repository location="http://productA/version101/repository/"> </server> <install> <offering profile= 'HCL CCM' features= 'main_feature' id= 'com.hcl.productA'</offering> </install>
Update (in wizard mode) <update> <offering profile= 'profile id'> </update>	Use this command to specify the profile to update. The profile ID must match an existing profile. Note: This command can only be used in wizard mode to invoke the update wizard; it does not work in silent mode.
Modify (in wizard mode) <modify> <offering profile= 'profile id'> </modify>	Use this command to specify the profile to modify. The profile ID must match an existing profile. Note: This command can only be used in wizard mode to invoke the update wizard. The command does not work in silent mode.
Modify <install modify='true'> or <uninstall modify='true'> (optional attribute) <uninstall modify='true'> <offering profile='profile id' id='offering id' version='version' features='-'/> </uninstall>	Use the <install modify='true'> attribute on install and uninstall commands to indicate that you want to modify an existing install. The default value is false. When you are only installing additional language packs, use a hyphen "-" in the feature ID list to indicate that no new features are being added. Important: You must specify modify='true' and a hyphen '-' for the features list. If you do not, the install command installs the default features and the uninstall command removes all the features.
Uninstall <uninstall> <offering profile= 'profile id' features= 'feature ids' id= 'offering id' version= 'version'> </offering> <!--add more offerings below> <...> </uninstall> Uninstall a package without specifying a version: <uninstall> <offering profile= 'profile id' id= 'offering id'></offering> </uninstall> Uninstall all packages within a package group: <uninstall> <offering profile= 'profile id'> </offering> </uninstall>	Use the uninstall command to specify the packages to uninstall. The profile ID must match an existing profile or a profile specified in a profile command. Specifying the feature ID, offering ID or version is optional. You can specify the profile ID with none, one, two or all three of the options: feature ID, offering ID or version. For example, when there is no feature ID, offering ID or version specified, then all the features, offerings and versions in the specified profile ID are uninstalled. If you specify the profile ID and version, then the installed packages that match the profile ID and version are uninstalled. All the features and offerings that match the profile ID and version are uninstalled.
Import <import> <offering profile= 'profile id' features= 'feature id' id= 'offering id' version= 'version' selected='true'></offering> <!--add more offerings below> <...> </import>	Use the import command to specify the existing installation packages to import.
Rollback <rollback> <offering profile= 'profile id' id= 'offering id' version= 'version'> </offering> <!--add more offerings below <...> </rollback>	Use the rollback command to roll back to the specified version from the current version. You cannot specify features in a rollback command.
InstallAll <installALL/> Note: This command is equivalent to using `-silent -installAll` .	Use this command to silently search for and install all available packages.
UpdateAll <updateALL/> Note: This command is equivalent to using `-silent -updateAll` .	Use this command to silently search for and update all available packages.
License <license policyFile='policy file location' merge='true'/> For example: `<license policyFile='c:\mylicense.opt' merge='true'/>`	Use the license command to generate a response file that contains a license command. You start the license wizard after starting Installation Manager in record mode. During record mode, when you set flex options through the license management wizard, the options that you set are recorded in a license policy file named `license.opt`. The `license.opt` file is in the same directory as the generated response file and the response file contains a license command that references the policy file. Set the merge attribute to true or false. By default, the merge attribute is set to true. When set to the default setting of true, new policy data in the specified license policy is merged with the existing license policy. When set to false, the exist policy is overwritten by the policy specified in the license policy file.

Profile

<profile 
id='the profile (package group) id' 
installLocation='the install location of
 the profile'>
<data key='key1' value='value1'/>
<data key='key2' value='value2'/>

</profile>

A profile is an installation location. Use the profile command to create a package group or installation location. If the specified package group exists, then the command has no effect. Currently, when creating the profile, the silent install creates two installation contexts: one for Eclipse and one for native.

You can use the <data> element to set profile properties.

The following list contains the currently supported keys and related values:

The eclipseLocation key specifies an existing Eclipse location value, such as c:\myeclipse\eclipse.

Repositories

<server>
<repository location='http://example/
repository/'>
<repository location="file:/C:/
repository/">
<!--add more repositories below-->
<...>
      </server>

Use this command to specify the repositories that are used during a silent installation. Use a URL or UNC path to specify remote repositories; or use directory paths to specify local repositories.

Install

<install>
<offering profile= 'profile id' 
features= 'feature ids' 
id= 'offering id' version= 'version' 
selected='true'></offering>

<!--add more offerings below>
<...>

</install>

Use the install command to specify the installation packages to install.

The profile ID must match an existing profile or a profile created by the set profile command.

Feature IDs can be optionally specified by a comma-delimited list. For example: 'feature1, feature2'. If no feature IDs are specified, the default features are installed.

Note: Required features are installed even when they are not explicitly specified in the comma-delimited list.

The selected attribute is optional. By default, selected is set to true. When selected is set to false, silent install does not install the package. While running in the wizard mode, the package displays in the package selection page but is not selected initially.

The version number is not required. If no version is specified, the Installation Manager installs the latest product with the specified ID.

For example, to install Product A version 1.0:

<server>
  <repository location="http://productA/version10/repository/">
  </server>
<install>
<offering profile= 'HCL CCM' features= 'main_feature' id= 'com.hcl.productA'</offering>
</install>

For example, to install Product A version 1.0.1:

<server>
  <repository location="http://productA/version101/repository/">
</server>
<install>
<offering profile= 'HCL CCM' features= 'main_feature' id= 'com.hcl.productA'</offering>
</install>

Update (in wizard mode)

<update>
<offering profile= 'profile id'>
</update>

Use this command to specify the profile to update. The profile ID must match an existing profile.

Note: This command can only be used in wizard mode to invoke the update wizard; it does not work in silent mode.

Modify (in wizard mode)

<modify>
<offering profile= 'profile id'>
</modify>

Use this command to specify the profile to modify. The profile ID must match an existing profile.

Note: This command can only be used in wizard mode to invoke the update wizard. The command does not work in silent mode.

Modify <install modify='true'> or <uninstall modify='true'> (optional attribute)

<uninstall modify='true'>
<offering profile='profile id'
 id='offering id' version='version' 
features='-'/>
</uninstall>

Use the <install modify='true'> attribute on install and uninstall commands to indicate that you want to modify an existing install. The default value is false. When you are only installing additional language packs, use a hyphen "-" in the feature ID list to indicate that no new features are being added.

Important: You must specify modify='true' and a hyphen '-' for the features list. If you do not, the install command installs the default features and the uninstall command removes all the features.

Uninstall

<uninstall>
<offering profile= 'profile id' 
features= 'feature ids' 
id= 'offering id' version= 'version'>
</offering>

<!--add more offerings below>
<...>
</uninstall>

Uninstall a package without specifying a version:

<uninstall>
<offering profile= 'profile id' 
id= 'offering id'></offering>
</uninstall>

Uninstall all packages within a package group:

<uninstall>
<offering profile= 'profile id'>
</offering>
</uninstall>

Use the uninstall command to specify the packages to uninstall.

The profile ID must match an existing profile or a profile specified in a profile command. Specifying the feature ID, offering ID or version is optional. You can specify the profile ID with none, one, two or all three of the options: feature ID, offering ID or version.

For example, when there is no feature ID, offering ID or version specified, then all the features, offerings and versions in the specified profile ID are uninstalled. If you specify the profile ID and version, then the installed packages that match the profile ID and version are uninstalled. All the features and offerings that match the profile ID and version are uninstalled.

Import

<import>
<offering profile= 'profile id' 
features= 'feature id' 
id= 'offering id' version= 'version' 
selected='true'></offering>

<!--add more offerings below>
<...>

</import>

Use the import command to specify the existing installation packages to import.

Rollback

<rollback>
<offering profile= 'profile id'
 id= 'offering id' 
version= 'version'>
</offering>

<!--add more offerings below
<...>

</rollback>

Use the rollback command to roll back to the specified version from the current version. You cannot specify features in a rollback command.

InstallAll

<installALL/>

Note: This command is equivalent to using

-silent -installAll

Use this command to silently search for and install all available packages.

UpdateAll

<updateALL/>

Note: This command is equivalent to using

-silent -updateAll

Use this command to silently search for and update all available packages.

License

<license policyFile='policy file 
 location'  merge='true'/>

For example:

<license policyFile='c:\mylicense.opt' merge='true'/>

Use the license command to generate a response file that contains a license command. You start the license wizard after starting Installation Manager in record mode.

During record mode, when you set flex options through the license management wizard, the options that you set are recorded in a license policy file named license.opt. The license.opt file is in the same directory as the generated response file and the response file contains a license command that references the policy file.

Set the merge attribute to true or false. By default, the merge attribute is set to true. When set to the default setting of true, new policy data in the specified license policy is merged with the existing license policy. When set to false, the exist policy is overwritten by the policy specified in the license policy file.

Additional response file attributes

Response file attribute	Description
Clean <agent-input clean='true'> </agent-input>	By default, the clean attribute is set to false. Installation Manager uses the repository and other preferences that are specified in the response file as well as the existing preferences set in Installation Manager. If a preference is specified in the response file and set in the Installation Manager, the preference that is specified in the response file takes precedence. When the clean attribute is set to true, Installation Manager uses the repository and other preferences that are specified in the response file. Installation Manager does not use the existing preferences set in Installation Manager.
Temporary <agent-input clean='true' temporary='false'> </agent-input>	When the temporary attribute is set to false, the preferences that are set in your response file persist. The default value is false. When the temporary attribute is set to true, the preferences that are set in the response file do not persist. You can use the temporary and clean attributes together. For example, you set clean to true and temporary to false. After running the silent install the repository setting that is specified in the response file overrides the preferences that were previously set.
License agreement acceptance <agent-input acceptLicense='false'> </agent-input>	By default, you do not agree to accept the licenses that an installation package carries when using Installation Manager in silent installation mode. If the package you are installing has a license agreement that must be accepted, the silent installation operation fails. To accept the license agreement, you must set the attribute to <agent-input acceptLicense='true'>. By doing so, you agree to accept the license agreements for every package specified in the response file.
Reboot later <agent-input rebootLater='false'> </agent-input>	When rebootLater is set to false and the installed package requires rebooting the system on Windows™, Installation Manager reboots the system after the execution of the response file is finished. The default value is false. When rebootLater is set to true, the system does not reboot.

Response file attribute

Description

Clean

<agent-input clean='true'>
</agent-input>

By default, the clean attribute is set to false. Installation Manager uses the repository and other preferences that are specified in the response file as well as the existing preferences set in Installation Manager. If a preference is specified in the response file and set in the Installation Manager, the preference that is specified in the response file takes precedence.

When the clean attribute is set to true, Installation Manager uses the repository and other preferences that are specified in the response file. Installation Manager does not use the existing preferences set in Installation Manager.

Temporary

<agent-input clean='true' temporary='false'>
</agent-input>

When the temporary attribute is set to false, the preferences that are set in your response file persist. The default value is false.

When the temporary attribute is set to true, the preferences that are set in the response file do not persist.

You can use the temporary and clean attributes together. For example, you set clean to true and temporary to false. After running the silent install the repository setting that is specified in the response file overrides the preferences that were previously set.

License agreement acceptance

<agent-input acceptLicense='false'>
</agent-input>

By default, you do not agree to accept the licenses that an installation package carries when using Installation Manager in silent installation mode. If the package you are installing has a license agreement that must be accepted, the silent installation operation fails. To accept the license agreement, you must set the attribute to <agent-input acceptLicense='true'>. By doing so, you agree to accept the license agreements for every package specified in the response file.

Reboot later

<agent-input rebootLater='false'>
</agent-input>

When rebootLater is set to false and the installed package requires rebooting the system on Windows™, Installation Manager reboots the system after the execution of the response file is finished. The default value is false.

When rebootLater is set to true, the system does not reboot.