For example, the Control-M Agent for Windows 32-bit is DRKAI _windows.zip and 64-bit is DRKAI _windows_x86_64.zip.

Transcription

1 How to create BMC Server Automation (BSA) configuration file, depot and job objects for deploying new and upgrading existing Control-M Agents on Microsoft Windows servers This document details the steps needed to create automatic installation BSA packages for deploying new and upgrading existing Control-M Agents on Microsoft Windows Servers. It outlines the steps for Control-M Agent version , Control-M Agent 8 Fix Pack 2, and Control-M for Databases (Database Control Module). These are the latest versions as of March 2014, but the steps can be applied to subsequent versions. In order to create these packages, the BSA and Control-M administrators will need to work together as knowledge of both products is required. An understanding of Windows command line utilities and network drive mapping is also required.

2 Table of Contents Installation preparation... 3 Download the Control-M Agent installation files Run the installation manually for each desired component... 3 Generate the silent install XML input file for a clean install of an agent... 4 Actual parameters file for clean install of an agent... 5 Generate the silent install XML input file for an upgrade of an agent... 7 Actual parameters file for an upgrade of an agent... 7 Generate the silent install XML input file for a control module... 8 Actual parameters file for a control module... 8 Test the silent installation file... 9 BSA Preparation Steps Copy the install files and silent installer to the Application Server Create Depot and Job structure Create a new Configuration File Object for installed-versions.txt Depot Package Creation Steps Job Package Creation Steps Test the Job on development or QA servers Deploy to Production as necessary... 27

3 Installation preparation Download the Control-M Agent installation files. You can choose a specific platform or the ISO which includes all OS types. For Windows servers, there are separate install files for 32-bit and 64-bit systems. If downloading OS specific files, extract them. Repeat the above steps for any Control Modules that are needed. For example, the Control-M Agent for Windows 32-bit is DRKAI _windows.zip and 64-bit is DRKAI _windows_x86_64.zip. Run the installation manually for each desired component On a server with a BSA Agent, run the installation manually to generate the silent install file and save it in the same directory as setup.exe. You must use the correct OS version to run the installer, but you can use the same silent install file for both 32-bit and 64-bit as the XML is simply defining the ports, hosts, and directory. Place the silent install file underneath the Windows folder. Example screenshots are included for both a clean install and an upgrade of the Control-M Agent and a clean install of the Control Module for databases. If control modules were already installed with a Control-M 7 agent, then the agent upgrade will retain all of those control modules.

4 Generate the silent install XML input file for a clean install of an agent

5 Actual parameters file for clean install of an agent Note: On Windows clusters, the silent install will not work if running a clean install where no prior agent exists. If you are upgrading a standalone agent on each of the cluster nodes, then an upgrade will work as it selects that Control-M Agent. For cluster level agents, run the installation manually as per the release notes and installation guides. There are more parameters generated than in the GUI selections, so you do have some more flexibility to specify those options. Some of the parameters are listed in the Control-M Installation Guide on page 98 and following, but the parameters are named slightly differently in the silent install file. These options were not available in a silent install file and not all of the options were added back in to the 8.0 one. I have requested that support create a Knowledge Article describing these parameters as well as the encryption method for the password if using a named service account. Variables are stored in the registry under the following registry branches: [HKEY_LOCAL_MACHINE\SOFTWARE\BMC Software\Control-M/Agent\CONFIG] and [HKEY_LOCAL_MACHINE\SOFTWARE\BMC Software\Control-M/Agent\WIN]. Any registry changes require a restart of the Control-M Agent. There are additional values that can be set via the agent (ctmagcfg) or control module configuration utilities. <AutomatedInstallation langpack="eng"> <target.product>control-m/agent </target.product> <agent.parameters> <entry key="ctm_agent.domain" value=""/> <entry key="ctm_agent.tracker.event.port" value="7035"/> <entry key="field.agent.to.server.port.number" value="7005"/> <entry key="ctm_agent.tcp_ip.timeout" value="60"/> <entry key="install_path" value="c:\program Files\BMC Software"/> <entry key="ctm_agent.service.user.name" value=""/> <entry key="field.authorized.controlm.server.host" value="primary second third"/> <entry key="ctm_agent.logon.as.user" value="n"/> <entry key="field.server.to.agent.port.number" value="7006"/> <entry key="ctm_agent.default.printer" value=""/> <entry key="ctm_agent.jo.statistic" value=""/> <entry key="ctm_agent.service.user.password" value="passwordinplaintext"/> <entry key="field.primary.controlm.server.host" value="primary"/> </agent.parameters> </AutomatedInstallation>

