Introduction

The Windows remote worker agent by NetBeez supports mass deployments via software management suites such as Microsoft SCCM or Intune. This guide reviews available parameters that can be used to enable or disable certain options, such as naming the agents as they appear on the NetBeez dashboard, enable auto-start, auto-update, etc.

 

For the deployment implementation, use the appropriate Powershell script from our Windows repository found here.

 

After installation, all these options can be modified manually by right-clicking on the NetBeez tray icon app.

 

Available Parameters

AUTOSETUP (optional) - determines whether the “Automatic setup” or “Manual setup” radio button will be selected.
Default value: “1” 
Possible values:  
AUTOSETUP = “1" - Automatic setup with secret key
AUTOSETUP = “2" - Manual setup with ports and certificate

 

SECRETKEY (required) - the secret key for your account which can be found on your NetBeez dashboard by going to Settings -> About page. 

Example:

SECRETKEY=“caafc19ae7234fb5nb18111a21033cf0f425c599”

 

CERTSOURCE (required when AUTOSETUP = "2") - sets the “Certificate file” input field value. 
No default values
Possible values: CERTSOURCE=“your Certificate file path” 

 

DASHBOARDURL (required when AUTOSETUP = "2") - sets the “Dashboard URL” input field value. Required.
No default values
Possible values: DASHBOARDURL=“your Dashboard URL”

 

PORT - sets the “Port” input field value. Required.
No default values
Possible values: PORT=“your Port”

 

SECUREPORT (required when AUTOSETUP = "2") - sets the “Secure Port” input field value. Required.
No default values
Possible values: SECUREPORT=“your Secure Port”

 

WEBSOCKETPORT (required when AUTOSETUP = "2") - sets the “Websocket Port” input field value. Required.
No default values
Possible values: WEBSOCKETPORT=“your Websocket Port”

 

AGENTNAME (optional)  - sets the “Agent name” input field value. 

Default value: The name of the machine you are running the installer on
Example:

AGENTNAME = “John-Laptop”

 

UUID (optional) - sets the “UUID” input field value. 
Default value: a new random UUID will be generated
Example:

UUID = “A2A4E8E8-AB20-461B-A771-7372744F46DB”

 

AUTOUPDATE (optional) - determines whether the “Auto update” checkbox will be off or on. 
Default value: “1"
Possible values: 
AUTOUPDATE = “” - the agent won't auto-update when a new release is available
AUTOUPDATE = “1" - the agent will auto-update when a new release is available

 

STARTONBOOT (optional) - determines whether the “Start on boot” checkbox will be off or on.

Default value: “1"
Possible values:  
STARTONBOOT = “” - the agent doesn't start on boot (the user can start it manually from Programs)

STARTONBOOT = “1" - the agent starts on boot

 

CREATESHORTCUT (optional) - determines whether the “Create desktop shortcut” checkbox will be off or on.
Default value: “1"
Possible values: 

CREATESHORTCUT = “1" - a shortcut for the NetBeez agent is created on Desktop

CREATESHORTCUT = “” - no shortcut is created on Desktop

 

INSTALLGROUP (optional) - determines whether the “Install for all users” or “Only current user” radio button will be selected.
Default value: 1 
Possible values: 
INSTALLGROUP = “1” - the agent is installed for all users
INSTALLGROUP = “2” - the agent is installed only for the current user

 

LAUNCHAPP (optional) - determines whether the desktop app is launched after the installation is finished.
Default value: 1 
Possible values:
LAUNCHAPP = "" or "1"
Default: 1
LAUNCHAPP = "" - the checkbox will not be selected
LAUNCHAPP = "1" - the checkbox will be selected

 

VERSIONVALIDATION (optional) - determines whether the installer and updater validate whether their corresponding server can support the agent version that is being installed or available for updates. As an example, if the NetBeez server is running version 9.1 and the agent is version 9.1 or lower the installation will proceed regardless of this option. If the agent version is 9.2 or higher, then

• if VERSIONVALIDATION = "1" the installation will fail. 
• if VERSIONVALIDATION = "0" the installation will proceed

Default value: 1
Possible values:
VERSIONVALIDATION = "" or "1"
Default: 1
VERSIONVALIDATION = "" - the checkbox will not be selected
VERSIONVALIDATION = "1" - the checkbox will be selected

 

Here is an example of how the installer could be launched with parameters in silent mode:

msiexec /qn /i NetBeez_Agent_Installer.msi INSTALLGROUP=“1" SECRETKEY=“caafc1nae7234fb5nb28111a21033cf0f425c599” AUTOSETUP=“1" AUTOUPDATE=“1” STARTONBOOT=“1” AGENTNAME=“TEST_COMP_NAME” UUID=“123"

If you are using the EXE lite installer the same options can be used with the difference that instead of "/qn" use "SILENT" to run the installer in silent mode.

NOTE1: if you are installing on the Windows CMD with the silent option "/qn" or "SILENT" make sure you open the Windows CMD as an administrator.

NOTE2: if you are running this on PowerShell add the option arguments in pairs of double quotes (e.g. STARTONBOOT=““1“” CREATESHORTCUT=“”“” UUID=“"123"").