Skip Navigation

Commands for installing the
macOS
agent using the command line

When using the command line to install the
macOS
agent, you must create a
cyagent_ install_token
file that includes the installation parameters. The file includes the installation token, along with other optional parameters that you can set.
The follow sections include examples on how to create the file from the command line, but you can create the file from a text editor that includes each parameter in their own separate line. The file must be in the same folder as the installation package.

Installing the
macOS
agent with the installation token only

Use the following example commands in the terminal to create the
cyagent_ install_token
file with the installation token and install the agent. If you are using the .dmg installer, change the file extension in the command accordingly. 
echo
YOURINSTALLTOKEN
> cyagent_install_token sudo installer -pkg CylancePROTECT.pkg -target /
The following is the installation command without the installation token:
sudo installer -pkg CylancePROTECT.pkg -target /

Installing the
macOS
agent with specified parameters

Use the following example commands in the terminal to create the
cyagent_ install_token
file with the specified parameters and install the agent. If you are using the .dmg installer, change the file extension in the command accordingly.
echo
YOURINSTALLTOKEN
> cyagent_install_token echo SelfProtectionLevel=2 >> cyagent_install_token echo VenueZone=
zone_name
>> cyagent_install_token echo LogLevel=2 >> cyagent_install_token sudo installer -pkg CylancePROTECT.pkg -target /

Installation parameters

The
CylancePROTECT Desktop
agent can be installed using command line options in the terminal.
Parameter
Value
Description
InstallToken
<installation_token>
The installation token is required when you install the agent. You can find it in the management console by clicking
Settings > Application
.
NoCylanceUI
This parameter hides the system tray at startup.
SelfProtectionLevel
1 or 2
1: This value only allows local administrators to make changes to the registry and services.
2: This value only allows the system administrator to make changes to the registry and services.
If no value is specified, the default value is 2.
LogLevel
0, 1, 2, or 3
0: This value indicates that only error messages are logged.
1:This value indicates that error and warning messages are logged.
2: This value indicates that error, warning, and information messages are logged.
3: This value enables verbose logging, where all messages are logged. Note that verbose log file sizes can grow very large.
BlackBerry
recommends turning on verbose logging during troubleshooting and then changing it back to 2 when troubleshooting is complete.
If no value is specified, the default value is 2.
VenueZone
<zone_name>
Use this parameter to add devices to an existing zone, or to a zone that you want to create. If the zone does not exist, the zone is created using the name you type.
You cannot use tabs, carriage returns, newlines, equal signs, whitespace or other invisible characters in the zone name.
This parameter requires agent version 1380 or later.
ProxyServer
<ip_address>
:
<port_ number>
This adds proxy server settings to the device’s registry. You can find the proxy server information in the agent log file.
This parameter requires agent version 1470 or later.