6 Value in 8.0 (GUI options in Red) Description ctm_agent.domain Default: Domain from which the log in will be performed. Valid values: <domainname>," " (Blank),. (period) ctm_agent.tracker.event.port Default: 7035 The tracker event port enables CONTROL-M/Agent to receive updates regarding job status from all Control Modules that are associated with the current CONTROL-M/Agent. field.agent.to.server.port.number Default: 7005 Port number used by the CONTROL-M/Agent platform for receiving data from the CONTROL-M/Server platform Specify a numeric value from 1024 to ctm_agent.tcp_ip.timeout Default: 60 TCP/IP Timeout (in seconds). Valid values: numeric value greater than or equal to zero. INSTALL_PATH Default: <drive>\program Files\BMC Software\CONTROL-M Agent\ ctm_agent.service.user.name Default: User under which the CONTROL-M/Server service will run. Specify a user account with full privileges in the administrative group, for example, user_company.com\user.11 field.authorized.controlm.server.host Default: optional entry by end user List of authorized CONTROL-M/Servers, including the primary CONTROL-M/Server. These hosts are all authorized to submit jobs for processing. Syntax: host1 host2... hostn. The separator is a vertical line. Embedded blanks are not allowed. Example, TLVS2K038 VGW1K FPB62GSpecify a computer name, not an IP address. If no value is specified, then the installation will automatically add the primary server. ctm_agent.logon.as.user Default: N Job submission method.valid values are: Y or N Y Jobs are submitted under the user and password specified by the CTMPWD utility, or specified by the owner identification settings in the CONTROL-M Configuration Manager. N Jobs are submitted under the current user and password. field.server.to.agent.port.number Default: 7006 Port number used by the CONTROL-M/Server platform for receiving data from the CONTROL-M/Server. Specify a numeric value from 1024 to ctm_agent.default.printer Default: Default printer for job output (sysout) files. Specify a printer ctm_agent.jo.statistic Default: agent sets it as Y after installation. Flag that indicates whether job object statistics are sent to sysout. Valid values: Y or N Y Job object statistics are sent to sysout. Default. N Job object statistics are not sent to sysout. ctm_agent.service.user.password Default: Service Account password. Enter the password in plain text or this can be set via various command line utilities or BSA service object. field.primary.controlm.server.host Default: hostname of installing computer required entry by end user Name of host computer for the primary CONTROL-M/Server that handles this Agent. Specify a computer name, not an IP address.

7 Generate the silent install XML input file for an upgrade of an agent Actual parameters file for an upgrade of an agent Notice that it only requires the target product and Instance values to be populated. <AutomatedInstallation langpack="eng"> <target.product>control-m/agent </target.product> <instance> <entry key="field.instance.name" value="default"/> </instance> </AutomatedInstallation>

8 Generate the silent install XML input file for a control module Note: The Control-M Agent must already be installed. It is simply choosing the instance and then generating the install file. You cannot change the install directory as it resides underneath the agent s directory. Actual parameters file for a control module <AutomatedInstallation langpack="eng"> <target.product>control-m for Databases </target.product> <agent.instances> <entry key="field.instance.name" value="default"/> </agent.instances> </AutomatedInstallation>

9 Test the silent installation file Best practice dictates that the next step should be to test the silent installation file on a server. Testing should be done for each OS platform, type of install (clean or upgrade), and control module. Use a Command Prompt with the Run As Administrator option. Use full paths as your package will require that. <Product_name_version>\setup.exe silent <Product_name_version>\filename.xml For example, the Windows 64 bit Control-M Agent would use this command D:\DRKAI _windows_x86_64\setup.exe -silent D:\DRKAI _windows_x86_64\filename.xml Example of Control-M Agent Upgrade silent installation Example of Control Module silent installation

10 BSA Preparation Steps Copy the install files and silent installer to the Application Server 1. In the BSA console, Live Browse a server with install files on it. 2. Live Browse a BladeLogic Application Server 3. Create a new folder on the Application Server for the new installation package if necessary. Keep the name consistent with the application and version number. In this example, there is a directory called controlm for the Control-M components. Currently it has the 7.0 agent, 8.0 agent, fix pack 1, and fix pack 2.

11 4. Copy and paste source to the destination directory created above. The copy will complete in the background and you can view the progress in the bottom right corner of the console. Source: Application server

12 Create Depot and Job structure 1. Create a consistent hierarchy structure 2. Hierarchy used in this document a. Applications b. Application Name (Control-M) c. Specific OS folder (AIX, Solaris, HPUX, Linux, Windows) d. Meaningful name for component type and version so that lower level staff can deploy (DRKAI named Control-M Agent Installer (Windows) )

