Remote Install - Advanced

Table of Contents

Installing on Clients in a Domain by Manually Selecting the Computers

You can install the software on specific computers residing on one or more domains, such as Open LDAP and Windows Active Directory domains.

Prerequisites

During installation, you need to provide a user account with sufficient privileges to install the software on all the selected clients. Therefore, make sure that the user account has the following rights:

  • Administrative rights to each of the client in which the software will be installed.
  • Read-access to the computer from which the software is installed. (For example, if you have the source downloaded or available in a central location.)

Steps

When you reach the Enter the host names of the computers page of the installation wizard, use the following steps to specify the computers from a domain:

  1. On the Enter the host names of the computers page, click Import From Active Directory. The Enter Active Directory Server Information dialog box is displayed.
  2. On the Enter Active Directory Server Information dialog box, complete the following steps:
    1. In the Select Directory Service list, select the type of directory service.
    2. In the Server Name box, type or select the fully qualified domain name.
    3. In the User Name box, enter the name of the user account to access the directory server.
    4. In the Password box, enter the password associated with the user account you specified.
    5. If an external domain has been configured, you can use the LDAP Filter box for the following:
      • To install only on client computers that are displayed in the filtered container.

        For example, assume that you have a mycompany as your filter with purple.company.com, maroon.company.com and red.company.com of client computers. Type mycompany in the LDAP Filter box to install the software on the list of computers available in the mycompany filter.

      • To perform a wildcard character search within the Active Directory.

        For example, the following query string will search for all objects of type mycomputer with a name that begins with dev.

        &(objectCategory=mycomputer)(name=dev*))

        For more information on query filters, refer to Microsoft article at http://msdn.microsoft.com/en-us/library/ms675768(VS.85).aspx

      • To perform an Organizational Unit (OU) based search, use # as the delimiter for the query.

        For example, the following query string lists all the computers in the Sales unit starting with 's'.

        OU=Sales#(&(objectClass=computer)(name=s*))

        Where:

        OU=Sales - This will list all the computers under Sales unit.

        name=s* - This will list all the computers starting with 's'.

        If your filter query contains the letters ou then you need to use # at the beginning of the filter query.

        For example, userAccountControl contains the letter ou, so the filter query will be:

        #(& (!userAccountControl:1.2.840.113556.1.4.803:=2) (name=a*))

    6. Click OK.

      The Discovered Computers dialog box is displayed.

  3. On the Discovered Computers dialog box, select the check box next to the computers that you want to include and then click Add.

  4. On the Enter the host names of the computers page, click Next.
  5. Proceed with the installation.

Installing on Clients in a Domain Using Auto Discovery

You can use the auto discovery method to identify the domains where the computers that should receive the software packages reside. Once identified, you can install the software on all the computers residing in the domain.

Prerequisites

During installation, you need to provide a user account with sufficient privileges to install the software on all the selected clients. Therefore, make sure that the user account has the following rights:

  • Administrative rights to each of the client in which the software will be installed.
  • Read-access to the computer from which the software is installed. (For example, if you have the source downloaded or available in a central location.)

Steps

