Deploying Huntress with NinjaRMM

NinjaRMM provides the ability to create Scheduled Scripts to deploy third party software. This document provides the instructions to add a Scheduled Scripts to your Policies to deploy the Huntress Agent to your customer's computers. Once the integration is complete, deployed agents will enter a "deployment" or "staging" organization and the integration will move them to a Huntress organization with the same name as your Ninja RMM. Organizations that do not yet exist on the Huntress side will be automatically created. 

This guide is meant to provide a basic overview of deploying the Huntress Agent using NinjaRMM. We are not able to offer comprehensive support for NinjaRMM, please refer to the NinjaRMM documentation for full details regarding usage of NinjaRMM policies and scheduled scripts.

Installing any product should be a breeze and that's especially true with Huntress. The Huntress Agent installer runs on 32 and 64-bit Windows systems (Vista/Server 2008 and above) without any user interruptions or reboots. The following is an overview of installing the Huntress Agent using NinjaRMM.


1
Retrieve Your Huntress Account Key
2
Create Huntress Deployment Organization for NinjaRMM
3
Create API Key in NinjaRMM and configure Huntress Integration
4
Download, Edit, and Import the Huntress Deployment Script for NinjaRMM
5
Add a Scheduled Script to Your Policy

Retrieve Your Huntress Account Key

  1. Login to the Huntress Web Interface.
  2. Hover over the Huntress options menu in the upper-right corner of the dashboard.
  3. Select the "Download Agent" option from the menu.
  4. On the Installer page click the clipboard icon to copy your secret account key to your clipboard.

Create Huntress Deployment Organization for Ninja RMM

  1. Hover over the Huntress options menu and click on the "Organizations" option
  2.  Click the "Add" button in the upper right window and fill out a Name and Key for your Deployment Organization. Click "Save" when complete.
    (You can use any name you like, but we recommend using something like Ninja Deployment for easy tracking.) 

Create API Key in NinjaRMM and configure Huntress Integration

  1. In your NinjaRMM dashboard, click on "Configuration" in the left hand menu.
  2. Click on "Integrations"
  3. Click on "Generate API Key" in the upper right corner of the screen. 
  4. Name your API key appropriate and copy the Access Key Id and Secret Access Key to a safe place for the next steps. Click Close when done.
  5. In your Huntress portal, hover over the options menu and click the "Integrations" option.
  6. Click the "Add" button in the upper right corner and choose "NinjaRMM" under the Remote Management section of the menu.
    If you do not see the Ninja RMM option, please contact our support team to have this beta feature enabled on your account.
  7. Enter the Access Key Id and Secret Access Key from step 4 into the first two boxes, and choose your deployment organization from the drop down list. Click Add when done.
  8. If all goes well, you should see your chosen Deployment Organization and a green check mark under Status. 

Download, Edit, and Import Huntress Deployment Script

  1. Download our PowerShell Deployment Script
  2. In your NinjaRMM dashboard, click on "Configuration" in the left hand menu.
  3. Click on "Scripting"
  4. Click on "Create New Script" in the upper right hand area.
  5. Paste the entire script into the left hand pane. Scroll down to around line 47 and paste your Huntress account secret key over the __ACCOUNT KEY__ text in the script. Scroll down to around line 50 and paste your NinjaRMM Deployment Organization Key over the __ORGANIZATION KEY__ text in the script. Note: It is important to use the normalized key (e.g. "ninja-deployment") and not the name (e.g. "Ninja Deployment") for this step! This key can be found in the Huntress portal in the Organizations tab.
  6. Fill out the form on the right hand pane with a name, description, category, scripting language, operating system, and architecture as shown below. You may set custom values for name, description, and category, but language must be PowerShell and Architecture must be set to All
  7. Click the "save" button in the upper-right corner of the script editor.

Add a Scheduled Script to Your Policy

NOTE: This section is provided as a general guideline. You may wish to add the Huntress script to one or more custom policies in your deployment. We are not able to offer comprehensive support for NinjaRMM, please refer to the NinjaRMM documentation for full details regarding usage of NinjaRMM policies and scheduled scripts.

  1. Log in to NinjaRMM.
  2. Navigate to the policy you want to use to install the Huntress Agent by clicking configuration, policies, and the policy name. Alternatively, you can create a new policy. In this example, we're using the "Windows Workstation" policy.
  3. Click on the Scheduled Scripts menu in the left and then Add a scheduled Script on the right.
  4. In the Scheduled Script window choose an appropriate name and description for the script. Set the Schedule and Notification preferences to your preferred settings. Click the "Add Script" button. 
  5. Navigate to the category you set for your script in Step 6 of the previous section and click on the script to import it into the schedule. 
  6. Leave the "Preset Parameter" field blank and leave "Run As" set to "System", and click Apply
  7. This will close the parameter window. Now click "Add" to add the script to the schedule. 
  8. Click "Save" in the upper right hand corner. You are now ready to deploy the Huntress Agent via NinjaRMM! 

Still need help? Contact Us Contact Us