Huntress Agent Deployment
Purpose
This solution is designed to configure the automatic deployment of the Huntress Agent on Windows and Macintosh machines that are missing the agent, using the NinjaOne platform.
Associated Content
Custom Field
| Content | Type | Available Options | Function |
|---|---|---|---|
| cPVAL Huntress Deployment | Drop-down | Windows, Windows and Macintosh, Disabled | Enables Huntress auto-deployment for Windows or both Windows and Macintosh machines at the organization level. |
| cPVAL Huntress Install - Exclude | Drop-down | Yes, No | Allows exclusion of specific locations or devices from Huntress agent auto-deployment. |
| cPVAL Huntress Account Key | Text | Stores the Huntress Account Key to associate agents with the correct Huntress account. | |
| cPVAL Huntress Org Key | Text | Stores the Huntress Organization Key. By default, this is the organization's name, but it can be customized if needed. | |
| cPVAL Huntress Tags | Text | Stores one or more tags, separated by commas (optional). |
Automation
| Content | Function |
|---|---|
| Install Huntress Agent - Windows | Installs the Huntress agent on Windows machines, retrieving required keys from custom fields if not provided at runtime. |
| Install Huntress Agent - Macintosh | Installs the Huntress agent on Macintosh machines, retrieving required keys from custom fields. |
Compound Conditions
| Content | Function |
|---|---|
| Install Huntress Agent - Windows | Triggers the Install Huntress Agent - Windows automation on Windows machines where deployment is enabled and Huntress Agent is not installed. |
| Install Huntress Agent - Macintosh | Triggers the Install Huntress Agent - Macintosh automation on Macintosh machines where deployment is enabled and Huntress is not installed. |
Implementation
Step 1
Create the following custom fields:
- cPVAL Huntress Deployment
- cPVAL Huntress Install - Exclude
- cPVAL Huntress Account Key
- cPVAL Huntress Org Key
- cPVAL Huntress Tags
Step 2
Create the following automations:
Step 3
Create the Install Huntress Agent - Windows compound condition for both default agent policies: Windows Server [Default] and Windows Workstation [Default]. The example in the document illustrates the deployment process for the Windows Workstations [Default] agent policy. It is also recommended to apply this compound condition to the Windows Server [Default] agent policy, following the same process.
Step 4
Create the Install Huntress Agent - Macintosh compound condition for both default agent policies: Mac Server [Default] and Mac [Default]. The example in the document illustrates the deployment process for the Mac [Default] agent policy. It is also recommended to apply this compound condition to the Mac Server [Default] agent policy, following the same process.
FAQ
1. Can the automations be executed manually and independently of the deployment custom fields?
Yes, the automations can be executed manually without relying on the deployment custom fields. If deployment is not enabled or the machine is excluded, the scripts can still be run manually to perform the desired actions.
2. Is the cPVAL Huntress Account Key custom field mandatory for the auto-deployment solution to work?
Yes, the cPVAL Huntress Account Key custom field is mandatory for the auto-deployment solution to function correctly. It is used to associate the Huntress Agent with the appropriate Huntress account.
3. What actions can the Windows script perform, and how are they controlled?
The Windows script can perform installation, repair, uninstallation, or reinstallation of the Huntress Agent for Windows machines. These actions are controlled by the Action runtime parameter of the script, which can be set to Install, Repair, Uninstall, Reinstall, or Reregister.
4. Why is the auto-deployment not working for a client even after enabling it?
If the auto-deployment is not working for a client, verify whether the organization, location, or machines are using a different agent policy. If they are, the compound conditions must be added to those specific agent policies as well to ensure the deployment functions correctly.