Previous Topic: CA Configuration Automation Agent Log FileNext Topic: CA Configuration Automation Agent Configuration File


CA Configuration Automation Agent Installation

This chapter describes how to install the CA Configuration Automation Agent software.

Install the CA Configuration Automation Agent on the CA Configuration Automation Server host system and on other servers in your enterprise where you want CA Configuration Automation to discover and manage services.

Notes: 

This section contains the following topics:

Installation Guidelines and Notes

Install CA Configuration Automation Agent on Windows

Installing CA Configuration Automation Agent on Linux or UNIX

Install an Agent Silently

CA Configuration Automation Agent Configuration File

Installation Guidelines and Notes

This section provides some general guidelines and notes you need to understand before installing the CA Configuration Automation Agent software.

Note: Before installation, read the CA Configuration Automation Release Notes. This document contains release-specific information and describes the system requirements and supported environments for installing CA Configuration Automation Agents. If you have previously installed the CA Configuration Automation Agent software, follow the procedures in Upgrading CA Configuration Automation Software.

Recommended Installation Directories

We recommend that you install CA Configuration Automation software in the default target installation directories. If you install the software in directories other than the recommended defaults, ensure that you at least install the CA Configuration Automation Server and CA Configuration Automation Agent in different subdirectories.

Also, if you are installing CCA software on Linux or UNIX platforms, use standard directory naming conventions (for example, do not use embedded spaces or special characters).

Installing and Running UNIX-Based Agents as Root

Install and run UNIX-based CA Configuration Automation Agents as root in a CA Configuration Automation production environment. Although you can evaluate and test the software as other users, key operating system Component Blueprint configuration executables and macros can fail if the agent is not running as user root.

Install CA Configuration Automation Agent on Windows

You can only install the CA Configuration Automation Agent software on Microsoft Windows operating systems using the wizard.

To install CA Configuration Automation Agent on Windows

  1. Log in as administrator or any user with administrative privileges.
  2. Navigate to the dvd1\CCA\Agents\Windows folder.
  3. Start the CA Configuration Automation Agent installation program by double-clicking one of the following files:

    The CA Configuration Automation Agent installation requires a Java VM. The Java VM does not run during agent operation. Because you may already have a version of a Java VM installed on the target server for the CA Configuration Automation Agent, two different agent installation wizards are provided—one installs a Java VM, and the other one does not install a Java VM. It attempts to find and use an existing Java VM.

    Note: The installation program may not be able to locate an existing Java VM if it was not installed in a commonly known location. If the AgentWindows.exe installation fails, use AgentWindowsVM.exe to install the CA Configuration Automation Agent.

    The installation program prepares for installation by unpacking and extracting the necessary files into a temporary work space. This can take several minutes. After the installation has completed successfully or is cancelled, the temporary storage is released.

    The installation wizard starts and displays the Introduction.

  4. Read the Introduction screen and click Next.

    Note: If you cancel an installation, files that are installed to that point are not removed automatically. Use the uninstaller that is provided to remove these files. The uninstaller is located in the target installation directory that you select in step 7.

    The License Agreement screen appears.

  5. Read the License Agreement, select I accept the terms of the License Agreement, and click Next.

    To install the CA Configuration Automation software, you must accept the license agreement.

    The Copyright screen appears.

  6. Read the copyright and software use information, and click Next.

    The Installation Location screen appears.

  7. Click Next to accept the default installation location (\Program Files\CA\CA Configuration Automation Agent), enter an alternate installation location, or click Choose to select the location in which to install the CA Configuration Automation Agent. We recommend that you use the default location.

    Only alphanumeric, underscore ( _ ), blank, and back slash ( \ ) characters are allowed for path names on Windows-based systems (no other embedded special characters). If the directory you specify does not exist, the installation wizard creates it for you.

    The Agent Configuration screen appears.

  8. Enter the following CA Configuration Automation Agent configuration information, and click Done.
    CA Configuration Automation Agent Port Number

    Specifies the CA Configuration Automation Agent listening port number. Accept the default (port 8063), or enter a different, unique port number.

    Use a port number that is not being used by any other service or peripheral. You can command window and run the netstat ‑an command to see which ports are already in use.

    Agent Bind IP Address

    Specifies the IP address of the machine that the CCA agent binds to after the agent installation is complete.

    The option lists the available IP addresses, and excludes the following IP addresses:

    • IPv4 loopback address. For example, 127.0.0.1
    • IPv6 loopback address. For example, ::1 or 0:0:0:0:0:0:0:1
    • IPv6 link local address. For example, starting with fe80::

    Note: If a valid IP address is not found, a warning message is displayed and the CCA agent binds to the loopback IP address.

    Enable Agent Logging

    Specifies whether to enable agent logging. You may not want to enable logging if your environment discourages writing log files to machines for space conservation and security reasons.

    You can also enable or disable agent logging at any time in the agent configuration file (agent.conf).

    Enable Server Ping

    Specifies whether to enable server ping. You may not want to enable server ping if any of the following apply:

    • You encounter IP address and name resolution conflicts.
    • The server has multiple Network Interface Cards (NICs) (ensures identification with the intended NIC).
    • Agents are installed on servers that have a firewall between those servers and the CA Configuration Automation Server (reduces unnecessary network traffic caused by the agents trying to ping an unreachable address).

    You can also enable or disable server ping at any time in the agent configuration file (agent.conf).

    If you enable Server Ping the following fields appear:

    CA Configuration Automation Server Name

    Specifies the server name or IP address of the CA Configuration Automation Server.

    Note: If you enter the IP address of a IPv6 server, the address must be enclosed in square brackets, for example: [2001:db8:0:10:20e:7fff:fe61:1efa].

    CA Configuration Automation Server Port Number

    Specifies the CA Configuration Automation Server listening port number.

    The installation program checks for adequate installation disk space and displays a summary of required and available disk space.

  9. Review the summary, and then click Install.

    The wizard displays the progress as it copies the required files to the target server. When it is finished copying the files, it prompts you for the configuration information required for server communications and to create the agent configuration file agent.conf.

  10. Click Done.

    The CA Configuration Automation Agent installation wizard closes.

