Control-M for Backup Installation

The following procedures describe how to install Control-M for Backup on Control-M/Agent on UNIX and Windows interactively or automatically.

If you want to install multiple instances of Control-M for Backup on several computers using the same configuration, use the automatic installation, as described in these procedures.

If the current version of Control-M/Agent is lower than 9.0.20.100 or if Blowfish encryption is used, you need to stop the Control-M for Backup after you upgrade the Agent.

Installing Control-M for Backup on Control-M/Agent on UNIX

This procedure describes how to install Control-M for Backup on Control-M/Agent on UNIX.

The default installation is interactive and uses a GUI display. XServer must be running and configured using the DISPLAY environment variable. If you do not have XServer available, BMC recommends that you continue with the console installation or perform an automatic installation.

Before You Begin

Begin

  1. Log in as the Control-M/Agent user.

  2. Type the following command to stop the Control-M/Agent:

    $CONTROLM/scripts/shut-ag -u <agentUser> -p all

    If the Control-M/Agent was installed with user root, then log in as user root every time you start up or shut down the Control-M/Agent throughout this procedure.

  3. Use one of the following modes:

    • Display: If you install using GUI (or XServer), set your DISPLAY environment variable, as described in Setting Environment Variables in UNIX.

    • Console: It is not necessary to set DISPLAY.

  4. Type one of the following commands to activate the installation script:

    • Linux: <install_source_path>/BKP.9.0.21.300_Linux-x86_64.BIN

    • AIX: <install_source_path>/BKP.9.0.21.300_AIX.BIN

  5. Do one of the following:

    • Interactive Install: Continue with the on-screen instructions until the installation is complete.

    • Automatic Install: Do the following:

      1. Continue with the on-screen instructions until the Summary window.

      2. Click Generate and select the location to create the XML parameter file.

      3. Click Yes.

      4. Copy the automatic installation parameters file to a network location that is accessible to all computers where you want to perform an automatic installation.

      5. Type the following command to activate the installation script:

        • Linux: <install_source_path>/<BKP.9.0.21.300_Linux-x86_64.BIN> -silent <filename.xml>

        • AIX: <install_source_path>/<BKP.9.0.21.300_AIX.BIN> -silent <filename.xml>

  6. The installation log is saved to the following location:

    $HOME/<username>/BMCINSTALL/log/cmbackup/BMC_Plugin_For_backUp_Install_<date-time>.log

  7. Log out of the Control-M/Agent.

  8. Log in and start the Control-M/Agent with the following command:

    $CONTROLM/scripts/start-ag -u <agentUser> -p all

Installing Control-M for Backup on Control-M/Agent on Windows

This procedure describes how to install Control-M for Backup on Control-M/Agent on Windows.

Before You Begin

Begin

  1. Log in as a user with Administrator privileges and stop the Control-M/Agent.

  2. Do one of the following:

    • From the installation path, double-click the BKP.9.0.21.300_windows_x86_64.exe file.

    • Open the command prompt as Administrator and type the following command:

      <install_source_path>\BKP.9.0.21.300_windows_x86_64.exe .

  3. Do one of the following:

    • Interactive Install: Continue with the on-screen instructions until the installation is complete.

    • Automatic Install: Do the following:

      1. Continue with the on-screen instructions until the Summary window.

      2. Click Generate and select the location to create the XML parameter file.

      3. Click Yes.

        The automatic installation XML parameters file created (<filename>.xml) is relevant only for computers with the same Control-M/Agent instance name. A separate <filename>.xml file must be created or modified manually for each Control-M/Agent instance name.

      4. Copy the automatic installation parameters file to a network location that is accessible to all Control-M/Agent computers where you want to perform an automatic installation.

      5. Run the installation script, as follows:

        <install_source_path>\BKP.9.0.21.300_windows_x86_64.exe -silent <silent.xml>

  4. Restart the Control-M/Agent.

The installation log is available at the following location:

<Control-M Agent instance directory>\BMCINSTALL\log\cmbackup\BMC_Plugin_For_BackUp_Install_<date-time>.log

If the installation fails, the log file is saved to the following location:

