Ninja Huntress Solution#696
Merged
Merged
Conversation
- Added Uninstall option to the `cPVAL Huntress Deployment` custom field and changed its scope to location and computer. Location and machine can be excluded from the solution, using this custom field only. - Removed `cPVAL Huntress Install - Exclude` Custom Field as exclusions is handled by `cPVAL Huntress Deployment` custom field. - Renamed the script from `Install Huntress Agent - Windows` to `Huntress Agent Manager - Windows`. - Fixed the powershell in `Huntress Agent Manager - Windows` to not throw errors if account key is not provided in case of uninstallation. - Added `Uninstall Huntress Agent - Macintosh` for Huntress agent uninstallation on MAC machines. - Added uninstallation scripts to the document. - Added compound conditions Uninstall Huntress Agent - Windows and Uninstall Huntress Agent - Macintosh for uninstallation. - Updated the documents as per our new template.
fixed changelog date format
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the NinjaOne Huntress Agent deployment solution documentation to support uninstall workflows, consolidate exclusion logic into a single custom field, and align pages with the newer documentation template.
Changes:
- Expanded
cPVAL Huntress Deploymentto include anUninstalloption and broadened its scope (org/location/computer); deprecated the old exclude field doc. - Replaced the Windows automation doc with Huntress Agent Manager - Windows and added uninstall documentation for macOS (automation + compound conditions).
- Refreshed solution + component docs to the new template (dependencies/config links, simplified steps, updated changelogs).
Reviewed changes
Copilot reviewed 14 out of 57 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/solutions/huntress-agent-deployment-ninja-one.md | Updates the solution page to include uninstall option/scripts/conditions and reflect the consolidated custom field approach. |
| docs/ninjaone/custom-fields/cpval-huntress-tags.md | Converts custom field doc to the new template format (table + dependency/config link). |
| docs/ninjaone/custom-fields/cpval-huntress-org-key.md | Converts custom field doc to the new template format (table + dependency/config link). |
| docs/ninjaone/custom-fields/cpval-huntress-install-exclude.md | Deprecates the exclude field documentation by unlisting it and adding a deprecation changelog entry. |
| docs/ninjaone/custom-fields/cpval-huntress-deployment.md | Updates deployment field docs for Uninstall + expanded scope and new template format. |
| docs/ninjaone/custom-fields/cpval-huntress-account-key.md | Converts custom field doc to the new template format (table + dependency/config link). |
| docs/ninjaone/compound-conditions/uninstall-huntress-agent-windows.md | Adds new uninstall compound condition documentation for Windows. |
| docs/ninjaone/compound-conditions/uninstall-huntress-agent-macintosh.md | Adds new uninstall compound condition documentation for Macintosh. |
| docs/ninjaone/compound-conditions/install-huntress-agent-windows.md | Updates install compound condition page to the new template and new Windows automation naming. |
| docs/ninjaone/compound-conditions/install-huntress-agent-macintosh.md | Updates install compound condition page to the new template. |
| docs/ninjaone/automations/uninstall-huntress-agent-macintosh.md | Adds new uninstall automation documentation for macOS. |
| docs/ninjaone/automations/install-huntress-agent-windows.md | Removes the old Windows install automation doc (replaced by Huntress Agent Manager - Windows doc at same slug). |
| docs/ninjaone/automations/install-huntress-agent-macintosh.md | Updates the macOS install automation doc to the new template (dependencies + config link). |
| docs/ninjaone/automations/huntress-agent-manager-windows.md | Adds the renamed Windows automation documentation and references the updated script/config. |
Comments suppressed due to low confidence (1)
docs/ninjaone/automations/install-huntress-agent-macintosh.md:42
- In Dependencies, the custom field names are misspelled as
cPVAl(lowercase L), and the Huntress installer script link points to a Windows PowerShell URL instead of the macOS NinjaRMM script. Both issues can confuse readers and break copy/paste workflows.
- [cPVAl Huntress Account Key](/docs/2b62c710-cd01-4c0a-ab26-58f637e3226a)
- [cPVAl Huntress org Key](/docs/a746555d-f311-449f-ace0-c8a3b67a2ba4)
- [cPVAl Huntress Tags](/docs/ac9bd64b-0327-4879-931d-128936bc43a6)
- [InstallHuntress-macOS-NinjaRMM.sh](https://raw.githubusercontent.com/huntresslabs/deployment-scripts/main/Powershell/InstallHuntress.powershellv2.ps1)
| | Content | Function | | ||
| | ------- | -------- | | ||
| | [Install Huntress Agent - Windows](/docs/73daf0e3-7d35-415b-ab69-386ddd7377e0) | Triggers the [Install Huntress Agent - Windows](/docs/518bff20-44d4-4206-9336-bb6922d959da) automation on Windows machines where deployment is enabled and `Huntress Agent` is not installed. | | ||
| | [Install Huntress Agent - Windows](/docs/73daf0e3-7d35-415b-ab69-386ddd7377e0) | Triggers the[Huntress Agent Manager - Windows](/docs/518bff20-44d4-4206-9336-bb6922d959da) automation on Windows machines where deployment is enabled and `Huntress Agent` is not installed. | |
| | [Install Huntress Agent - Windows](/docs/518bff20-44d4-4206-9336-bb6922d959da) | Installs the Huntress agent on Windows machines, retrieving required keys from custom fields if not provided at runtime. | | ||
| | [Huntress Agent Manager - Windows](/docs/518bff20-44d4-4206-9336-bb6922d959da) | This script automates the installation, repair, uninstallation, or reinstallation of the Huntress Agent for Windows machines. | | ||
| | [Install Huntress Agent - Macintosh](/docs/69915d4b-f3e4-4192-b71c-e77559fe9d7f) | Installs the Huntress agent on Macintosh machines, retrieving required keys from custom fields. | | ||
| | [Uninstall Huntress Agent - Macintosh](/docs/4a215450-d390-4d65-b4f9-03c144d36bc9) | Silently uninstalls Huntress from macintosh machines. | |
| | ------- | ---- | ----------------- | -------- | | ||
| | [cPVAL Huntress Deployment](/docs/67554954-e8da-48af-bda9-13a6a37c8295) | 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](/docs/bdb92684-f093-49f8-9568-09874f9f79d5) | Drop-down | `Yes`, `No` | Allows exclusion of specific locations or devices from Huntress agent auto-deployment. | | ||
| | [cPVAL Huntress Deployment](/docs/67554954-e8da-48af-bda9-13a6a37c8295) | Drop-down | `Windows`, `Windows and Macintosh`, `Disabled`,`Uninstall` | Enables Huntress auto-deployment as well as uninstallation for Windows or both Windows and Macintosh machines at the organization/location/machine level. | |
|
|
||
| Create the [Install Huntress Agent - Windows](/docs/73daf0e3-7d35-415b-ab69-386ddd7377e0) compound condition for both default agent policies: `Windows Server [Default]` and `Windows Workstation [Default]`. The example in the [document](/docs/73daf0e3-7d35-415b-ab69-386ddd7377e0) 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. | ||
|  | ||
| Create the following Compound Conditions : |
Comment on lines
+21
to
+23
| | Label | Field Name | Definition Scope | Type | Required | Technician Permission | Automation Permission | API Permission | Description | Tool Tip | Footer Text | Custom Field Tab Name | | ||
| | ----- | ---------- | ---------------- | ---- | --------- | --------------------- | --------------------- | -------------- | ----------- | -------- | ----------- | -- | | ||
| | cPVAL Huntress Account Key | cpvalHuntressAccountKey | Organization | Text | False | Editable | Read/Write | Read/Write | This is the Account Key that determines which Huntress Account an Agent should be associated with. | Paste your account secret key (from your Huntress portal's "download agent" section) | Huntress Agent Account Key | Huntress | |
Comment on lines
29
to
32
| - [Solution : Huntress Agent Deployment](/docs/e0ad73d2-fcab-43f0-9866-72a48623ef48) | ||
| - [Install Huntress Agent - Windows](/docs/518bff20-44d4-4206-9336-bb6922d959da) | ||
| - [cPVAL Huntress Deployment](/docs/67554954-e8da-48af-bda9-13a6a37c8295) | ||
| - [cPVAL Huntress Install - Exclude](/docs/bdb92684-f093-49f8-9568-09874f9f79d5) |
Comment on lines
29
to
32
| - [Solution : Huntress Agent Deployment](/docs/e0ad73d2-fcab-43f0-9866-72a48623ef48) | ||
| - [Install Huntress Agent - Macintosh](/docs/69915d4b-f3e4-4192-b71c-e77559fe9d7f) | ||
| - [cPVAL Huntress Deployment](/docs/67554954-e8da-48af-bda9-13a6a37c8295) | ||
| - [cPVAL Huntress Install - Exclude](/docs/bdb92684-f093-49f8-9568-09874f9f79d5) |
| title: 'Uninstall Huntress Agent - Macintosh' | ||
| title_meta: 'Uninstall Huntress Agent - Macintosh' | ||
| keywords: ['huntress', 'antivirus', 'auto-deploy', 'agent-policy', 'mac'] | ||
| description: 'Triggers the auto-deployment script for the Huntress Agent on Macintosh machines where deployment is enabled.' |
|
|
||
| ## Automation Setup/Import | ||
|
|
||
| [Automation Configuration](https://github.com/ProVal-Tech/ninjarmm/blob/main/scripts/install-huntress-agent-macintosh.sh) |
|
|
||
| - [Solution : Huntress Agent Deployment](/docs/e0ad73d2-fcab-43f0-9866-72a48623ef48) | ||
| - [cPVAL Huntress Account Key](/docs/2b62c710-cd01-4c0a-ab26-58f637e3226a) | ||
| - [cPVAL Huntress org Key](/docs/a746555d-f311-449f-ace0-c8a3b67a2ba4) |
Rj98-sh
approved these changes
Jun 2, 2026
Collaborator
Rj98-sh
left a comment
Rj98-sh
left a comment
There was a problem hiding this comment.
- Reviewed test result for uninstallation on Windows
- Currently, we do not have any test machine for Mac, so no test has been performed for Mac
- Verified the logic for mac uninstallation
- Halo Ticket: 0368490
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
cPVAL Huntress Deploymentcustom field and changed its scope to location and computer. Location and machine can be excluded from the solution, using this custom field only.cPVAL Huntress Install - ExcludeCustom Field as exclusions is handled bycPVAL Huntress Deploymentcustom field.Install Huntress Agent - WindowstoHuntress Agent Manager - Windows.Huntress Agent Manager - Windowsto not throw errors if account key is not provided in case of uninstallation.Uninstall Huntress Agent - Macintoshfor Huntress agent uninstallation on MAC machines.