For information about verifying that the CA Configuration Automation Agent installed correctly, see Verifying CA Configuration Automation Agent Installation.

Installing CA Configuration Automation Agent on Linux or UNIX

You can install the CA Configuration Automation Agent software on Linux or UNIX in either of the following ways:

Install Using Console Mode

You can interactively install the CA Configuration Automation Agent with or without the supplied Java VM from the command line.

Follow these steps:

  1. Log in as the root user.

    You must be logged in as the root user to install the CA Configuration Automation Agent software.

  2. Change to the directory that contains the CA Configuration Automation Agent installation program. For example:
    # cd Agents/<operating_system>
    
    <operating_system>

    Specifies one of the following operating systems: AIX, HPUX, Linux, or Solaris.

    Note: The remainder of this section uses example prompts that are based on installing the CA Configuration Automation Agent on a Solaris server. Agent installation procedures and prompts are similar for all supported Linux and UNIX platforms.

  3. Enter one of the following commands:

    The CA Configuration Automation Agent installation program requires a Java VM. The Java VM does not run during the agent operation. The application tries to find and use an existing Java VM. The application provides two agent installation programs: one that installs a Java VM, and another that does not.

    Note: If the existing Java VM was not installed in a commonly known location, the installation program may be unable to locate it. If the agent installation fails, use the Agent<OS>VM.bin to install the CA Configuration Automation Agent.

    The installation program prepares for the installation process by unpacking and extracting the necessary files in a temporary work space. The preparation can take several minutes.

    If you do not have adequate /tmp space available, the installation program tries to use available space in /, the root user home directory. After the installation finishes successfully, the program releases the temporary storage.

    The installation program starts and displays the Introduction text that provides basic installation navigation and cancelation instructions, including the following key points:

  4. Press Enter to continue.

    The License Agreement appears.

  5. Read each page of the License Agreement (including the Third Party Software License Terms and Conditions), then press Enter to continue.

    At the end of the agreement, the following prompt appears:

    DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N)
    
  6. Enter Y to continue the installation process.
  7. Read the Important Information text, then press Enter.

    The following prompt appears:

    Install this product in the following location:
    Default Install Folder: /opt/CA/CCAAgent
    ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT:
    
  8. Press Enter to install the CA Configuration Automation agent at the default location, or enter the path to an alternative location.

    Note: We recommend that you use the default location.

    The application allows only alphanumeric, underscore ( _ ), and forward slash ( / ) characters in path names (no embedded blanks or other special characters). If the directory you specify does not exist, the installation program creates it for you.

    The installation program runs and displays the progress as it copies the required files to the installation folder. The program then prompts you for the configuration information that is required to set up communications with the CA Configuration Automation Server and to create the agent configuration file (agent.conf):

    CA Configuration Automation Agent Configuration Information
    Enter the following CA Configuration Automation Agent configuration information
    CA Configuration Automation Agent Port Number (DEFAULT: 8063):
    
  9. Take one of the following actions:
  10. From the displayed list, select an IP address for the CA Configuration Automation Agent to bind.

    Note: If the installation program finds no valid IP address, it displays a warning, then binds the CA Configuration Automation Agent to the loopback IP address.

    The installation program prompts you to enable Agent Logging:

    Do you want to enable Agent Logging?
    1- Yes
    2- No
    
  11. Press Enter to accept the default (No), or type 1 and press Enter to enable logging.

    Note: Disable logging to conserve space and increase security.

    You can also enable or disable logging in the agent configuration file (agent.conf).

    The installation program prompts you to enable Server Ping:

    Do you want to enable Server Ping?
    1- Yes
    2- No
    
  12. Press Enter to accept the default (No), or enter 1 and press Enter to enable Server Ping.

    You can choose not to enable Server Ping in the following circumstances:

    You can enable or disable Server Ping in the agent configuration file (agent.conf).

    If you enabled Server Ping, the installation program prompts you for the following information:

    CA Configuration Automation Server Name

    Defines the server name or IP address of the CA Configuration Automation Server.

    Note: If you enter the IP address of an IPv6 server, enclose the address in square brackets. For example:

    CA Configuration Automation Server Name (DEFAULT: ): [2001:db8:0:10:20e:7fff:fe61:1efa]
    
    CA Configuration Automation Server Port Number

    Defines the CA Configuration Automation Server listening port number.

    The installation program checks for adequate installation disk space and displays a summary of the required and available disk space and the specified installation folder.

  13. Review the summary, and press Enter.
  14. Press Enter.

    When the installation finishes, the installation program closes.