13 Create a new Configuration File Object for installed-versions.txt 1. Connect to a server that already has a Control-M Agent installed to create the configuration file object for installed-versions.txt. You will need to create a configuration file object using name space value grammar (nsvp_space.gm). Once created, it will appear under the Configuration branch for each server with a Control-M Agent. 2. Example of Control-M Agent with an upgraded Control-M Agent, the BPI Control Module, fix packs, and patches. PIM PLATFORM PACKAGE-DATE INSTALL-DATE VERSION INSTALL-TYPE COMMENTS DRCOB Windows Feb Apr INSTALLATION BPI CM Hotfix PACOB Windows Feb Apr BMC CONTROL-M Business Process Integration Suite FIXPACK 1 PACOB Windows_AMD64 APR Apr PATCH PACOB Windows_AMD64 DEC Apr PATCH DRKAI Windows Oct Oct INSTALLATION Agent - Upgraded from version: Previous smart number DRNDN PAKAI Windows May Oct FIXPACK Control-M/Agent FP 1 PAKAI Windows Feb Feb FIXPACK Control-M/Agent FP 2 3. Select Configuration Menu Config Object Dictionary View 4. Add a new Configuration Object

14 5. Specify Configuration File 6. Choose Windows, Browse for the File Path, and use name space value grammar (nsvp_space.gm).

15 8. Installed-versions.txt is now defined as a Configuration File and appears in the Config Object Dictionary 9. Live Browse a Server with a Control-M Agent 10. Select the Configuration Branch and view the file to determine which components are installed. It is sorted alphabetically, so the header row appears at the end.

16 Depot Package Creation Steps 1. Right Click the Windows folder. New Software Custom Software 2. Select the Installable Source by drilling down to the Application Server directory

17 3. Select Refer to source at its current location and Agent mounts source. 4. If the Application Server is Unix, then you will need to modify the Source location: of path selected during browse>

18 5. For Step 1 of 3 (Add Software) screen a. Supply the Name and Description b. If not supplying a rollback command Check the Do NOT copy source c. Add any Software information necessary d. Supply the Install and Uninstall commands i. Input files can be specified with??_<variable>?? ii.??source?? refers to the source directory location. 1. Example of a base component that can use UNC mounted paths ::Run the install from the source directory with silent install file IF %PROCESSOR_ARCHITECTURE% EQU x86 (??SOURCE??\windows\setup.exe -silent??_ctmdbcm7?? ) ELSE (??SOURCE??\windows_x86_64\setup.exe -silent??_ctmdbcm7?? )

19 2. Example of install commands for a Fix Pack. Fix Packs require actual mapped drives because a combination of batch, vbscript, and perl scripts are launched. ::Map drive and then extract just the drive letter FOR /F "usebackq tokens=2" %%i IN (`net use * "??SOURCE??" ^ find "??SOURCE??"`) do set netdrive=%%i ::Check for new drive existence if not exist %netdrive% exit 1 if exist %netdrive% echo %netdrive% has been mapped ::Check connection to the mapped drive dir %netdrive% echo %PROCESSOR_ARCHITECTURE% ::Run the Fix Pack install based on architecture IF %PROCESSOR_ARCHITECTURE% EQU x86 ( %netdrive%\windows\silent.bat -i Default ) ELSE ( %netdrive%\windows_x86_64\silent.bat -i Default ) cd /d c:\ net use %netdrive% /del

20 e. Add the silent installer support file. The name will appear under the Support Files section at the bottom of the page. Click the Edit (Pencil on Document) icon to select the file location. 6. Modify Properties if desired 7. Set appropriate permissions 8. Finish

21 Job Package Creation Steps 1. Right Click the Windows folder. New Software 2. Provide a Name and Description that matches the Depot package name

22 3. Select the Install Software. The location starts where you last choose an install software location. 4. Leave Selected Targets blank as you will Execute Against specific servers

23 5. Select Notifications as desired 6. Leave Phases and Schedules alone 7. Change Logging Level to All Information when first testing a job and then change back to Errors and Warnings or Errors Only.

24 8. If no uninstall or rollback command is available, uncheck the rollback options 9. Modify Properties if desired 10. Set appropriate permissions 11. Finish

25 Test the Job on development or QA servers 1. Right Click the Job 2. Show Results to bring up the results window 3. Right Click the Job again to Execute Against 4. Filter on the Available targets to match the target servers 5. View the results a. Select the job run b. Select the Commit stage c. Show Details d. If no issues, then you should see all green checkmarks as well as successful messages in the Details for the Commit step.

26 e. Examine the Log messages and compare to output from manual silent installation steps. 6. If issues are found, correct them and rerun the job against failed targets

27 Deploy to Production as necessary Repeat any steps from testing. Continue to refine or create new packages as necessary for later components.