Agent Post-installation Procedures

The following procedures describe the required and optional steps after you install the Agent:

To avoid performance issues, BMC recommends that you work with your IT or security personnel to exclude the following from anti-virus scanning:

  • (UNIX/Linux) All of the files and subdirectories in the $CONTROLM directory, and the bmcjava and bmcperl directories in the $HOME account.

  • (Windows) All of the files and subdirectories in the Agent and Control-M Common directories.

  • All Agent processes, such as p_ctmam, and binary programs.

  • All communication ports used by Agent processes and binary programs.

(Windows only)

  • If you want 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 Adjust memory quotas for a process, Replace a process level token, Act as Part of Operating System, Log on as a batch job, and Log on as a service permissions in the Local Security Policy > Local Policies > User Rights Assignment section (Run command: secpol.msc).
  • If you changed the Agent Windows service Log in as option to Local System account or This account, or modified its properties, you must terminate all Agent processes before new jobs can runClosed A Control-M process that adds your job to the Run Queue of the day, according to automatic or manual scheduling, and which enables the job to execute after it fulfills its prerequisites. with the new Log in details.
  • When the Agent service is defined as This Account, the user that the Agent is running with must have List Folder Contents permissions for the Agent drive.

Enabling Agent for Non-Root Mode

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

  1. 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.

  2. From the Control-M Configuration Manager, define a job owner password for each job owner that is used by the Agent.

  3. 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 Integrator

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:

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

      2. 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.

      3. Stop the Application Integrator using the following command.

        $CONTROLM/cm/AI/exe/cm_container stop

        Application Integrator starts automatically.

    • Windows: Do the following:

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

      2. 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 +.

      3. Stop the Application Integrator using the following command.

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

        Application Integrator restarts automatically.

Configuring the Automatic Startup/Shutdown Procedure for Agent on Linux

This procedure describes how to configure the automatic startup procedure for Agent on Linux.

Begin

  1. Log in as root.

  2. Navigate to the following to location:

    /etc/systemd/system/

  3. Create a new unit service file with 644 permissions.

    The extension must be .service such as ctmag.service.

  4. Open the file and type the following:

    Copy 
    [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

  5. Save the file.

  6. From a command line, run the following commands:

    • systemctl daemon-reload

    • systemctl enable [unit service file].service

  7. Restart the Agent computer.

Configuring the Automatic Startup/Shutdown Procedure for Agent on Solaris

This procedure describes how to configure the automatic startup procedure for Agent on Solaris.

Begin

  1. Log in as root.

  2. Copy the rc.agent_user script to usr/local/bin/ and change ownership and permissions.

    cp $CONTROLM/scripts/rc.agent_user to /usr/local/bin/ctm_rc.agent_<account_name>

    chmod a+x /usr/local/bin/ctm_rc.agent_<account_name>

    chown root /usr/local/bin/ctm_rc.agent_<account_name>

  3. Navigate to the following to location:
    /etc/systemd/system/

  4. Create a new unit service file with 644 permissions.

    The extension must be .service.

    EXAMPLE: ctmag.service

  5. Open the file and type the following:

    Copy 
    [Unit]
    Description=Control-M Agent
    [Service]
    Type=forking
    RemainAfterExit=yes
    ExecStart=/usr/local/bin/ctm_rc.agent_<account_name> start
    ExecStop=/usr/local/bin/ctm_rc.agent_<account_name> stop
    [Install]
    WantedBy=multi-user.target

  6. Save the file.

  7. From a command line, run the following commands:

    • systemctl daemon-reload

    • systemctl enable [unit service file].service

  8. Restart the Agent computer.

Configuring the Automatic Startup Procedure for Agent on AIX

This procedure describes how to configure the automatic startup procedure for Agent on AIX.

Begin

  1. Log in as root privileged user.

  2. Run the following command:

    cp <Agent_Home>/ctm/scripts/rc.agent_user /etc/<Agent_User>

  3. Verify execution permissions (-rwxr-xr-x):
    ls -la /etc/<Agent_User>

    If the permissions are not set, execute as follows:

    chmod 755 /etc/<Agent_User>

  4. Open the /etc/inittab file in an editor, and append the following line:

    <Agent_User>:2:once:/etc/<Agent_User>

    • For user agent1, run the following command:

      cp /home/agent1/ctm/scripts/rc.agent_user /etc/agent1

    • In the file /etc/inittab append the following line:

      agent1:2:once:/etc/agent1

Configuring Western European Language Support on Linux

This procedure describes how to configure Western European language support on Linux. Update the locale to the same value on every computer or Linux account.

Begin

  1. From a command prompt, type the locale -a command.

  2. Set the values as described in Linux Environment Variables for West European Languages in the .cshrc or profile file.

    LC_ALL=

    LC_CTYPE=de_DE.ISO8859-1

    LANG=de_DE.ISO8859-1

    LC_COLLATE=C

    LC_MESSAGES=C

  3. Run the source ~/.cshrc command.

Linux Environment Variables for West European Languages

The following table lists the environment variables and values to use for setting Western European language support on Linux machines, as described in Configuring Western European Language Support on Linux.

Environment Variable Description

LC_ALL

"" (an empty string) Set this variable by adding the setenv LC_ALL "" to the .cshrc or .profile file

LC_CTYPE and LANG

The value of the required language locale for Linux.

setenv LC_CTYPE localeName

setenv LANG localeName

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. Set this variable by adding the setenv LC_COLLATE C to the .cshrc or .profile file:

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.

Set this variable by adding the setenv LC_MESSAGES C to the .cshrc or .profile file.

ISO Latin-1 Character Set Locale Settings for Linux

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.

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