When you reach the Select how to discover the computers for installing the software page of the installation wizard, use the following steps to specify the computers from a domain:

  1. On the Select how to discover the computers for installing the software page, click Automatically discover computers and then click Next.
  2. On the Active Directory Server Configuration page, click Add. The Add Active Directory Server dialog box is displayed.
  3. On the Add Active Directory Server dialog box, complete the following steps:
    1. In the Select Directory Service list, select the type of directory service.
    2. In the Server Name box, type or select the fully qualified domain name.
    3. In the User Name box, enter the name of the user account to access the directory server.
    4. In the Password box, enter the password associated with the user account you specified.
    5. If an external domain has been configured, you can use the LDAP Filter box for the following:
      • To install only on client computers that are displayed in the filtered container.

        For example, assume that you have a mycompany as your filter with purple.company.com, maroon.company.com and red.company.com of client computers. Type mycompany in the LDAP Filter box to install the software on the list of computers available in the mycompany filter.

      • To perform a wildcard character search within the Active Directory.

        For example, the following query string will search for all objects of type mycomputer with a name that begins with dev.

        &(objectCategory=mycomputer)(name=dev*))

        For more information on query filters, refer to Microsoft article at http://msdn.microsoft.com/en-us/library/ms675768(VS.85).aspx

      • To perform an Organizational Unit (OU) based search, use # as the delimiter for the query.

        For example, the following query string lists all the computers in the Sales unit starting with 's'.

        OU=Sales#(&(objectClass=computer)(name=s*))

        Where:

        OU=Sales - This will list all the computers under Sales unit.

        name=s* - This will list all the computers starting with 's'.

        If your filter query contains the letters ou then you need to use # at the beginning of the filter query.

        For example, userAccountControl contains the letter ou, so the filter query will be:

        #(& (!userAccountControl:1.2.840.113556.1.4.803:=2) (name=a*))

    6. Click OK.

      The Discovered Computers dialog box is displayed.

  4. On the Discovered Computers dialog box, select the check box next to the computers that you want to include and then click Add.
  5. On the Enter the host names of the computers page, click Next.
  6. On the Enter Account Information page, click Next to reuse the Active Directory credentials.

    The Reuse Active Directory credentials check box is selected by default to reuse the account information specified during the Active Directory Server Configuration.

    If an external domain has been configured, deselect the Reuse Active Directory credentials and enter the Account Information and then click Next.

  7. Proceed with the installation.

Install Software on Specific Clients

You can install the software on specific clients by doing one of the following operations:

  • Importing a file containing the list of clients that you want to include.
  • Selecting clients that are already part of your CommCell from a list generated by the CommCell Console.

Importing from File

When you reach the Enter the host names of the computers page of the installation wizard, use the following steps to retrieve a list of clients from a text file:

The text file must list the client name as a fully qualified domain name (e.g., mycomputer.mydomain.mycompany.com) and list each client name on one line.

  1. On the Enter the host names of the computers page, click Import From File. The Select File dialog box is displayed.
  2. On the Select File dialog box, locate the text file containing the client information and then click Select File.

  3. On the Enter the host names of the computers page, click Next.
  4. Proceed with the installation.

Selecting from Existing Clients

When you reach the Enter the host names of the computers page of the installation wizard, use the following steps to install the software on clients that are already part of your CommCell:

  1. On the Enter the host names of the computers page, click Select from existing clients. The Select from existing clients dialog box is displayed.
  2. On the Select from existing clients dialog box, select the check box next to the clients that you want to include and then click OK.

  3. On the Enter the host names of the computers page, click Next.
  4. Proceed with the installation.

Installing Additional Software Packages on a Client

The Install Wizard allows you to install additional software packages(s) on any client in your CommCell environment.

See Getting Started to launch the Install Wizard and install additional components on a client.

Configuring the Timeout Duration for Remote Install

The default timeout for software install from the CommCell Console is 120 minutes. To configure a different timeout value, use the following steps:

  1. From the CommCell Browser, right-click the <CommServe> node and then click Properties.
  2. On the CommCell Properties dialog box, click the Additional Settings tab and then click Add.
  3. On the Add Additional Settings on Windows Client dialog box, complete the following steps:
    1. In the Name box, type nPushInstallTimeoutInMin. The Category and Type details will be automatically populated.

      Alternatively, you can click Lookup and select the registry key.

    2. In the Value box, type the time out duration in minutes.
    3. Click OK.
  4. Click OK to close the CommCell Properties dialog box.

Managing CommServe Cache

When you download the latest service pack from FTP site or when you copy the service pack using the CopyToCache tool, it is first placed in a temporary cache location called Staging Cache. Once the latest service pack is installed on the CommServe computer, it is automatically moved to the CommServe software cache directory and made available for remote installs.

To install the software from the CommCell Console, the software packages must be available in the CommServe Cache directory. To configure the CommServe software cache, see Configuring the CommServe Cache Directory.

