Agent Post-installation Procedures
The following procedures describe the required and optional steps after you install the Agent:
- Enabling Agent for Non-Root Mode
- Changing the JRE Package
- Changing the JRE Package in Application Integrator
- Configuring the Automatic Start-Up and Shut-Down Procedure for Linux Agents
- Configuring the Automatic Start-Up and Shut-Down Procedure for Solaris Agents
- Configuring the Automatic Start-Up Procedure for AIX Agents
- Configuring Western European Language Support on Linux
-
If you installed an Agent on NFS, you can only use the Agent user on the same host where the Agent was installed and you cannot install a plug-in
on an Agent on NFS or VXFS.
-
If you are configuring the Agent in root mode, verify that the root user has all the UNIX account requirements, as described in Agent Pre-installation Procedures for UNIX.
To avoid performance issues, BMC recommends that you work with your IT or security personnel to prevent your antivirus software from scanning the following items:
-
(UNIX) All $CONTROLM/ directory files and subdirectories, and the $HOME account bmcjava and bmcperl directories.
-
(Windows) All Agent/ directory and Control-M Common/ directory files and subdirectories.
-
All Agent processes, such as p_ctmam, and binary programs.
-
All communication ports that are accessed by Agent processes and binary programs.
(Windows only)
- To enable a different user to start up the Agent Windows service, you must define that user as a member of the Local Administrative Group (<Domain>\<User>).
- The Administrator selected as part of This Account, must have the following permissions in the Local Security Policy > Local Policies > User Rights Assignment section (run command: secpol.msc):
- Adjust memory quotas for a process.
- Replace a process level token.
- Act as Part of Operating System.
- Log on as a batch job.
- Log on as a service permissions.
- If you have modified the Agent Windows service properties or changed the Log in as option to Local System account or This account, you must terminate all Agent processes before new jobs can run
with the new Log in details.
- If the Agent service is defined as This Account, the Agent Run as User must have List Folder Contents permissions on the Agent drive.
Enabling Agent for Non-Root ModeLink copied to clipboard
This procedure describes how to enable Agent for non-root mode for jobs that are owned by a user that is different from the one running Agent.
If the only jobs run are owned by the same user that runs the Agent, it is not necessary to take any action to set up non-root operation mode.
Begin
-
Log in as user root and run the set_agent_mode script using the enable non root mode option on each installed Agent. The script need only be run once for each Agent.
-
From the Control-M Configuration Manager, define a job owner password for each job owner that is used by the Agent.
-
For an upgrade installation, you must replace the automatic startup script on each Agent computer to reflect its root or non-root status.
You can toggle between root mode and non-root mode on any Agent by shutting down the Agent from the user that is currently running the Agent, and re-starting Agent with the user necessary for the new mode.
Changing the JRE Package in Application IntegratorLink copied to clipboard
This procedure describes how to change the JRE package in Application Integrator. 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:
-
Edit the external_java_path.dat file in the <HOME>/BMCINSTALL/ directory.
-
Define an alternative Java home directory by modifying the value of the parameter CM_AI_JAVA_HOME to the external Java path, as follows:
CM_AI_JAVA_HOME={new JRE Path}
-
A relative path is not supported.
-
The path can only include alphanumeric, period, underscore, hyphen and plus characters.
-
-
Stop the Application Integrator using the following command.
$CONTROLM/cm/AI/exe/cm_container stop
Application Integrator starts automatically.
-
-
Windows: Do the following:
-
Edit the external_java_path.dat file in the <AGENT_HOME>\BMCINSTALL\ directory.
-
Define an alternative Java home directory by modifying the value of the parameter CM_AI__JAVA_HOME to the external Java path, as follows:
CM_AI_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 characters, spaces, ., _, -, and +.
-
-
Stop the Application Integrator using the following command.
<AGENT_HOME>\cm\AI\exe\cm_container stop
Application Integrator restarts automatically.
-
-
Configuring the Automatic Start-Up and Shut-Down Procedure for Linux AgentsLink copied to clipboard
This procedure describes how to configure the automatic start-up and shut-down procedure for Linux Agents.
Begin
-
Log in as the root user.
-
Navigate to the following to location:
/etc/systemd/system/
-
Create a new unit service file with 644 permissions.
The extension must be .service such as ctmag.service.
-
Open the file and type the following:
CopyCopied to clipboard[Unit]
Description=Control-M Agent
[Service]
Type=forking
RemainAfterExit=yes
ExecStart=[agent_home_dir]/ctm/scripts/rc.agent_user start
ExecStop=[agent_home_dir]/ctm/scripts/rc.agent_user stop
[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 Agent.
Configuring the Automatic Start-Up and Shut-Down Procedure for Solaris AgentsLink copied to clipboard
This procedure describes how to configure the automatic start-up and shut-down procedure for Solaris Agents.
Begin
-
Log in as the root user.
-
Copy the rc.agent_user script to the init.d directory.
-
Run the following command:
-
cp <agentHome>/ctm/scripts/rc.agent_user /etc/init.d/rc.<agentUser>ln -s ../init.d/rc.<agentUser>/etc/rc2.d/S13<agentUser>
cp home/ctm/scripts/rc.agent_user /etc/init.d/rc.agent1
ln -s ../init.d/rc.agent1 /etc/rc2.d/S13agent1
-
Create a relative path to the rc2.d directory pointing to the script in the init.d directory.
-
Run the start-up procedure command as the root user.
Configuring the Automatic Start-Up Procedure for AIX AgentsLink copied to clipboard
This procedure describes how to configure the automatic automatic start-up procedure for AIX Agents..
Begin
-
Log in as a privileged root user.
-
Run the following command:
cp <Agent_Home>/ctm/scripts/rc.agent_user /etc/<Agent_User>
-
Do the following:
-
Run the following command to verify the execution permissions:
-rwxr-xr-x
The following must appear:
ls -la /etc/<Agent_User>
-
If the ls -la /etc/<Agent_User> does not appear, run the following command:
chmod 755 /etc/<Agent_User>
-
-
Open the /etc/inittab file in an editor, and add the following line:
<Agent_User>:2:once:/etc/<Agent_User>
-
The following command is run on user agent1:
cp /home/agent1/ctm/scripts/rc.agent_user /etc/agent1
-
The following line is added to the /etc/inittab file:
agent1:2:once:/etc/agent1
-
Configuring Western European Language Support on LinuxLink copied to clipboard
This procedure describes how to configure Western European language support on Linux. You must update the locale to the same value on every computer or Linux account.
Begin
-
From a command prompt, type the locale -a command.
-
Define the required values in the .cshrc or profile file, as described in Linux Environment Variables for West European Languages.
LC_ALL=
LC_CTYPE=de_DE.ISO8859-1
LANG=de_DE.ISO8859-1
LC_COLLATE=C
LC_MESSAGES=C
-
Run the following command:
source ~/.cshrc
Linux Environment Variables for West European LanguagesLink copied to clipboard
The following table lists the environment variables and values that you must use to define Western European language support on Linux hosts, as described in Configuring Western European Language Support on Linux.
Environment Variable | Description |
---|---|
LC_ALL |
"" (an empty string) Set this variable by adding setenv LC_ALL "" to the .cshrc or .profile file |
LC_CTYPE and LANG |
The value of the required language locale for Linux.
|
LC_COLLATE |
C for all languages (or c, as defined on the computer). To determine whether the C locale is present, use the locale -a command. If the C (or c) locale is not present, you can use POSIX or one of the English locales that appear in the previous table. Define this variable by adding the following line to the .cshrc or .profile file: setenv LC_COLLATE C |
LC_MESSAGES |
C (or c, as defined on the computer) for all languages on accounts where the Agent is installed. To determine whether the C locale is present, use the locale -a command. If the C (or c) locale is not present, use POSIX or one of the English locales that appear in the previous table. Define this variable by adding the following line to the .cshrc or .profile file: setenv LC_MESSAGES C |
ISO Latin-1 Character Set Locale Settings for LinuxLink copied to clipboard
The following table lists the character set locale settings for each of the Linux machines for each of the ISO-Latin-1 supported languages.
If the required locale is missing, ask your Linux administrator to install it.
Language |
Red Hat Linux |
SuSE Linux |
---|---|---|
English (USA) |
en_US.iso88591 |
en_US |
English (UK) |
en_GB.iso88591 |
en_GB |
German |
german |
german |
French |
french |
french |
Spanish |
spanish |
spanish |