ESET Online Help

Search
Select the topic

Add Global Custom Fields

There are two sets of Global Custom Fields to be added for the plugin, Device-level and Organization-level Custom Fields.

Device Custom Fields: Values for these Custom Fields are not writable by the technician/administrator. Plugin scripts set these values.

Organization Custom Fields: Values for these Custom Fields are writable by the technician/administrator, however they are read-only for the plugin scripts. These values (for example passwords or specific URL) are used to feed data into plugin for tasks such as On-Board (Install and Activate) or Off-Board (Uninstall).

Add Global Custom Fields

1.In the NinjaOne console, click Administration > Devices > Global Custom Fields.

2.Click the desired tab Device or Organization.

3.Click Add > Field.

4.Type the Custom Field Label, Name and select from the drop-down menu Select Field Type value. Use the Device and Organization Custom Fields tables below to input the correct values.

5.Click Create.

Device Custom Fields


important

Add all Device Custom Fields

Add all Device Custom Fields, for the plugin to function properly. When added, hide any Device Custom Field not required by your usage, from the technician view.

To hide the previously added Device Custom Field, from the technician view:

1.Click Administration > Devices > Global Custom Fields.

2.Click the desired Device Custom Field name.

3.In the next window, next to Technician, click the drop-down menu and select None.

4.Click Save.

Value

Type

Use

esetProtectUrl

URL

Provides the Admin with a clickable link that will open ESET_PROTECT browser window to this device’s Details page

esetProductName

Text

Displays the name of the currently installed ESET AV product

esetProductVersion

Text

Displays the version of the currently installed ESET AV Product

esetModuleVersion

Text

Displays the VSD/Module version of the ESET AV Product

esetProtectionStatus

Multi-line

Displays any protection status issues (Example Product not activated, RTFS Disabled, etc.)

esetLicensePublicId

Text

Displays the Public License Id used to activate the ESET AV product

esetLastScanDate

Date/Time

Displays the most recent Date/Time of any ESET scan performed on the device

esetLastThreatDate

Date/Time

Displays the most recent Date/Time of any threat detected on the device

esetLastThreatName

Text

Displays the name of the most recent threat detectd on the device

Organization Custom Fields

Value

Type

Use

esetOnboardWindows

URL

(Cloud) Should contain URL to download installer bundle .exe

(On-Prem) Should contain URL to download agent .zip or .bat file. Use in conjunction with esetLicense custom field for activation post deployment

esetOnboardMac

URL

(Cloud/On-Prem) Should contain URL to download agent .tar.gz or .sh file. Use in conjunction with esetLicense custom field for activation post deployment

esetOnboardLinux

URL

(Cloud/On-Prem) Should contain URL to download agent .tar.gz or .sh file. Use in conjunction with esetLicense custom field for activation post deployment

esetLicense

Secure

Used to store activation credentials in a secure manner. Used format: username password licensepublicid

esetProtectUrlPrefix

URL

(Cloud/On-Prem)  Used to provide link to open ESET_PROTECT computer details screen via link in NinjaOne (for example  https://us02.protect.eset.com)

esetSetupPassword

Secure

(Cloud/On-Prem/DEM) Used to provide uninstall password when Off Boarding

esetSetupLanguage

Text

Set language of product install when not using EPC all in one bundle

Note: Defaults to “enu” if not set

esetSetupProduct

Text

Specify “eea” or “ees” to determine which product to install when On Boarding an ESET PROTECT On-Prem Agent for Windows or a DEM only On Board for Windows