For more information on managing the software cache, see CommServe Cache, Remote Cache, and Populating the Cache.

Multi-Instancing

You can install more than one instance of the software on a client computer by enabling the Install new Instance (if required) option. The option is located in the Enter Additional Install Options page of the installation wizard.

When you enable or disable the Install new Instance (if required) option, the installation behavior and the usage of the ports depend on the port numbers that are being used by the existing instance on the client computer.

The following table outlines the installation behavior when you use the Install new Instance (if required) option while performing remote installs:

Instance and Ports Install Behavior
When the existing instance on the client computer is not using the default port number selected during the current installation. The current instance will be installed with the next available port numbers .
When the existing instance on the client computer is not using the port numbers specified during the current installation The current instance will be installed with the specified port numbers
When the existing instance on the client computer is already using the default port numbers selected during the current installation. The current instance will be installed with the next available ports.
When the existing instance on the client computer is already using the port numbers selected during the current installation. The current installation will be successful only if you specify the same CommServe name that is being used by the existing instance; else, the installation will not succeed.

The following table outlines the installation behavior when you do not enable Install new Instance (if required) option:

Instance and Ports Install Behavior
When the existing instance on the client computer is not using the default port number selected during the current installation. Installation will not be successful.
When the existing instance on the client computer is not using the port numbers specified during the current installation Installation will not be successful.
When the existing instance on the client computer is already using the default port numbers selected during the current installation. The current installation will be successful only if you specify the same CommServe name that is being used by the existing instance on the client computer; else, the installation will not succeed.
When the existing instance on the client computer is already using the port numbers selected during the current installation. The current installation will be successful only if you specify the same CommServe name that is being used by the existing instance on the client computer; else, the installation will not succeed.

Related Reports

Administrative Job Summary Report

The following procedure provides the steps necessary to run an Administrator job summary report that provides report of all administrative jobs that ran in the CommCell during the specified time period.

  1. From the CommCell Browser, click the Reports tab and then click the Summary icon.
  2. From the General tab, click Administrative Jobs and then select Install/Upgrade/Remove/Repair Software option.
  3. Click Run.

    The report appears in your default Web browser.

CommCell Configuration Report

The following procedure provides the steps necessary to run a CommCell Configuration job summary report that displays a summary of the CommCell configuration.

  1. From the CommCell Browser, click the Reports tab, and then click the Summary icon.
  2. On the left-pane, select CommCell Configuration and then select Remote Software Cache and Update Service Pack Information check boxes on the right-pane.
  3. Click Run.

    The report appears in your default Web browser.

Installing Software from Command Line

Remote installations can also be performed from the command line interface. Command line installs are extremely useful in the following scenarios:

  • Remote installations can be performed simultaneously on multiple clients.
  • You can reuse the scripts to perform remote installs on additional clients. This is made possible by modifying the client names in the script.
  • If the installation fails due to modified security settings on the client, the script file can be updated with the latest security settings and restart the installation.

Generate Command Line Script for Remote Install

In order to perform remote installs from the command line, you need to select the required options from the CommCell Console and save it as a script (xml) file. The script can be modified as required and then executed from the command line interface.

Use the following steps to generate the script to perform the installation.

  1. From the CommCell Browser, click Tools | Add/Remove Software | Install Software.
  2. Follow the Install Wizard to select the required configurations.

    When you reach the Summary page, click Save As Script.

  3. On the Save as Script dialog box, in the Path box, enter the path where you want to save the script file (the file should have the .bat extension). See example below.

    c:\myscripts\install_script1.bat

    The script will be saved as a .xml file and .bat file. By default, these files cannot be overwritten if they already exist. If you want to enable file overwrite, use the steps described in the Configuring Save As Script Properties section.

    By default, the user account which you have used to login to CommCell console is used for performing the installation of software. However, if the user account does not have necessary privileges, click Use a different account.

    • In the User Name box, type the account name that has privileges to perform installation.
    • In the Password box, type the password for the specified account.
    • In the Confirm Password box, retype the password.

