Installing the Capacity Agent silently

Where you are in the Installation process

StepTask
1Complete the planning activities
2Preparing for TrueSight Capacity Optimization installation
3Install Remedy Single Sign-On
4Install TrueSight Presentation Server
5Install TrueSight Capacity Optimization Application Server and ETL Engine
6Install TrueSight Capacity Optimization Gateway Server
7Install TrueSight Capacity Optimization Capacity Agent ( You are here )
8Complete the post-installation activities

The silent installation involves running the installer from a command line. The installer uses the AgentSilentInstallOptions.txt file, which contains the parameters that are required for installing the Capacity Agent. 

To install the Capacity Agent silently

  1. Log in to the computer where you want to install the Capacity Agent.
    • (Windows) Log in as a user with administrator privileges.
    • (UNIX andLinux) Log in as a non-root user.
  2. Extract the Capacity Agent installer files to a temporary directory.
    • (Windows) Extract TSCO_Agent_<version>_MSwindows.zip
    • (UNIX and Linux) Run this command: tar -xvf TSCO_Agent_<version>_Linux.tar
  3. Create a directory for saving the options file.
  4. In the Capacity Agent installation directory, navigate to the silent directory.
  5. Copy the AgentSilentInstallOptions.txt file to the directory that you created in step 3.

  6. Open the AgentSilentInstallOptions.txt file in a text editor and edit it. The file contains the installation properties that are specified as name and value pairs with prefix tags. You can retain the default values for these properties or override them, and save the file.

     Property details

    Prefix tags for the silent installation properties:

    • -P: Precedes the directory properties

    • -J: Precedes the Java properties

    Property nameDescription
    Installation settings
    -P installLocation

    Retain the following default installation directory path or type a new path:

    • (Windows) C:\Program Files\BMC Software\Patrol3
    • (Linux/opt/bmc/Patrol3

    Examples: 

    • (Windows) -P installLocation=C:\Program Files\BMC Software\Patrol3
    • (Linux) -P installLocation=/opt/bmc/Patrol3
    -J INSTALL_BPA_AGENTRetain the default selection to install the Capacity Agent.
    Example: -J INSTALL_BPA_AGENT=true
    -J CONNECTION_TYPESpecify the protocol to be used for communication with the Application Server.
    Default value: HTTPS
    Example: -J CONNECTION_TYPE=HTTPS
    For HTTPS, provide the following details to connect to the Application Server:
    • -J BPA_TSCO_HOSTNAME: The fully qualified host name where the Application Server is installed.
    • -J BPA_TSCO_PORT: The port number where the Application Server runs.
    • -J BPA_TSCO_USERNAME=The name of the user to authenticate with the Application Server.
    • -J BPA_TSCO_PASSWORD=The password of the user.
    (UNIX and Linux)-J BPA_USERType the user name for installing the Capacity Agent. It is recommended to install as a non-root user.
    Default value: perform (root user) or any current non-root user
    Example: -J BPA_USER=Sam
    (Windows) Agent email notifications: Configure the following properties if you want to receive alert notifications from the embedded Capacity Agent.
    -J PERFORM_AGENT_MAIL_TYPESpecify the mail server type.
    Default value: SMTP
    Example: -J PERFORM_AGENT_MAIL_TYPE=SMTP
    -J PERFORM_AGENT_SMTP_SERVERType the fully qualified domain name of the SMTP server.
    Default value: localhost
    Example: -J PERFORM_AGENT_SMTP_SERVER=smtp-mail.outlook.com
    -J PERFORM_AGENT_SMTP_PORTType the SMTP port number to be used by the Agent.
    Default value: 25
    Example: -J PERFORM_AGENT_SMTP_PORT=25
    -J PERFORM_AGENT_SMTP_EMAIL_ADDRESSType the email address to receive notifications.
    Example: -J PERFORM_AGENT_SMTP_EMAIL_ADDRESS=<your_name>@<orgname.com>
    User account settings for the Agent
    -J PERFORM_AGENT_ACCOUNT_TYPE

    Specify where you want to create a user account for the Capacity Agent. Type one of the following values:

    • LOCAL - To create a user account on the local server
    • DOMAIN - To create a user account on the domain controller
    • NONE - Specify if you do not want to create a user account

    Default value: Local

    Example: -J PERFORM_AGENT_ACCOUNT_TYPE=LOCAL

    -J PERFORM_AGENT_ACCOUNT_DISABLESpecify whether you want to disable or enable the user account for the Capacity Agent.
    Default value: True
    Example: -J PERFORM_AGENT_ACCOUNT_DISABLE=TRUE
    Data collection settings
    (Windows) -J PERFORM_AGENT_START_WINDOWSSpecify whether you want to start the Capacity Agent after installing the Gateway Server.
    Default value: True
    Example: -J PERFORM_AGENT_START_WINDOWS=TRUE
    (UNIX and Linux)-J PERFORM_AGENT_START_UNIX

    Specify whether you want to start the Capacity Agent after installing the Gateway Server.
    Default value: True
    Example: -J PERFORM_AGENT_START_UNIX=TRUE
    -J PERFORM_AGENT_ENABLE_HISTORYSpecify whether you want to enable the collection of historical data.
    Default value: True
    Example: -J PERFORM_AGENT_ENABLE_HISTORY=TRUE
    -J PERFORM_AGENT_HISTORY_REPOSITORYType a directory to store the collected historical data.
    Default value:
    (Windows) C:\Program Files\BMC Software\Patrol3\BEST1\<version_number>\History
    (Linux) - /opt/bmc/Patrol3/perform/history
    Example: -J PERFORM_AGENT_HISTORY_REPOSITORY=C:\Program Files\BMC Software\Patrol3\BEST1\11.3.00\History
    (UNIX and Linux)-J PERFORM_AGENT_COLLECT_REPOSITORY

    Type a directory path to store the data collected daily.
    Default value: /opt/bmc/Patrol3/perform/collect

    Example: -J PERFORM_AGENT_COLLECT_REPOSITORY=/opt/bmc/Patrol3/perform/collect

    (Windows-J PERFORM_AGENT_MIGRATIONSpecify whether you want to migrate old configuration files of Capacity Agents. Default value: True Example: -J PERFORM_AGENT_MIGRATION=TRUE
    Port settings
    -J PERFORM_AGENT_PORTType the port number to be used by the Capacity Agent.
    Default value: 6767
    Example: -J PERFORM_AGENT_PORT=6767
    -J PERFORM_INVESTIGATE_PORTType the port number to be used by the Investigate.
    Default value: 6768
    Example: -J PERFORM_INVESTIGATE_PORT=6768
    -J PERFORM_AGENT_SERVICE_PORTType the port number to be used by the Agent service.
    Default value: 10128
    Example: -J PERFORM_AGENT_SERVICE_PORT=10128
    Other settings
    (UNIX and Linux) -J PERFORM_CREATE_DEFAULT_LINKSpecify whether you want to create a default link.
    Default value: True
    Example: -J PERFORM_CREATE_DEFAULT_LINK=TRUE
    -J PERFORM_PROCESS_LENGTHType the process command length that the Agent must collect.
    Default value: 2048
    Example: -J PERFORM_PROCESS_LENGTH=2048
    -J PERFORM_SECURITY_CONFIGURATION_TYPEType Basic or Advanced security level that you want to use for communication between the Gateway Server and the Application Server. Use Advanced when a direct network connection does not exist between the Agent and the Gateway Server.
    Default value: BASIC
    Example: -J PERFORM_SECURITY_CONFIGURATION_TYPE=BASIC
    (UNIX and Linux)-J PERFORM_UNIX_MIGRATIONSpecify whether you want to upgrade the existing version of the Capacity Agent if detected.
    Default value: True
    Example: -J PERFORM_UNIX_MIGRATION=TRUE
    (UNIX and Linux)-J PERFORM_UNIX_UNINSTALLSpecify whether you want to uninstall the existing version of the Capacity Agent if detected.
    Default value: False
    Example: -J PERFORM_UNIX_UNINSTALL=FALSE

  7. Change to the directory that contains the Capacity Agent installation files.

  8. Run the following command:

    • (Windows)
      start /WAIT setup.exe -i silent -DOPTIONS_FILE="<driveName>:\<fileLocationPath>\AgentSilentInstallOptions.txt"
    • (UNIX and Linux)
      ./setup.sh -i silent -DOPTIONS_FILE=<fileLocationPath>/AgentSilentInstallOptions.txt

    The variables <driveName> and <fileLocationPath> represent the location where you saved the options file. If the path contains spaces, enclose the path and options file name in quotation marks.

  9. (UNIX and Linux) Run the following command as a root user to configure the Capacity Agent:

    1. Change to the root user.
    2. Change to the installation directory. The default is /opt/bmc/Patrol3.
    3. Run the following command:
      ./b1config<version>.sh

    where version indicates the version of the installed Capacity Agent.

  10. Verify that the installation is successful:
    • Verification steps for Windows:

       To verify the installation of the Capacity Agent
      1. On the computer where the Capacity Agent is installed, click Start > Settings > Control Panel.
      2. Double-click PATROL - Perform Agent.
      3. Verify that the status of the BGS_SDService service daemon is Running.
       To verify the installation of the environment variables
      1. Open the command prompt, and run the following command:
        echo %best1_home%

      2. Ensure that the following installation location is displayed:
        C:\Program Files\BMC Software\Patrol3\BEST1\NTC

       To verify data collection
      1. Click Start > All Programs > BMC Software > Collect Data.
      2. Click Start a collect process on a Console or Agent computer, and click Next.
      3. Select one of the following collection modes, and click Next.
        • Standard Mode: Transfers the collected data across a network from the target computers to the Gateway Server.
        • Secure Mode: Transfers the collected data locally.
        • Collect from a policy file: Transfers data from the computer names that are defined in a text file.
      4. If you selected Collect from a policy file, select the policy file, and click Next. You are directed to Step f.
      5. Specify one the following options to add the computers from which you want to collect data, and click Next.

        • Agent computers or network address: Type the names (host names or fully qualified domain names) or IP addresses of the computers on which you have installed Capacity Agents.
        • Optional name of Agent computer: Type the name of computer where the agent is installed. If the computer has identification other than its network name, type that name. For example, a computer with the network name 1on_subnet5 might be a mail server with an internal name emailC. The specified name appears as a directory name where the collected data is stored. For example, C:\Program Files\BMC Software\BEST1\NTC\History\emailC. The specified name appears as a directory name where the collected data is stored. For example, C:\Program Files\BMC Software\BEST1\NTC\History\emailC.

          If this field is left blank, the folder name in the collection repository takes the network name. For example, C:\Program Files\BMC Software\BEST1\NTC\History\1on_subnet5.

        • File with list of computers to collect: Specify the text file that contains the agent computer names from which you want to collect data.
      6. Type the path of the data collection directory on the agent and Gateway Server computers, and click Next.

        • Repository on the Console: Select the path to the data collection directory on the computer where the Gateway Server is installed.
        • Repository on the Agent: Select the path to the temporary repository on the computer where the agent is installed.
        • Select the action that must start after the data collection wizard is exited.
      7. Select the frequency for collecting and summarizing data, and click Next.
        • Collect data every: Specify the frequency at which the data collector must place the collected data in the memory. The default value is 10 seconds.
        • Summarize data every: Select the interval, in minutes, at which the Capacity Agent summarizes data and saves it in the repository.
      8. Specify one of the following data collection schedules, and click Next.
        • Begin immediately: Begins collection immediately after existing the wizard and stops after 24 hours.
        • Begin: Begins collection after the specified time and ends after the specified duration.
        • Begin and end by date and time: Starts and ends collection on the specified dates and at the specified times.
      9. Review the settings and click Finish.
      10. When the collection duration ends, confirm that the correct files are created in the following formats:
        • repository\computerName\date.time\type-of-stats\raw.udr
        • repository\computerName\date.time\type-of-stats\raw.lox
          (The default repository on the Gateway Server computer is C:\Program Files\BMC Software\Patrol3\NTC\history).

          The temporary default repository on the agent computer is C:\Program Files\BMC Software\Patrol3\BEST1version\History. This directory serves as a repository until the data is transferred to the Gateway Server computer.

    • Verification steps for Linux:

       To verify data collection
      1. To configure the BEST1_HOME environment variable, run the following commands:

        1. Change to the non-root user.
        2. Run the following commands:
          • For the Korn or Bourne shell:
            1. BEST1_HOME=usr/adm/best1_<version>
            2. export BEST1_HOME
          • For the C shell:
            setenv BEST1_HOME usr/adm/best1_<version>
            where version indicates the version of the installed product component.
      2. To test the connection to the Agent, run the following command:

        $BEST1_HOME/bgs/scripts/best1collect -n <targetHostName> -q

        The following example shows the result of running this command on the clm-pun-015565 system:

        [perform@clm-pun-032515 ~]$ $BEST1_HOME/bgs/scripts/best1collect -n clm-pun-015565 -q best1collect on clm-pun-032515: requesting Update Status on clm-pun-032515 ... Wed Mar 15 00:06:00 2017 Agent Query Request Starting(/usr/adm/best1_10.7.00/bgs/monitor/log/clm-pun-032515-bgsagent_6767.als) Collect Instance Node Started Started Name Name Name By On ------------ -------------- ---------- ---------- ----------------- ------------ -------------- ---------- ---------- ----------------- *Node: clm-pun-032515 has acknowledged Query request successfully.


      3. To initiate a data collection request, run the following command. Replace <nodeName> with the name of the system where you want to initiate the collection request.

        $BEST1_HOME/bgs/scripts/best1collect -n <nodeName> -e +15 -d /tmp -w 1

        The following example shows the result of running this command on the clm-pun-015565 system:

        [perform@clm-pun-032515 scripts]$ $BEST1_HOME/bgs/scripts/best1collect -n clm-pun-015565 -e +15 -d /tmp -w 1 best1collect on clm-pun-032515: requesting Start Collect on clm-pun-015565 ... best1collect requesting bgscollect start on clm-pun-015565... Tue Mar 14 22:30:04 2017 best1collect: Collect process with instance noInstance will be started on node clm-pun-015565. Specified data repository: /tmp. *Node: clm-pun-015565 has acknowledged Start request successfully. 
      4. To verify the status of data collection, run the following command:

        $BEST1_HOME/bgs/scripts/best1collect -n <nodeName> -Q

        The following example shows the result of running this command on the clm-pun-015565.bmc.com system:

        [perform@clm-pun-032515 scripts]$ $BEST1_HOME/bgs/scripts/best1collect -n clm-pun-015565.bmc.com -Q best1collect on clm-pun-032515: requesting Update Status on clm-pun-015565.bmc.com ... Tue Mar 14 22:35:50 2017 Agent Query Request Starting(/usr/adm/best1_10.7.00/bgs/monitor/log/clm-pun-015565-bgsagent_6767.als) Collect Instance Node Started Started Data Length Spill SampleState Config Active Active Term Term LagTime Name Name Name By On Repository HH:MM (Min) (Sec) Groups Data No Data Data No Data (Min) ------------ -------------- ---------- --------------------------- ----------------------------- ------ ----- ------------------------ ------ ------ ------- ---- ------- ------- SYSTEM noInstance clm-pun-015565 perform Mar-14-2017.22.30/tmp 0:15 15 10 UDR_WRITE_ACTIVE 46 19 2 0 25 0 ------------ -------------- ---------- --------------------------- ----------------------------- ------ ----- ------------------------ ------ ------ ------- ---- ------- ------- *Node: clm-pun-015565.bmc.com has acknowledged Query request successfully
      5. Verify that the Active Data parameter shows a value greater than 0, which indicates that the data collector is functioning as expected.

Next step in the Installation process

Now that you have successfully installed the Capacity Agent, you must complete the post-installation activities.

Was this page helpful? Yes No Submitting... Thank you

Comments