For information about verifying that the CA Configuration Automation Agent installed correctly, see Verifying CA Configuration Automation Agent Installation.

Install Using the Wizard

Unlike the CA Configuration Automation Server installation, console mode is the default UNIX CA Configuration Automation Agent installation method. You must specify the -i gui argument with the executable to install using the installation wizard.

To install CA Configuration Automation Agent on Linux or UNIX using the installation wizard

  1. Log in as root.

    You must be root to install the CA Configuration Automation Agent software.

  2. Ensure that your DISPLAY variable is set properly:
    # echo $DISPLAY
    

    If the DISPLAY variable is not set, set it before continuing, for example:

    # DISPLAY=<server_name/IP>:0.0
    # export DISPLAY
    
  3. Change to the directory containing the installation program, for example:
    # cd agent/<operating_system>
    
    <operating_system>

    Specifies one of the following operating systems: AIX, HPUX, Linux, or Solaris.

  4. Run the CA Configuration Automation Agent installation program by entering one of the following commands:

    The CA Configuration Automation Agent installation program requires a Java VM. The Java VM does not run during agent operation. Because you may already have a version of a Java VM installed on the target server for the CA Configuration Automation Agent, two different agent installation programs are provided—one installs a Java VM (agentvm.bin), and one does not install a Java VM (agent.bin) and attempts to find and use an existing Java VM.

    Note: The installation program may not be able to locate an existing Java VM if it was not installed in a commonly known location. If the agent.bin installation fails, use agentvm.bin to install the CA Configuration Automation Agent.

    The installation program prepares for installation by unpacking and extracting the necessary files into a temporary work space. This can take several minutes.

    If you do not have adequate /tmp space available, the installation program tries to use available space in /, the root user’s home directory. After the installation has completed successfully, the temporary storage is released.

    The installation wizard starts and displays the Introduction.

  5. Read the Introduction screen and click Next.

    Note: If you cancel an installation, files that are installed to that point are not removed automatically. Use the uninstaller that is provided to remove these files. The uninstaller is located in the target installation directory that you select in step 9.

    The License Agreement screen appears.

  6. Read the License Agreement, select I accept the terms of the License Agreement, and click Next.

    To install the CA Configuration Automation software, you must accept the license agreement.

    The Important Information screen appears.

  7. Read the copyright and software use information, and click Next.

    The Select Installation Location screen appears.

  8. Click Next to use the default installation location (opt/CA/CCAAgent), enter an alternate installation location, or click Choose to select the location in which to install the CA Configuration Automation Agent. We recommend that you use the default location.

    Only alphanumeric, underscore ( _ ), and forward slash ( /  ) characters are allowed for path names on UNIX-based systems (no embedded blanks or other special characters). If the directory you specify does not exist, the installation wizard creates it for you.

    The wizard displays the installation progress as it copies the required files to the target server. When it is finished copying the files, it prompts you for the configuration information required for server communication and to create the agent configuration file agent.conf (for more information, see CCA AgentCA Configuration Automation AgentCA Configuration Automation Agent Configuration File).

  9. Enter the following CA Configuration Automation Agent configuration information when prompted, and click Done.
    CA Configuration Automation Agent Port Number

    Specifies the CA Configuration Automation Agent listening port number. Accept the default (port 8063), or enter a different, unique port number. Use a port number that is not being used by any other service or peripheral. In a command window, you can run the netstat -an command to see which ports are already in use.

    Agent Bind IP Address

    Specifies the IP address of the machine that the CCA agent binds to after the agent installation is complete.

    The option lists the available IP addresses, and excludes the following IP addresses:

    • IPv4 loopback address. For example, 127.0.0.1
    • IPv6 loopback address. For example, ::1 or 0:0:0:0:0:0:0:1
    • IPv6 link local address. For example, starting with fe80::

    Note: If a valid IP address is not found, a warning message is displayed and the CCA agent binds to the loopback IP address.

    Enable Agent Logging

    Specifies whether to enable agent logging. You may not want to enable logging if your environment discourages writing log files to machines for space conservation and security reasons.

    You can also enable or disable agent logging at any time in the agent configuration file, agent.conf.

    Enable Server Ping

    Specifies whether to enable server ping. You may not want to enable server ping if any of the following apply:

    • You encounter IP address and name resolution conflicts.
    • The server has multiple Network Interface Cards (NICs) (ensures identification with the intended NIC).
    • Agents are installed on servers that have a firewall between those servers and the CA Configuration Automation Server (reduces unnecessary network traffic caused by the agents trying to ping an unreachable address).

    You can also enable or disable server ping at any time in the agent configuration file, agent.conf.

    If you enable Server Ping the following fields appear:

    CA Configuration Automation Server Name

    Specifies the server name or IP address of the CA Configuration Automation Server.

    Note: If you enter the IP address of a IPv6 server, the address must be enclosed in square brackets, for example: [2001:db8:0:10:20e:7fff:fe61:1efa].

    CA Configuration Automation Server Port Number

    Specifies the CA Configuration Automation Server listening port number.

    The Pre-Installation Summary screen appears.

  10. Review the summary and click Install.

    The installation runs and confirms that the installation was successful.

  11. Click Done.

    The CA Configuration Automation Agent installation wizard closes.

