When you install or update the vRealize Log Insight Linux agent DEB package, you can set the target server during installation and keep or replace the liagent.ini configuration file. After installation, you can verify the installed version.

About this task

The agent DEB package installation can installed or upgraded from the command line and modified with package options, or it can be configured through the debconf database. The following table shows supported options.

You can install the agent in two ways. You can specify additional parameters during installation

Prerequisites

  • Read about installation defaults and how to change them at vRealize Log Insight Agent Installation Options.

  • Log in as root or use sudo to run console commands.

  • Verify that the vRealize Log Insight Linux agent has access to syslog and networking services to function. By default, the vRealize Log Insight Linux agent runs on runlevels 2, 3, 4, and 5 and stops on runlevels 0, 1, and 6.

Procedure

  1. Open a console and run the dpkg -i package_name command to install or update the vRealize Log InsightLinux agent.

    Replace package_name with the vRealize Log Insight name vmware-log-insight-agent- and the appropriate version build number of your download version. This installs the package using all default values.

    dpkg -i vmware-log-insight-agent-VERSION-BUILD_NUMBER_all.deb
  2. (Optional) : Verify the installed version by running the dpkg -l | grep -i vmware-log-insight-agent command.

Customizing Configuration

Optionally, you can override the default configuration values for installation or the current configuration values during an update. You do this by specifying options as part of the install or upgrade command.

For a complete list of options, see Options for vRealize Log Insight Agents

sudo <OPTION=value> dpkg  -i vmware-log-insight-agent-<version-and-build-number>_all.deb
  • Specify a target vRealize Log Insight server.

    To set the target during installation, run the sudo command and replace hostname with the IP address or hostname of the vRealize Log Insight server as shown in the following example:

    sudo SERVERHOST=hostname dpkg -iv mware-log-insight-agent-<version-and-build-number>_all.deb

    Unless you enabled the --force-confold flag during installation, whenever you update to a newer version, the system prompts you to keep or replace the liagent.ini configuration file. The following system message appears:

    Configuration file `/var/lib/loginsight-agent/liagent.ini'
     ==> Modified (by you or by a script) since installation.
     ==> Package distributor has shipped an updated version.
       What would you like to do about it ?  Your options are:
        Y or I  : install the package maintainer's version
        N or O  : keep your currently-installed version
          D     : show the differences between the versions
          Z     : start a shell to examine the situation
     The default action is to keep your current version.
    *** liagent.ini (Y/I/N/O/D/Z) [default=N] ? 
    

    To preserve the existing configuration, use [default=N] . The additional parameters passed from the command line are still applied.

  • Configure the connection protocol.

    To override the default connection protocol, use the SERVERPROTO variable as shown in the following example:

    sudo SERVERPROTO=syslog dpkg -i vmware-log-insight-agent-<version-and-build-number>_all.deb
    				  
    				
  • Configure the connection port.

    To override the default connection port provide a value for the SERVERPORT variable to the installer as shown in the following example:

    sudo SERVERPORT=1234 dpkg -i vmware-log-insight-agent-<version-and-build-number>_all.deb 

  • Run the agent as a non-root user.

    To run the vRealize Log Insight Linux agent as a non-root user run the sudo command.

    sudo LIAGENTUSER=liagent dpkg -i vmware-log-insight-agent-<version-build-number>_all.deb

    If the specified user does not exist, the vRealize Log Insight Linux agent creates the user account during the installation. The created account is not deleted after uninstallation. If you install the Linux agent with the LIAGENTUSER=non_root_user parameter and try to upgrade with the LIAGENTUSER=non_root_user2 parameter, a conflict occurs and warnings appear because the non_root_user2 user does not have the permissions of the non_root_user user.

vRealize Log Insight

Along with environment options, the agent DEB package also can be configured through the debconf database. The following table shows supported debconf options and corresponding vRealize Log Insight agent DEB installer options:

Command-line Options

Debconf Options

Description

SERVERHOST=hostname

vmware-log-insight-agent/serverhost

IP address or host name of the vRealize Log Insight virtual appliance.

The default is loginsight.

SERVERPROTO={cfapi|syslog

vmware-log-insight-agent/serverproto

Protocol that the agent uses to send events to the vRealize Log Insight server. The possible values are cfapi and syslog.

The default is cfapi.

SERVERPORT=portnumber

vmware-log-insight-agent/serverport

Communication port that the agent uses to send events to the vRealize Log Insight or third party server. By default the agent uses the appropriate port based on the options that are set for SSL and the protocol. See default port values provided in the list below. You need to specify the port option only if it's different from these defaults.

LIAGENT_INITSYSTEM=init|systemd}

log-insight-agent/init_system

During install time, the agent automatically detects the type of init system for the machine you are installing the agent on. You can override this behavior by specifying the type of system value with this option. There are two types of supported init systems: init and systemd.

LIAGENT_AUTOUPDATE=yes|no}

vmware-log-insight-agent/auto_update

Enable or disable auto-update for the agent. You must also enable auto-update from the vRealize Log Insight server to fully enable auto-update. The default is yes.

Auto-update is not supported for Linux BIN packages.

LI_AGENT_RUNSERVICES

vmware-log-insight-agent/init_system

Immediately after the installation, the services liagentd (agent) and liupdaterd (updater) are started by default. You can prevent this by setting the LIAGENT_RUNSERVICES debconf parameter to no. The default is yes. Note that the only accepted values are yes and no. 1 or 0 are not supported values.

LIAGENT_SSL

vmware-log-insight-agent/ssl

Enable secure connection. If SSL is enabled, the agent uses TLS 1.2 protocol to communicate to the server. The default is yes.

LIAGENTUSER=user-account-name

vmware-log-insight-agent/liagentuser

Specifies an account under which the agent is run. If the user does not exist, the installer creates it as a regular user. If the specified user account does not exist, the vRealize Log Insight Linux agent creates the user account during the installation. The created account is not deleted after uninstallation.

By default the agent is installed to run as a root user.

Note that if you install the vRealize Log Insight Linux agent with the LIAGENTUSER=non_root_user parameter and try to upgrade with LIAGENTUSER=non_root_user2, a conflict occurs and warnings appear because non_root_user2 user does not have the permissions of the user non_root_user

The created user is not removed during uninstall. It can be removed manually. This parameter is intended for the agent service only. The updater service is always running as a root user.