Control-M/Server Installation
If you have additional load balancing and geo-redundancy requirements, you can install multiple instances of Control-M/Server.
Before you install Control-M/Server, verify the requirements, as described in Control-M/Server System Requirements.
If you are installing Control-M/Server on UNIX, complete the pre-installation procedures, as described in Control-M/Server Pre-installation Procedures on UNIX and the post-installation procedures, as described in Control-M Post-installation Procedures on UNIX, as described inConfiguring the Automatic Startup/Shutdown Procedure for Control-M/Server on UNIX.
You can install Control-M/Server with one of the following options:
-
Default: Installs Control-M/Server with a dedicated BMC-supplied PostgreSQL database server, default database name, default username and default ports.
-
Custom: Enables you to select a database server, database name, username and ports.
The Control-M/Server installation includes a local installation of Control-M/Agent, which is critical to the functionality of Control-M/Server. To avoid potential corruption to the product, do not uninstall, disable, or delete this Agent.
-
If you are installing Control-M/Server with a PostgreSQL database on the same host where Control-M/EM with a PostgreSQL database was installed, you must use a different port for the second database instance.
-
If you are installing Control-M/EM and Control-M/Server on the same host or installing multiple instances of Control-M/Server on the same host (UNIX only), you must configure the Zookeeper and Kafka services to use different ports on Control-M/EM and on the additional Control-M/Server instances, as described in KA 000374213.
-
If you are installing Control-M/EM and Control-M/Server on the same Windows host, BMC recommends that you install them on the same home directory to avoid multiple Kafka installations.
The following procedures describe how to install Control-M /Server on UNIX and Windows via an interactive or automatic installation:
Control-M/Server System Requirements
Before you install Control-M/Server, verify that your operating system, processor, and database server are supported and have the correct amount of memory and disk space. For a full list of requirements, see the Control-M 9.0.22 Release Notes.
Verify that your system meets one of the following requirements:
Control-M/Server UNIX System Requirements
The following table lists the prerequisite requirements for a UNIX platform.
These values represent the minimum requirements for an entry level deployment. For higher capacity workloads, add resources.
|
Resource |
Specification |
Requirement |
|---|---|---|
|
Compatible Processors |
AIX |
|
|
Linux |
x86_64 |
|
|
Memory |
N/A |
Depends on the size of your production environment:
For more information about these sizes, see Control-M/Server Production Size. You need an additional 4 GB if the database is on the same host as Control-M/Server. |
|
Disk Space |
N/A |
40 GB Upgrade: 7 GB If you are installing Control-M with a remote database server, you must have 5 GB free on the database server. BMC Software recommends that you reserve 1.5 times the amount of RAM in the system for swap space. |
|
CPU |
4 vCPU |
100 SPEC rating (2006_int_rate) |
|
Database |
N/A |
Control-M/Server Windows System Requirements
The following table lists the prerequisite requirements for a Windows platform.
These values represent the minimum requirements for an entry level deployment. For higher capacity workloads, add resources.
|
Resource |
Requirement |
|---|---|
|
CPU |
4 vCPU 100 SPEC rating (2006_int_rate) |
|
Compatible Processors |
x86_64 processors:
|
|
Display |
16-bit (65,536) colors or higher |
|
Memory |
Depends on the size of your production environment:
For more information about these sizes, see Control-M/Server Production Size. You need an additional 4 GB if the database is on the same host as Control-M/Server. |
|
Disk Space |
40 GB Upgrade: 7 GB If you are installing Control-M with a remote database server, you must have 5 GB free on the database server. BMC Software recommends that you reserve 1.5 times the amount of RAM in the system for swap space. |
|
Database |
Control-M/Server Production Size
The following table summarizes the criteria that determine production environment size categories.
| Measurement |
Small |
Medium |
Large |
|---|---|---|---|
|
Active jobs |
0–15,000 |
14,000–75,000 |
70,000–150,000 |
|
Job executions per day |
0–15,000 |
14,000–75,000 |
70,000–150,000 |
Control-M/Server Pre-installation Procedures on UNIX
Before you install Control-M/Server, you need to complete the following procedures:
-
Configuring a User Account on UNIX: Describes how to configure specific parameters for Control-M/Server.
-
Setting Environment Variables in UNIX: Describes how to set environment variables in UNIX, which enables you to see messages from the console.
-
PostgreSQL UNIX Kernel Parameters: Describes how to modify AIX and Linux system parameters, which enables you to allocate resources for Control-M components.
-
Setting the Java Environment Variable: Describes how to set the Java environment variable, which points to an external Java installation.
-
Verifying Operating System Levels and Patches: Describes how to verify operating system level and patches with Control-M/Server requirements.
Installing Control-M/Server on UNIX
This procedure describes how to install Control-M/Server on UNIX. You can install with the default settings, or choose the custom installation to select the database server, database names, usernames, hostnames, and port settings. If you want to install multiple instances of Control-M/Server on several hosts using the same configuration, use the automatic installation, as described in this procedure.
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
Ensure that you have met the following requirements:
-
Verify that your operating system and database software is compatible with the current version of Control-M/Server, as described in Control-M/Server UNIX System Requirements.
-
Successful completion of Control-M/Server Pre-installation Procedures on UNIX.
-
Verify that you have met Java requirements, as described in Control-M External Java Installation.
-
If you are installing on cluster environment, see Control-M/Server UNIX Cluster Configuration.
-
If you are running the Kafka service, a bash shell must be installed before you install Control-M/Server.
Begin
-
Copy the installation files from the temporary directory that you created in Obtaining Control-M installation files, to the home directory.
-
Set your DISPLAY environment variable, as described in Setting Environment Variables in UNIX.
-
From your home directory, run the following command:
<source_path>/setup.sh
-
Do one of the following:
-
Interactive Installation: Select the Control-M/Server option and continue with the on-screen instructions until the installation is complete.
-
Automatic Installation: Create a parameter file and then run the automatic install in a non-interactive mode, as follows:
-
Select the Control-M/Server option and continue with the on-screen instructions until the Summary window.
-
Click Generate and select the location where the XML parameter file is created.
-
Click Yes to quit the installation.
A confirmation message appears.
-
Click Yes.
-
Copy the automatic installation parameters file to a network location that is accessible to all hosts where you want to perform an automatic installation.
-
To run the installation script, run the following command:
<source_path>/Setup_files/components/ctm/setup.sh -silent <xml_path>/<filename.xml>
If you want to encrypt a password in the installation, run the following command:
<source_path>/Setup_files/components/ctm/setup.sh -encrypt <password>
The installation log can be found at the following location:
<$HOME>/BMCINSTALL/log/BMC_Control-M_Server_<date-time>.log
The backup file is available in the following location:
$HOME/BMCINSTALL/uninstall/DRCTV.9.0.22/backup_area
-
-
-
Continue with Automatic Startup/Shutdown Procedure for Control-M/Server on UNIX.
If you installed Control-M/Server on NFS, you can only use the Control-M/Server user on the same host where Control-M/Server was installed. -
If a firewall is active, perform the steps described in System Configuration.
By default, Control-M/Server is configured to work with TCP. To secure your environment, BMC recommends to change your configuration to SSL, as described in Zone 2 and 3 SSL Configuration.
Installing a Control-M/Server Fix Pack on UNIX
This procedure describes how to install a Control-M/Server fix pack on UNIX.
-
You must install this patch on every host where Control-M/Server is installed.
-
In a High Availability environment, you must install this fix pack on active and non-active hosts.
Before You Begin
-
Ensure that you have already installed Fix Pack PAOST.9.0.22.100, as indicated in the <CTM_Home>/installed_versions.txt file or (in a Control-M Full Installation) the <HOME>/installed_versions.txt file.
-
Verify that Control-M/Server 9.0.22 is installed before you install this fix pack.
Begin
-
Log in to the account where Control-M/Server is installed and copy the installation files from the temporary directory that you created in Obtaining Control-M installation files, to a temporary directory on your local hard drive (not a network drive).
-
Extract the package with the following command:
unzip PACTV.9.0.22.100.zip
-
In a High Availability environment, stop the Control-M/Server Configuration Agent on the non-active environment to avoid automatic failover.
-
Navigate to the following directory:
<Extracted_Directory>/PACTV.9.0.22.100
-
Do one of the following:
-
Interactive Installation: Run the following command:
./install_patch.sh
-
Automatic Installation: Run the following command:
./install_patch.sh -s
-
-
Follow the on-screen instructions until the installation is complete.
The installation file shuts down the Control-M/Server components, installs the patch, and restarts the components.
-
In a High Availability environment, do the following:
-
Verify that the Control-M/Server Configuration Agent on the non-active environment is up after the installation completes.
-
Repeat the entire procedure on the non-active environment.
-
Installing Control-M/Server on Windows
This procedure describes how to install Control-M/Server on Windows. You can install with the default settings, or choose the custom installation to select the database server, database names, usernames, hostnames, and port settings.
If you want to install multiple instances of Control-M/Server on several hosts using the same configuration, use the automatic installation, as described in this procedure.
If Control-M/EM and Control-M/Server are installed on the same Windows host ( including cluster), they must be installed on the same drive.
Before You Begin
-
Ensure that your operating system and database software is compatible with the current version of Control-M/Server, as described in Control-M/Server Windows System Requirements.
-
Verify that you have met Java requirements, as described in Control-M External Java Installation.
-
If you are installing on cluster environment, see Control-M/Server Windows Cluster Configuration
Begin
-
Log in to the host using a user ID that has Administrator permissions.
-
Copy the installation files from the temporary directory that you created in Obtaining Control-M installation files, to the home directory.
-
From a command prompt window, run the following command:
<source_path>\setup.exe
-
Do one of the following:
-
Interactive Installation: Select the Control-M/Server option and continue with the on-screen instructions until the installation is complete.
-
Automatic Installation: Create a parameter file and then run the automatic install in a non-interactive mode, as follows:
-
Select the Control-M/Server option and continue with the on-screen instructions until the Summary window.
-
Click Generate and select the location to create the XML parameter file.
-
Click Yes to quit the installation.
A confirmation message appears.
-
Click Yes.
-
Copy the automatic installation parameters file to a network location that is accessible to all hosts where you want to perform an automatic installation.
-
Log in using a user ID that has Administrator permissions on the current host.
Run the following installation script:
<source_path>\Setup_files\components\ctm\setup.exe -silent <xml_path>\<filename.xml>
If you want to encrypt a password in the installation, run the following command:
<source_path>\Setup_files\components\ctm\setup.exe -encrypt <password>
The installation log can be found at the following location:
<installFolder>\BMCINSTALL\log\BMC_Control-M_Server_<date-time>.log
The backup file is available in the following location:
<Install Directory>\BMCINSTALL\uninstall\DRCTV.9.0.22\backup_area
-
-
-
If a firewall is active, perform the steps described in System Configuration.
By default, Control-M/Server is configured to work with TCP. To secure your environment, BMC recommends to change your configuration to SSL, as described in Zone 2 and 3 SSL Configuration.
Installing a Control-M/Server Fix Pack on Windows
This procedure describes how to install a Control-M/Server fix pack on Windows.
-
You must install this patch on every host where Control-M/Server is installed.
-
In a High Availability environment, you must install this fix pack on active and non-active hosts.
Before You Begin
-
Ensure that you have already installed Fix Pack PAOST.9.0.22.100, as indicated in the <CTM_Home>\installed_versions.txt file or (in a Control-M Full Installation) the <HOME>\installed_versions.txt file.
-
Verify that Control-M/Server 9.0.22 is installed before you install this fix pack.
Begin
-
Log in to the account where Control-M/Server is installed and copy the installation files from the temporary directory that you created in Obtaining Control-M installation files, to a temporary directory on your local hard drive (not a network drive), and then extract the package to c:\temp.
-
In a High Availability environment, stop the Control-M/Server Configuration Agent on the non-active environment to avoid automatic failover.
-
Navigate to the following directory:
c:\temp\PACTV.9.0.22.100
-
Do one of the following:
-
Interactive Installation: Run the following command:
install_patch.bat
-
Automatic Installation: Run the following command:
install_patch.bat -s
-
-
Follow the on-screen instructions until the installation is complete.
The installation file shuts down the Control-M/Server components, installs the patch, and restarts the components.
-
In a High Availability environment, do the following:
-
Verify that the Control-M/Server Configuration Agent on the non-active environment is up after the installation completes.
-
Repeat the entire procedure on the non-active environment.
-
Uninstalling Control-M/Server from UNIX
This procedure describes how to uninstall Control-M/Server from UNIX.
Before You Begin
Ensure that all jobs have ended.
Begin
-
Log in as a Control-M/Server user.
-
Navigate to the following directory:
<ctmserver_InstallFolder>/BMCINSTALL/uninstall/
-
Do one of the following:
-
Interactively Uninstall: Run the following command:
DRCTV.9.0.22/uninstall.sh
-
Automatically Uninstall: Run the following command:
DRCTV.9.0.22/uninstall.sh -silent
Control-M/Server is successfully removed from your host. If you downgraded, Control-M components are up and running.
-
Uninstalling a Control-M/Server Fix Pack from UNIX
This procedure describes how to uninstall a Control-M/Server fix pack from UNIX.
In a High Availability environment, you must uninstall the fix pack from active and non-active hosts.
Begin
-
Log in to the account where Control-M/Server is installed.
-
In a High Availability environment, stop the Control-M/Server Configuration Agent on the non-active environment to avoid automatic failover.
-
Navigate to the following directory:
<Control-M/Server_Home>/patches/PACTV.9.0.22.100
-
Run the following command:
./uninstall_patch.sh
The uninstall file shuts down your Control-M/Server components, uninstalls the patch, and restarts the components.
-
In a High Availability environment, run the following command on the non-active environment:
./uninstall_patch.sh
The uninstall file shuts down your Control-M/Server components, uninstalls the fix pack, and restarts the components.
-
Verify that the Control-M/Server Configuration Agent on the non-active environment is up after the uninstallation completes.
Uninstalling Control-M/Server from Windows
This procedure describes how to uninstall Control-M/Server from Windows.
Before You Begin
Ensure that all jobs have ended.
Begin
-
From the Start menu, select Control Panel.
-
Double-click Programs and Features.
-
Select Control-M/Server 9.0.22, and click Uninstall.
-
Click OK to continue.
Control-M/Server is successfully removed from your host. If you downgraded, Control-M components are up and running.
Uninstalling a Control-M/Server Fix Pack from Windows
This procedure describes how to uninstall a Control-M/Server fix pack from Windows.
In a High Availability environment, you must uninstall the fix pack from active and non-active hosts.
Begin
-
Log in to the account where Control-M/Server is installed.
-
In a High Availability environment, stop the Control-M/Server Configuration Agent on the non-active environment to avoid automatic failover.
-
Navigate to the following directory:
<Control-M/Server_Home>\patches\PACTV.9.0.22.100
-
Run the following command:
uninstall_patch.bat
The uninstall file shuts down your Control-M/Server components, uninstalls the fix pack, and restarts the components.
-
In a High Availability environment, run the following command on the non-active environment:
uninstall_patch.bat
The uninstall file shuts down your Control-M/Server components, uninstalls the fix pack, and restarts the components.
-
Verify that the Control-M/Server Configuration Agent on the non-active environment is up after the uninstallation completes.
Performing an Automatic Control-M/Server Uninstall on Windows
This procedure describes how to uninstall Control-M/Server from Windows via an automatic uninstall.
Before You Begin
Ensure that all jobs have ended.
Begin
-
Log in to the host using a user ID that has Administrator permissions.
-
Navigate to the following directory:
<ctmserver_InstallFolder>\BMCINSTALL\uninstall\DRCTV.9.0.22
-
Run the following command:
Uninstall.exe -silent
Control-M/Server is successfully removed from your host.
Configuring the Automatic Startup/Shutdown Procedure for Control-M/Server on UNIX
This procedure describes how to configure the automatic startup procedure for Control-M/Server on Red Hat 8 and 9, Oracle Linux 7, and SUSE Linux Enterprise Server 12. You must perform this procedure after you install Control-M/Server.
If you installed Control-M/Server on NFS, you can only use the Control-M/Server user on the same host where Control-M/Server was installed.
Begin
-
Log in as root.
-
Navigate to the following to location:
/etc/systemd/system/ -
Create a new unit service file with 644 permissions.
The extension must be .service.
EXAMPLE: CtmServer.service
-
Open the file and type the following:
Copy[Unit]
Description=Control-M Server
After=systemd-user-sessions.service multi-user.target network.target
[Service]
ExecStart=/bin/sh -c [server_home_dir]/ctm_server/data/rc.<account name>
Type=forking
RemainAfterExit=yes
ExecStop=/usr/bin/su - <account name> -c '[server_home_dir]/ctm_server/scripts/shut_ca ; [server_home_dir]/ctm_server/scripts/shut_ctm -CA; sleep 10 ; [server_home_dir]/ctm_server/scripts/shutdb; [server_home_dir]/ctm_server/scripts/shut_kafka'
[Install]
WantedBy=multi-user.target -
Save the file.
-
From a command line, run the following commands:
-
systemctl daemon-reload
-
systemctl enable [unit service file].service
-
-
Restart the Control-M/Server host.