For information about verifying that the CA Configuration Automation Agent installed correctly, see Verifying CA Configuration Automation Agent Installation.

Install an Agent Silently

You can use a property file to install a CA Configuration Automation Agent on the target host silently from the command line. For example, when you want to install an agent silently in the following cases:

Follow these steps:

  1. Create a configuration property file named installer.properties.

    The installer.properties file must contain the following lines:

    INSTALLER_UI=silent
    USER_INSTALL_DIR=/opt/CA/CCAAgent
    USER_INSTALL_DIR=C:\\Program Files\\CA\\CA Configuration Automation Agent
    AGENTBINDIPADDR=Preferred-IP-Address
    AGENTLOG=1 
    SERVERPING=1 
    AGENTPORT=8063 
    SERVERNAME=factotum 
    SERVERPORT=8098
    
    INSTALLER_UI

    Identifies the installation method as "silent."

    USER_INSTALL_DIR

    Defines the installation directory on the target computer.

    Important! The code sample in this step contains two USER_INSTALL_DIR lines. Use only the line that matches the operating system of the agent host computer. On Windows, escape the back slash path separators ( \ ) with another back slash.

    AGENTBINDIPADDR=Preferred-IP-Address

    Defines the IP address for the CA Configuration Automation Agent to bind.

    Note: Specify the preferred IP address in the silent install properties file, or from the command-line option.

    AGENTLOG

    Specifies whether to enable or disable agent logging. For example, you can disable agent logging to improve security or to conserve storage space. This parameter has the following values:

    1: Enable agent logging.

    0: Disable agent logging.

    You can also enable or disable agent logging in the agent configuration file, agent.conf.

    SERVERPING

    Specifies whether to enable or disable the server ping. For example, you could disable the server ping in the following cases:

    • IP address and name resolution conflicts occur.
    • The server has multiple Network Interface Cards (NICs). Disabling the server ping ensures that the server identifies the intended NIC.
    • Agents are installed on servers that have a firewall between those servers and the CA Configuration Automation Server. This case reduces unnecessary network traffic that results from the agents trying to ping an unreachable address.

    Note: Enable the server ping to populate the CA Configuration Automation Agent-related details accurately.

    This parameter has the following values:

    1: Enable the server ping.

    0: Disable the server ping.

    You can also enable or disable the server ping in the agent configuration file, agent.conf.

    AGENTPORT

    Defines the agent listening port number.

    Default: 8063

    SERVERNAME

    Defines the CA Configuration Automation Server host name.

    SERVERPORT

    Defines the CA Configuration Automation Server listening port number.

    Default: (In a console or wizard installation) 8080

  2. Log in to the target installation host as one of the following users:

    UNIX: Log in as the root user.

    Windows: Log in as the administrator or another user with administrative rights.

  3. In the CA software installation directory on your CA Configuration Automation Server host, locate the agent installer for the operating system on which to install the agent.

    If you installed the CA Configuration Automation Server at the default location, the agent installer and the property file are located in the following directories:

    UNIX: /opt/CA/CCAServer/Agent_Installers/<operating_system>

    Windows: \Program Files\CA\CCA Server\Agent_Installers\<operating_system>

    <operating_system>

    Defines the operating system (AIX, HPUX, Linux, Solaris, or Windows).

    Consider the following standards for using the environment variables in the installation directory:

  4. Copy the agent installer (for example, AgentWindowsVM.bin) and the property file you created to the same location on the target host.
  5. Navigate to the directory where you copied the agent installer and the property file, and then run the appropriate CA Configuration Automation Agent installation program:
    UNIX:

    Run one of the following commands from the command line:

    • To install the agent and the supplied Java VM:
         # sh ./Agent<operating_system>VM.bin -f installer.properties -i silent
      
    • To install only the agent:
         # sh ./Agent<operating_system>.bin -f installer.properties -i silent
      
    Windows:

    Run one of the following commands in a command window:

    • To install the 32-bit agent and the supplied Java VM:
         C:\tmp>AgentWindowsVM.exe -f installer.properties -i silent
      
    • To install only the 32-bit agent:
         C:\tmp>AgentWindows.exe -f installer.properties -i silent
      
    • To install the 64-bit agent and the supplied Java VM:
         C:\tmp>AgentWindows64VM.exe -f installer.properties -i silent
      
    • To install only the 64-bit agent:
         C:\tmp>AgentWindows64.exe -f installer.properties -i silent
      
  6. Ensure that the CA Configuration Automation Agent silent installation is complete by checking for the presence of the CCA_Agent_<operating_system>_InstallLog.log file in the agent installation location.

    If you used the default location to install the CA Configuration Automation Agent, the installation directory is in one of the following locations:

    UNIX:
    /opt/CA/CCAAgent
    
    Windows:
    C:\Program Files\CA\CA Configuration Automation Agent