You can use the command-line options to install, upgrade, or manage the agent on Windows systems.
These command-line options are not case sensitive. The FramePkg.exe and FrmInst.exe files require administrator rights, so they must be run from an administrator command prompt or configured to always run as administrator.
FramePkg.exe and FrmInst.exe command-line options
Command | Description | |
|---|---|---|
/Customprops | Allows you to set custom properties. Example:
| |
/DATADIR | Specifies the folder on the system to store Trellix Agent data files. The default location is: Example: | |
/DOMAIN /USERNAME /PASSWORD | Specifies a domain, and account credentials used to install Trellix Agent. The account must have rights to create and start services on a system. If left unspecified, the credentials of the currently logged-on account are used. If you want to use an account that is local to a system, use the system’s name as the domain. Example:
| |
/enableVDImode | Installs Trellix Agent in VDI mode. | |
/FORCEINSTALL | Specifies that the existing Trellix Agent is uninstalled, then the new Trellix Agent is installed. Use this option only to change the installation directory or to downgrade Trellix Agent. When using this option, we recommend specifying a different directory for the new installation (/INSTDIR). Example:
| |
/INSTALL | /INSTALL=AGENT | Installs and enables Trellix Agent in managed mode. Example:
|
/INSTALL=UPDATER | Enables the AutoUpdate component if it has already been installed, and does not change whether Trellix Agent is enabled. This command-line option upgrades Trellix Agent. Use this command to install Trellix Agent in unmanaged mode. NoteAn Embedded credential package cannot be used to install Trellix Agent in unmanaged mode. Example:
| |
/INSTALL=AGENT /FORCE32BITSERVICES | Installs Trellix Agent in a 32-bit mode on a 64-bit operating system. Example:
| |
/INSTALL=AGENT /Relay | Allows the user to manually define the RelayServer information, such as IP address or DNS name, to the client system during the agent installation. When the client system fails to connect to the ePO - On-prem server directly or using the proxy server, it communicates using the RelayServer that is specified during the agent installation. Example:
| |
/INSTDIR | Specifies the installation folder on the system. You can use Windows system variables, such as <SYSTEM_DRIVE>. If not specified, the default location is: Example: | |
/INSTALLSIR | Install an SIR (System Information Reporter) module only when this command parameter is used, as it is not included by default in the standard Trellix Agent for Windows package. Example: | |
/UNINSTALLSIR | Uninstalls SIR module from Trellix Agent. Example: Using /FORCEUNINSTALL forcibly removes SIR along with Trellix Agent from the client system. | |
/REMOVE | Removes Trellix Agent if not in use. If in use, Trellix Agent changes to updater mode. Example: | |
/FORCEUNINSTALL | Removes Trellix Agent forcibly from the client system. Example: | |
/RESETLANGUAGE | Resets Trellix Agent language to its default operating system language. | |
/SILENT or /S | Installs Trellix Agent in non-interactive mode, hiding the installation from the user. Example: | |
/SITEINFO | Specifies the folder path to a specific repository list (Trellix Agent installer, Example: | |
/USELANGUAGE | Specifies the locale ID of Trellix Agent that you want to install. Use the switch to change current Trellix Agent language to any supported language. Example: NoteIf errors occur during installation, all error messages are displayed in English regardless of the installed locale. | |
/keepguid | Retains the Agent GUID during force installation. This command is used with Example: NoteUse this command on version 5.6.3 or later. This command is valid only when it is used with the | |