Installing the Capacity Agent
If you have installed the Gateway Server to collect data, you must install the Capacity Agent on the infrastructure that you want to monitor.
A Capacity Agent collects data from the managed systems in your environment. After collecting data, the Agent transfers it to the Gateway Server. You can install the Capacity Agent silently.
Preparing to install the Capacity Agent
On Windows
- Verify that the user account for installing the Capacity Agent has administrator rights.
- BMC recommends that you configure the Terminal Services on systems to prevent the installer from deleting the temporary folder while exiting installation. Ensure that the installer does not use temporary folders for each session.
On UNIX and Linux
- Ensure that you are using a non-privileged and non-root user account for installing the Capacity Agent.
- If you are installing the Capacity Agent on a Ubuntu Linux system, ensure that the
libxtst6
package is installed.To install the
libxtst6
package:- Download the package from Ubuntu packages .
- Run the following command:
dpkg -l | grep -i libxtst6
You must install the Capacity Agent on each managed system from which you want to collect data. You can use one of the following installation methods:
- Shell script: You can install the Agent using the shell script. The script uses the AgentSilentInstallOptions.txt file, which contains the parameters used for configuring the Agent.
- Docker container: You can install the Agent using a Docker container. The installation involves loading and running the Docker image on a Docker host. When you run the Docker image, the Docker container is created, and the Agent within the container is started. The Agent starts collecting the system-level metrics from the Docker host. The Docker host can be in an on-premises environment or a cloud environment, such as AWS, Azure, or Google Cloud Platform.
To install the Capacity Agent using a shell script
To install the Agent on Windows systems, ensure that you open the command prompt as an administrator for running the commands.
- Log in to the system where you want to install the Capacity Agent.
- (Windows) Log in as a user with administrator privileges.
- (UNIX and Linux) Log in as a non-root user.
Extract the Capacity Agent installer files to a temporary directory.
- (Windows) Extract
TSCO_Agent_ver20.02_MSwindows.zip
- (UNIX and Linux) Run the following command:
TSCO_Agent_ver20.02.00_<platform>_<architecture or image>.tar
For example,TSCO_Agent_ver20.02.00_Linux_x86-64.tar
TSCO_Agent_ver20.02.00_Solaris_SPARC.tar
- (Windows) Extract
(Optional) To change the default values of the installation properties, complete these steps:
Navigate to the directory that contains the extracted files.
Open the AgentSilentInstallOptions.txt file.
Update values of the required parameters.
Save the changes.
Create the following directory structure and grant the appropriate permission to the directory. By default, the Agent is installed in this directory.
- (Windows): C:\Program Files\BMC Software\Patrol3
- (UNIX and Linux): /opt/bmc/Patrol3
Run the following command to install the Agent:
- (Windows)
<path_to_install.bat>
\install.bat -DOPTIONS_FILE=<path_to_AgentSilentInstallOptions.txt>
For example,C:\Users\Administrator\Downloads\installer\install.bat -DOPTIONS_FILE="C:\AgentSilentInstallOptions.txt"
- (UNIX and Linux) ./
install.sh -DOPTIONS_FILE=<path_to_AgentSilentInstallOptions.txt>
For example,./install.sh -DOPTIONS_FILE=/installer/AgentSilentInstallOptions.txt
- (Windows)
(UNIX and Linux) Run the following command as a root user to configure the Agent:
- Change to the root user.
- Change to the installation directory and run the following command:
./b1config<version>.sh
whereversion
indicates the version of the installed Capacity Agent.
- Verify the Agent installation:
- (Windows)
- At the command prompt, enter
services.msc
- Check whether the BGS_SDService service is running.
- At the command prompt, enter
- (UNIX and Linux)
Run this command to ensure that the agent daemon service (/etc/bgs/SD/bgssd.exe -d /etc/bgs/SD -s
) is running as a non-root user:ps -ef | grep bgs
- (Windows)
You can update values of the Agent configuration parameters whenever required. For more information, see Configuring the Capacity Agents.
To install the Capacity Agent using a Docker container
Log in as a root user to the Linux system where you want to install the Agent.
- Change to the directory containing the Agent installer files that you downloaded from EPD.
Run the following command to load the zipped Docker image to a local repository:
docker load -i ho-agent-linux-x86_64_<version>.tar.gz
For example,docker load -i ho-agent-linux-x86_64_20.02.00.0.0.tar.gz
- Run this command to verify that the Docker image is loaded:
docker images
For example,$ docker images | grep tsco-agent
Sample output:bmcsoftware/ho-agent-linux-x86_64 20.02.00.0.0 7bbb7a3fae1d 29 hours ago 200MB
Run the following command to create a container from the image and start the Agent within the container:
docker run -d --pid=host --network=host --ipc=host --privileged -v /:/host:ro tsco-agent-vol:/usr/adm/best1_agent_workspace bmcsoftware/ho-agent-linux-x86_64:<version>
For example,
docker run -d --pid=host --network=host --ipc=host --privileged -v /:/host:ro tsco-agent-vol:/usr/adm/best1_agent_workspace bmcsoftware/ho-agent-linux-x86_64:20.02.00.0.0
where -v tsco-agent-vol is mounted in the container as the /usr/adm/best1_agent_workspace directory. This directory is used for storing data, logs, and state information. If you do not specify this parameter, agent data and logs are stored within the container instead of the volume on the host.
BMC also recommends adding the following arguments to the docker run command:Argument
Used to
Example syntax of the docker run command
--name <value>
Provide a name to a docker container. You can use this name in other docker commands instead of docker ID. You cannot start a new container with a similar name in the following scenarios:
A docker container with the same name is already running.
An instance of a docker container that uses the same name is available in the docker container repository.
BMC recommends using a container name such as tsco_agent.
To start a container with the tsco_agent name that is already in use, do the following:
Stop the docker container:
$ docker stop tsco_agent
Remove the stopped container.
$ docker rm tsco_agent
You can now start a new container instance with the tsco_agent name.
docker run --name tsco-agent -d --pid=host --network=host --ipc=host --privileged
-v /:/host:ro tsco-agent-vol:/usr/adm/best1_agent_workspace bmcsoftware/
tsco-agent-linux-x86_64:20.02.00.0.0
--restart=always
Restart a running docker container after rebooting the docker host.
docker run --name tsco-agent --restart=always -d --pid=host --network=host --ipc=host --privileged -v /:/host:ro tsco-agent-vol:/usr/adm/best1_agent_workspace
bmcsoftware/tsco-agent-linux-x86_64:20.02.00.0.0
(Optional) Configure the Agent history by adding one of the following arguments to the Docker run command: [ -H e|d|D ]
Argument Example syntax of the docker run command Result of running the Docker run command - H e docker run --name tsco-agent --restart=always -d --pid=host --network=host --ipc=host --privileged -v /::/host:ro tsco-agent-
vol:/usr/adm/best1_agent_workspace bmcsoftware/
tsco-agent-linux-x86_64:20.02.00.0.0 - H e
The Agent history is enabled. This is the default setting. - H d docker run --name tsco-agent --restart=always -d --pid=host --network=host --ipc=host --privileged -v /:/host:ro tsco-agent-vol:/usr/adm/best1_agent_workspace bmcsoftware/tsco-agent-linux-x86_64:20.02.00.0.0 - H d
The Agent history is disabled. - H D docker run --name tsco-agent --restart=always -d --pid=host --network=host --ipc=host
--privileged -v /:/host:ro tsco-agent-
vol:/usr/adm/best1_agent_workspace
bmcsoftware/tsco-agent-linux-x86_64:20.02.00.0.0 - H D
The Agent history is disabled and the old history files are deleted. You can use this option to remove the old history files after upgrading the Agent. - Run this command to check the status of the Agent process:
ps -ef | grep bgsagent
Comments
Log in or register to comment.