Use NinjaOne custom fields to hold your CyberQP Install Token and each customer's Agent ID, then point the Quickpass agent installation script at those fields. When you finish, the script installs the Quickpass agent on any device you run it against and links it to the right CyberQP customer automatically.
Time to complete: about 15 minutes, plus a minute per NinjaOne organization
Before you start
- Prerequisite: your customers already exist in the CyberQP dashboard, created through IT Glue, Hudu, ConnectWise Manage or manually.
- Prerequisite: you have the template script from PowerShell Script for Agent Installation, and you have read Scripted Agent Installation to understand what each parameter does.
- You'll need: NinjaOne access to Administration, and access to Settings and Customers in the CyberQP dashboard.
- You'll need: the script to run with administrator rights on the device. NinjaOne's Run as System setting covers this.
Steps
Create the install token custom field
- In NinjaOne, go to Administration > General > System custom fields.
-
Select Add custom field, then select Text from the list of field types.
-
On the Overview tab, enter
globalcyberqpinstalltokenin Label. Name fills in to match, and that name is what the script reads later.
-
Select Inheritance, then check Device and Organization. System is already checked.
-
Select Permissions, then set both Automations and API to Read/Write.
⚠️ Both default to None
Leave either at None and the deployment script cannot read the field. Leave Access at Editable and technician access at All technicians.
-
Select Submit. globalcyberqpinstalltoken now appears in the System custom fields list with type Text.
Create the Agent ID custom field
- Go to Administration > Organizations > Organization custom fields.
-
Select Add custom field, then select Text.
- Enter
cyberqpagentidin Label. Name fills in to match. -
Select Inheritance, then check Device. Organization is already checked.
-
Select Permissions, then set both Automations and API to Read/Write.
-
Select Submit. cyberqpagentid appears in the Organization custom fields list.
Add your install token
The install token is the same for every customer, so you only set it once, at the system level.
-
In the CyberQP dashboard, go to Settings > Agents and select the copy icon next to Install Token.
- In NinjaOne, select Dashboard, then select Custom > Default fields.
-
Select the edit (pencil) icon on System - Default fields.
-
Paste the install token into globalcyberqpinstalltoken, then select Save.
Add the Agent ID for each organization
Agent IDs are customer-specific, so repeat this for every NinjaOne organization you deploy to.
-
In the CyberQP dashboard, go to Customers, select the three-dot menu on the customer's row, then select Copy Agent ID.
💡 Getting Agent IDs in bulk
Go to Reports and, under Customers (Export customers and status), select Download CSV File. The CSV lists every customer name with its Agent ID.
-
In NinjaOne, open the matching organization, then select Custom > Default fields. The inherited globalcyberqpinstalltoken already shows here; cyberqpagentid shows No value.
-
Select the edit (pencil) icon on Organization - Default fields, paste the Agent ID into cyberqpagentid, then select Save.
💡 Agent ID is optional on 6.5.3.1+
From agent version 6.5.3.1 you can leave the Agent ID blank or enter the customer name instead. If it is blank or does not resolve (a typo or a duplicate customer name), the agent installs as an Unassigned Agent, which you can assign later from the CyberQP dashboard – see Assign an Unassigned Agent.
Point the deployment script at the custom fields
- In NinjaOne, go to Administration > Library > Automation.
-
Open your Quickpass agent install script. If you have not added it yet, select Add automation > New script and paste in the template script.
- Looking for the PowerShell script? Find and copy it from here - PowerShell Script for Agent Installation
-
Find the lines that set
$QPInstallTokenIDand$QPAgentID, and replace them with these four lines:$CustomFieldInstallToken = Ninja-Property-Get globalcyberqpinstalltoken $CustomFieldAgentID = Ninja-Property-Get cyberqpagentid $QPInstallTokenID = $CustomFieldInstallToken $QPAgentID = $CustomFieldAgentID💡 What to check while you edit
- The name after
Ninja-Property-Getmust match the custom field's Name exactly. Start typing and NinjaOne suggests it. - The
$CustomField…variable names are yours to choose, as long as each pair matches. - For an EU or Canada tenant, set
$RegionIDto"EU"or"CA"."NA"is the default.
- The name after
- Select Save.
-
In the NinjaOne organization you prepared, run the script against the devices you want to deploy to.
Verify it worked
Each device inherits both values, and the script installs the Quickpass agent under the matching CyberQP customer.
- Before you run the script – open any device in the organization and select Custom > Default fields. Both cyberqpagentid and globalcyberqpinstalltoken show a value.
- After you run it – the device's Activities show the script action completed with a SUCCESS result, followed by Software installed: 'Quickpass Agent'.
Troubleshooting
- A device shows No value for globalcyberqpinstalltoken > open the field under System custom fields and make sure Device and Organization are both checked on Inheritance.
-
The script runs but the token or Agent ID is empty > check the field's Automations permission is Read/Write, and that the name after
Ninja-Property-Getmatches the field Name exactly. - The agent installs as an Unassigned Agent > the organization's cyberqpagentid is empty or wrong. Correct it, and assign the agent from the CyberQP dashboard – see Assign an Unassigned Agent.
Comments
0 comments
Please sign in to leave a comment.