Log on to CommServe

To run command line operations, you must first login to the CommServe.

From Command prompt, navigate to <Software_Installation_Directory>/Base and run the following command:

qlogin -cs <commserve name> -u <user name>

For example, to log on to CommServe 'server1' with username 'user1':

qlogin -cs server1 -u user1

Perform Remote Install from the Command Line

Use the following steps to perform remote install from command line:

  1. Execute the saved .xml script using qoperation execute command.

    qoperation execute -af remote_install.xml

  1. Verify the status of the job using the following command:

    qlist job −j jobID

  2. Once the job completes, log off from the CommServe using the qlogout command.

    qlogout [−cs <commserve_host_name>] [−all] [−tf <tokenfile>] [−tk <token>] [−h]

For a detailed description of the parameters, see the following table:

Parameter Description of Parameter Values
clientName Short name of the client computer.
taskType Option to specify when to run this job.

Valid values are IMMEDIATE/SCHEDULE

installOSType Type of the Operating System on a client computer.

Valid values are WINDOWS/UNIX

discoveryType Option to manually select or discover the clients for installing the software

Valid values are MANUAL/AUTO_DISCOVER

userName

(under User node)

User account to be used for performing the install operation.
hostName Fully qualified domain name of the CommServe. (e.g., xyz.domain.company.com)
overrideSoftwareCache Option to enable the provision of an alternate software cache if the current client or client groups settings are not accurate.

Valid values are TRUE/FALSE

path Option to specify the path to the client's job results directory that is used to store the client's backup and restore job results.
cvdPort Optional.

TCP port number to be used  by the Communication Service (CVD).

Default value: 8400

evmgrcPort Optional.

TCP port number to be used by the Client Event Manager Service (EvMgrC).

Default Value: 8402

installDirectory Option to specify the location where you want to install the software.
ComponentName components to be installed.
globalFilters Optional.

This option is used to filter out specific directories or files from the backups within the CommCell. The filters are set using the Control Panel in the CommCell Console and, if enabled, they will be effective for the default subclient.

Valid values are:

  • UseCellLevelPolicy, to enable Global Filters on the subclient when the Use Global Filters on All Subclients option is enabled. If the Global Filters on All Subclients are disabled, then the UseCellLevelPolicy option will disable Global Filters on the subclient.
  • AlwaysUseGlobalFilters, to enable Global Filters for for the associated subclients.
  • DoNotUseGlobalFilters, to disable Global Filters for the associated subclients.
forceReboot This option is used to reboot the computer if required.

Valid values are TRUE/FALSE

killBrowserProcesses Option for enabling closing of Browser processes.

Valid values are TRUE/FALSE

ignoreJobsRunning Option to specify if the software can be installed on the selected client/MediaAgent as per schedule even if jobs are currently running. If enabled, services will be stopped, thereby suspending the running jobs to allow the install to complete. Upon completion of the install, the restartable jobs will automatically resume, if configured to do so.

Valid values are TRUE/FALSE

skipClientsOfCS Option to skip installation on client computers that are already part of the CommCell.

Valid values are TRUE/FALSE

deletePackagesAfterInstall Option to automatically delete the software packages from the cache directories once the installation operation completes.

Valid values are TRUE/FALSE

overrideClientInfo Option to ignore the name conflict between the host and client computer during installation.

Valid values are TRUE/FALSE

restoreOnlyAgents Option to install the software for restore only without consuming the licenses.

Valid values are TRUE/FALSE

userName

(under ClientAuthForJob node)

User name for accessing the client.
password

(under ClientAuthForJob node)

Password for accessing the client.

Installing Updates from Command Line

Use the following steps to install the updates on multiple clients using Save As Script:

For Windows

  1. From the CommCell Browser, click Tools, point to Add/Remove Software and then click Install Updates.
  2. On the Install Updates Options dialog box, select the Client Computer(s) on which you want to install the updates.
  3. Select the Reboot Client check box to allow the computer to reboot after installing the updates.

    When the Reboot Client check box is selected, the system automatically reboots the client and/or MediaAgent computers if a reboot is required.

    If the install update or upgrade includes a driver update, all the updates required for the computer will not be installed if this option is cleared.

  1. Click the Job Initiation tab and click Save As Script.
  2. On the Save As Script dialog box, specify the following:
    • In the Client list, click the client on which you want to save the script.
    • In the Path box, type the path and name for the .bat file to be saved e.g., E:\Install_Script\input_file.bat
    • For Mode, by default Synchronous option is selected which exits only when the operation has completed.

      Select Asynchronous option, to submit the job to the CommServe and exit immediately; returns the control to the calling program or script.

    • Click OK to save the operation as a script file.

      This generates a .xml file and a .bat file.

  3. To automatically login and install updates on the client, use the following steps:
    • From the command prompt, navigate to the location where the .bat and .xml files are saved and then run the .bat file.

      For Example:

      E:Scripts>\input_file.bat

      where,

      The .bat file contains the following commands and performs the following operation:

      qlogin - to login to the session

      qoperation execute - to execute the xml script

      qlogout - to logout from the session

      The .xml file is the script file that contains information on the options selected from the CommCell Console. This .xml file is given as input to the qcommand execute in the batch file.

  4. To install updates using qoperation execute command, perform the following from the command prompt:
    • Login to the CommServe using the qlogin command and CommCell credentials:

      E:\Script\> qlogin -cs commserve_name -u user_name

    • Run the following execute operation using qoperation:

      qoperation execute -af <xml_file>

      For Example:

      qoperation execute -af input_file.xml

  5. To override the client name specified in the .xml file or to install the same updates to multiple clients, run the following command:

    <batch_file> -updateOption/clientAndClientGroups/clientName <client_name>

    For Example:

    input_file.bat -updateOption/clientAndClientGroups/clientName myclient.mydomain.mycompany.com

For Unix

  1. From the CommCell Browser, click Tools, point to Add/Remove Software and then click Install Updates.
  2. On the Install Updates Options dialog box, select the Client Computer(s) on which you want to install the updates.
  3. Select the Reboot Client check box to allow the computer to reboot after installing the updates.
  1. Click the Job Initiation tab and then click Save As Script.
  2. On the Save As Script dialog box, specify the following:
    • From the Client list, select the client on which you want to save the script.
    • In the Path box, type the path and name for the .bat file to be saved e.g., /opt/input_file.bat
    • For Mode, by default Synchronous option is selected which exits only when the operation has completed.

      Select Asynchronous option, to submit the job to the CommServe and exit immediately; returns the control to the calling program or script.

    • Click OK to save the operation as a script file.

      This generates two files input_file.xml and input_xml file.

  1. To login automatically and install updates on the client, perform the following:
    • From the command prompt, navigate to the location where the script files are located and then run the script file.

      For Example:

      [root@localhost Scripts]# ./input_file

      where,

      The script file contains the following commands and performs the following operation.

      qlogin - to login to the session

      qoperation execute - to execute the xml script

      qlogout - to logout from the session

      The .xml file is the script file that contains information on the options selected from the CommCell Console. This .xml file is given as input to the qcommand execute in the batch file.

  2. To install updates using qoperation execute command, perform the following from the command prompt:
    • Login to the CommServe using the qlogin command and CommCell credentials:

      [root@localhost Script]#./qlogin -cs commserve_name -u user_name

    • Run the following execute operation using qoperation:

      ./qoperation execute -af <xml_file>

      For Example:

      ./qoperation execute-af input_file.xml

  3. To override the client name specified in the .xml file or to install the updates to multiple clients, run the following command:

    ./<batch_file> -updateOption/clientAndClientGroups/clientName <client_name>

    For Example:

    ./input_file -updateOption/clientAndClientGroups/clientName myclient.mydomain.mycompany.com