Use Endpoint Security Installation Scripts in NinjaOne
Applies To: Endpoint Security Elite, Endpoint Security 360, Endpoint Security Prime, WatchGuard EDR, WatchGuard EDR Core, Endpoint Security Basic
You can use Endpoint Security installation scripts in NinjaOne to deploy the WatchGuard Agent to your client devices. After you successfully establish a connection to WatchGuard Cloud, you can download script parameters for your WatchGuard client accounts. You use these script parameters to run scripts in NinjaOne. Before you can use Endpoint Security installation scripts in NinjaOne, you must:
After you get the script parameters and import the scripts to NinjaOne, you can Run WatchGuard Scripts in NinjaOne.
Get WatchGuard Client Script Parameters
You can get WatchGuard Client script parameters in these ways:
- Copy Individual Client Script Parameters
- Download All Client Script Parameters
- Import Client Script Parameters
Copy Individual Client Script Parameters
You can copy script parameters for a client on the Client Settings page of the Endpoint Security Onboarding application.
To copy script parameters for a WatchGuard Cloud client account, from the Endpoint Security Onboarding application:
- Select Client Settings.
- From the WatchGuard Client list, select the WatchGuard Cloud account that you want to copy the script parameters for.
- From the Network Settings for Installation drop-down list, select the Endpoint Security network settings profile to assign to this client.
After you select a network settings profile for a client, a Copy button appears in the Script Parameters column.
- In the Script Parameters column, click Copy.
A confirmation dialog box opens.
- Click OK.
Download All Client Script Parameters
You can download script parameters for all your WatchGuard client accounts on the Client Settings page of the Endpoint Security Onboarding application.
To download script parameters for all WatchGuard Cloud client accounts, from the Endpoint Security Onboarding application:
- Select Client Settings.
- Select a client from the list.
- From the Network Settings for Installation drop-down list, select the Endpoint Security network settings profile to assign to the client. Repeat these steps for each client.
Note: If you do not assign a network settings profile to a client in the Onboarding application, the Onboarding application applies the Default Settings profile to the client in the CSV file.
- Click Download.
- Save the WatchGuardClients.CSV file to your computer.
A confirmation dialog box opens.
- Click OK.
The WatchGuardClients.CSV file contains the script parameters for every client, along with the client name, WatchGuard Cloud ID, license information, and the network settings profile assigned to the client.
Import Client Script Parameters
You can import a CSV file with script parameters for all clients on the Client Settings page of the Onboarding application.
Note: When a WatchGuard Client is listed in the Onboarding application but not in the import file, the Default Settings profile is automatically applied to that client when parameters are imported.
To import script parameters for all WatchGuard Cloud client accounts, from the Endpoint Security Onboarding application:
- Select Client Settings.
- Click Import.
- Select the file you want to import, then click Open.
The Client Settings page refreshes with imported script parameters.
Import WatchGuard Scripts into NinjaOne
When you download the WatchGuard Endpoint Security integration for NinjaOne, the downloaded folder includes WatchGuard scripts. Use these installation scripts in NinjaOne to deploy the WatchGuard Agent to your client devices.
You must perform these steps to import WatchGuard scripts into NinjaOne:
- Create Organization Custom Field
- Add Script Parameters to Organization
- Create Script Category
- Import the WatchGuard Scripts
Create Organization Custom Field
Before you import WatchGuard scripts into NinjaOne, create an organization custom field. You use this field to store client script parameters for your WatchGuard clients (organizations) in NinjaOne.
To create an organization custom field, in NinjaOne:
- Select Home > Administration > Organizations > Organization Custom Fields.
- Click Add Custom Field.
- From the drop-down list, select Secure.
The Add Custom Field dialog box opens.
- On the Overview tab, in the Label text box, type WatchGuard Agent Script Parameters.
The Name text box auto-populates when you enter text in the Label text box.
- On the Permissions tab, from the Automations drop-down list, select Read Only.
- On the Advanced Settings tab, in the Max Characters text box, type 10000.
- Click Submit.
Add Script Parameters to Organization
After you create the WatchGuard Agent Script Parameters custom field, enter the script parameters for each of your WatchGuard clients (organizations) in NinjaOne.
To add script parameters to an organization:
- In NinjaOne, select Dashboard > Overview.
- From the Organizations list, select the organization (WatchGuard Client) you want to add script parameters for.
- From the Custom drop-down list, select Default Fields.
The Custom (Default Fields) page opens. - Find WatchGuard Agent Script Parameters in the list, and click the edit icon.
- Open the Endpoint Security Onboarding application and go to the Client Settings page.
- Select the WatchGuard Cloud account that you want to copy the script parameters for, then click Copy.
- Return to NinjaOne.
- In the WatchGuard Agent Script Parameters text box, paste the script parameters you copied from the Endpoint Security Onboarding application.
- Click Save.
- Repeat this procedure for every organization you deploy to.
Create Script Category
You must create an automation category in NinjaOne for the imported scripts.
To create a category, from NinjaOne:
- Select Home > Administration > Library > Automation.
- Select the Categories tab.
- Click Create Category.
- In the Name text box, type WatchGuard Endpoint Security Installation.
- Click Create.
Import the WatchGuard Scripts
This script table includes the script name, description, category, file name, language, operating system, and architecture information for each WatchGuard script. Use the data in this table when you import scripts into NinjaOne.
| Script Name | Description | Category | File Name | Language | Operating System | Architecture |
|---|---|---|---|---|---|---|
| WatchGuard Endpoint Security Agent - Windows | Install the WatchGuard Agent on Windows devices | WatchGuard Endpoint Security Installation | WG-Install-Windows.PS1 | PowerShell | Windows | All |
| WatchGuard Endpoint Security Agent - Mac | Install the WatchGuard Agent on Mac devices | WatchGuard Endpoint Security Installation | WG-Install-Mac.SH | ShellScript | macOS | 64-bit |
| WatchGuard Endpoint Security Agent - Linux | Install the WatchGuard Agent on Linux devices | WatchGuard Endpoint Security Installation | WG-Install-Linux.SH | ShellScript | Linux | All |
To import scripts, from NinjaOne:
- Select Home > Administration > Library > Automation.
- Select the Automations tab.
- Click Add Automation.
- From the drop-down list, select Import From File.
- Select the WG-Install-Windows.PS1 script from the NinjaOne folder.
- Click Open.
The Create Script page opens.
- In the Name text box, type WatchGuard Endpoint Security Agent - Windows.
- In the Description text box, type Install the WatchGuard Agent on Windows devices.
- From the Categories drop-down list, select WatchGuard Endpoint Security Installation.
- From the Language drop-down list, select PowerShell.
- From the Operating System drop-down list, select Windows.
- From the Architecture drop-down list, select All.
- Click Save.
- Repeat this procedure for the macOS and Linux installation scripts. Use the data from the script table to enter the required information.
Run WatchGuard Scripts in NinjaOne
To run the imported WatchGuard scripts in NinjaOne, you must create groups for the devices without Endpoint Security products installed, then create tasks to install the WatchGuard Agent on the devices in those groups. You must create separate groups and tasks for the WatchGuard Agent to install on Windows, Mac, and Linux devices.
Create Groups
Create groups for each type of device you want to deploy to.
Note: You must have at least one Windows device, one Mac device, and one Linux device with Endpoint Security installed in your NinjaOne inventory to configure groups and tasks.
- Select Home > Administration > Devices > Groups.
- Click Create New Group.
The Devices page for a new group opens.
- From the Organization drop-down list, select the organization (the WatchGuard client) you want to create the group for.
- (Optional) From the Location drop-down list, select the locations you want to create the group for.
- From the Type drop-down list, select:
- Windows Desktop
- Windows Laptop
- Windows Server
- From the Role drop-down list, select All.
- From the Status drop-down list, select All.
- From the More Filters drop-down list, select Software Inventory.
The Filter By: Software Inventory dialog box opens.
- From the Contains drop-down list, select Does Not Contain.
- From the All drop-down list, select Any.
- Click Add.
- In the Search text box of the Software dialog box, enter WatchGuard Agent.
- Select the WatchGuard Agent check box, then click Add.
- In the Filter by: Software Inventory dialog box, click Apply.
- On the Devices page, click Save Group.
The Save as Group dialog box opens. - In the Name text box, type a name for the group. For example, Windows Devices without Endpoint Security Agent.
- In the Description text box, type a description for the group.
- Click Save.
- Select Home > Administration > Devices > Groups.
- Click Create New Group.
The Devices page for a new group opens.
- From the Organization drop-down list, select the organization (the WatchGuard client) you want to create the group for.
- (Optional) From the Location drop-down list, select the locations you want to create the group for.
- From the Type drop-down list, select:
- Mac Desktop
- Mac Laptop
- Mac Server
- From the Role drop-down list, select All.
- From the Status drop-down list, select All.
- From the More Filters drop-down list, select Software Inventory.
The Filter By: Software Inventory dialog box opens.
- From the Contains drop-down list, select Does Not Contain.
- From the All drop-down list, select Any.
- Click Add.
- In the Search text box of the Software dialog box, enter Management-Agent.
- Select the Management-Agent check box, then click Add.
- In the Filter by: Software Inventory dialog box, click Apply.
- On the Devices page, click Save Group.
The Save as Group dialog box opens. - In the Name text box, type a name for the group. For example, Mac Devices without Endpoint Security Agent.
- In the Description text box, type a description for the group.
- Click Save.
- Select Home > Administration > Devices > Groups.
- Click Create New Group.
The Devices page for a new group opens.
- From the Organization drop-down list, select the organization (the WatchGuard client) you want to create the group for.
- (Optional) From the Location drop-down list, select the locations you want to create the group for.
- From the Type drop-down list, select:
- Linux Desktop
- Linux Laptop
- Linux Server
- From the Role drop-down list, select All.
- From the Status drop-down list, select All.
- From the More Filters drop-down list, select Software Inventory.
The Filter by: Software Inventory dialog box opens.
- From the Contains drop-down list, select Does Not Contain.
- From the All drop-down list, select Any.
- Click Add.
- In the Search text box of the Software dialog box, enter protection-agent-dkms.
- Select the protection-agent-dkms check box, then click Add.
- In the Filter by: Software Inventory dialog box, click Apply.
- On the Devices page, click Save Group.
The Save as Group dialog box opens. - In the Name text box, type a name for the group. For example, Linux Devices without Endpoint Security Agent.
- In the Description text box, type a description for the group.
- Click Save.
Create and Run Tasks
Create tasks in NinjaOne to install the Endpoint Security Agent on all devices in a corresponding group. You can schedule tasks to run on a daily, weekly, or monthly basis. You must create separate tasks to install the Endpoint Security Agent on Windows, Mac, and Linux devices.
Note: After you install the Endpoint Security Agent on a device, the device no longer appears in the group filter results.
To create a task to install the WatchGuard Endpoint Security Agent, from NinjaOne:
- Select Home > Administration > Tasks.
- Click Create Task.
The New Scheduled Task page opens.
- On the Details tab, in the Status section, enable the Enable Scheduled Task toggle.
- In the General section, in the Name text box, type a name for the installation task. For this example, type Install Agent on Windows Devices.
- In the Description text box, type a description for the task.
- Select the Allow Groups check box.
- In the Schedule section, from the Repeats drop-down list, select how often you want the task to run.
- On the Automations tab, click Add Automation.
The Automation Library dialog box opens.
- From the Automations list, select a WatchGuard Endpoint Security Agent installation script from the list. For this example, select WatchGuard Endpoint Security Agent - Windows.
The WatchGuard Endpoint Security Agent - Windows dialog box opens. - From the Run As drop-down list, select System.
- Click Apply.
- On the Targets tab, click Add Targets.
The Add Targets dialog box opens.
- From the Groups drop-down list, select the group you created for the devices you want to deploy to. For this example, select Windows Devices without Endpoint Security Agent.
- Click Add.
The target appears in the Targets list for the task.
- Click Save.
- Repeat this procedure to create tasks for Mac and Linux devices.
After you create the tasks for all device groups, the tasks run on the schedule you selected for each.
About the WatchGuard Endpoint Security Integration with NinjaOne
Install the Endpoint Security Onboarding Application for NinjaOne
Manage the Endpoint Security Onboarding Application for NinjaOne