%temp%\BMC_Plugin_For_BackUp_Install_<date-time>.log

Uninstalling Control-M for Backup from UNIX

This procedure describes how to uninstall Control-M for Backup from UNIX.

Before You Begin

  • Stop all jobs running on Control-M/Agent.

  • Verify that all jobs have ended.

Begin

  1. From a Control-M/Agent computer, log in as a Control-M/Agent user, and type the following command to shut down Control-M/Agent:

    $CONTROLM/scripts/shut-ag -u <agentUser> -p all

    If the Control-M/Agent was installed with user root, then log in as user root every time you start up or shut down the Control-M/Agent throughout this procedure.

  2. Set your DISPLAY environment variable according to the computer name, as described in Setting Environment Variables in UNIX.

  3. Navigate to the following directory:

    $HOME/BMCINSTALL/uninstall/DRBKP.<version>/

  4. Type one of the following commands:

    • Interactive: ./uninstall.sh

    • Automatic: ./uninstall.sh -silent

  5. To restart Control-M/Agent, type the following command:

    $CONTROLM/scripts/start-ag -u <agentUser> -p all

The uninstallation log is saved to the following location:

$HOME/<username>/BMCINSTALL/log/cmbackup/BMC_Plugin_For_BackUp_Uninstall_<timestamp>.log

Uninstalling Control-M for Backup from Windows

This procedure describes how to uninstall Control-M for Backup from Windows.

Before You Begin

  • Stop all jobs running on Control-M/Agent.

  • Verify that all jobs have ended.

Begin

  1. From the Start menu, select Control Panel.

  2. Double-click Uninstall a program.

  3. Select Control-M for Backup.

  4. Click OK to continue.

The uninstallation log is saved to the following location:

BMCINSTALL\log\cmbackup\BMC_Plugin_For_BackUp_Uninstall_<timestamp>.log

Performing an Automatic Uninstall from Windows

This procedure describes how to perform an automatic uninstall of Control-M for Backup from Windows.

Before You Begin

  • Stop all jobs running on Control-M/Agent.

  • Verify that all jobs have ended.

Begin

  1. Log in to the computer using a user ID that has Administrator authorizations.

  2. From a command line, run the following command using the full path:

    <Agent Install Path>\BMCINSTALL\uninstall\DRBKP.<version>\uninstall.exe -silent

The uninstallation log is saved to the following location:
BMCINSTALL\log\cmbackup\BMC_Plugin_For_BackUp_Uninstall_<timestamp>.log

Changing the JRE Package in Control-M for Backup

This procedure describes how to change the JRE package in Control-M for Backup. The use of JRE is supported only where the major release version is the same as the tested version. For more information about Java, see Control-M External Java Installation.

Begin

  • Do one of the following:

    • UNIX: Do the following:

      1. Edit the external_java_path_9.0.21.300.dat file in the <HOME>/BMCINSTALL/ directory.

      2. Define an alternative Java home directory by modifying the value of the parameter CM_BACKUP_JAVA_HOME to the external Java path.

        CM_BACKUP_JAVA_HOME={new JRE Path}

        • A relative path is not supported.

        • The path can only include alphanumeric, period, underscore, hyphen and plus characters.

      3. Stop Control-M for Backup using the following command.

        $CONTROLM/cm/BACKUPCM/exe/cm_container.sh stop

        Control-M for Backup restarts automatically.

    • Windows: Do the following:

      1. Edit the external_java_path_9.0.21.300.dat file in the <AGENT_HOME>\BMCINSTALL\ directory.

      2. Define an alternative Java home directory by modifying the value of the parameter CM_BACKUP_JAVA_HOME to the external Java path.

        CM_BACKUP_JAVA_HOME={new JRE Path}

        • The path must be enclosed with quotation marks.

        • A network path is not supported.

        • A relative path is not supported.

        • The path can only include alphanumeric, space, period, underscore, hyphen and plus characters.

      3. Stop Control-M for Backup using the following command.

        <AGENT_HOME>\cm\BACKUPCM\exe\cm_container stop

        Control-M for Backup restarts automatically.