Introduction

This document outlines the procedure of installing the Enterprise Agent on Windows, and lists all the parameters that can be used during installation.

 

Prerequisites

Procedure

  1. Copy the proper Agent installer MSI (typically in the \bin\Agent folder within the Enterprise installation directory) to the local machine
  2. Copy the public certificate to the local machine
  3. Open a Command Prompt (as Administrator)
  4. Formulate and run the installation command, according to the following:

msiexec /i "[full_path_to_agent]" CER="[full_path_to_certificate]" {additional parameters} ALLUSERS=2

ParameterValueDefault ValueRequiredDescription
CER=
N/AYesFull path to the public certificate. Path must be enclosed in quotes if it contains spaces.  Acceptable certificate formats are P7B, P7C, DER, CER, and CRT.
INSTALLDIR=
C:\Program Files\AccessData\AgentNoSpecifies a desired path to install the agent.  Path must be enclosed in quotes if it contains spaces.    If not specified, the default value is assumed.
PORT=
3999NoThe port that the agent will be listening on.  If not specified, the default value is assumed.
STORESIZE=
268435456NoSpecifies the agent temporary data storage size.  If not specified, the default value is assumed.
SYSTEMSIZE=
16777216NoSpecifies the agent configuration files storage size.  If not specified, the default value is assumed.
TRANSIENT=0 | 10NoInstalls an Agent that will expire and uninstall itself after a given LLIFETIME. A 1 enables this features, and requires use of the LIFETIME parameter.  If not specified, the default value is assumed.
LIFETIME=
0NoSpecifies the amount of time that a transient agent will exist before self-destructing.  A negative value is used to denote minutes (eg. -30 denotes 30 minutes), and a positive value is used to denote days (eg. 30 denotes 30 days).  Requires use of  TRANSIENT=1.
FOLDER_STORAGE=0 | 10NoA 1 Indicates that the agent will not use protected storage.  A 0 indicates that the agent will use protected storage.  If not specified, the default value is assumed.
SERVICELESS=0 | 10NoInstalls as a one-shot, ephemeral Agent that runs only as a process, and uninstalls itself on the next reboot. A 1 enables this feature.  If not specified, the default value is assumed.
MAMA= N/ANo

Hostname or IP address and port of the Site Server that the agent should check-in with.  Default Site Server port is 54545.  If using v6.x or newer heartbeat port is by default 54555. This should only be used with a product that uses Site Server.

Retry Interval:
Connect every 30 mins.

Retry 3 times.

Wait 30 Seconds between retries
PUBSS=
N/ANoIP address and port of the Public Site Server that the agent should check-in with.  Default Site Server port is 54545.  This should only be used with a product that uses Site Server.
PUBSS_DELAY=
N/ANoThe delay cycle, in seconds, between connections to the Public SiteServer.  This will reset to the value sent from the SiteServer upon successful connection.
FIREWALL_RULE=

FTK Enterprise AgentNoThe name of the firewall rule created when an agent has been installed. 
NOT_CREATE_FIREWALLRULE
0 | 10NoA 1 indicates that the agent, when installed will not create a firewall rule at all. A 0 indicates it will install the agent with a firewall rule.
retry_failed_attempt

5NoIf a Public Site Server is not passed as a parameter, then the value will always remain at 0 - this means the agent will behave as it does as standard.

If a Public Site Server and retry_failed_attempt parameter is passed, an agent will restart automatically once it fails to connect to a Public Site Server after the passed value.

 

Notes

  • The above MSIEXEC command can be used in conjunction with an Agent MSI in SCCM (or similar) to install Agents en masse.