Skip to main content

Deploy Quickpass Agent using Connectwise Automate

  • Updated

Introduction

This KB is designed to get you on your way to deploying the Quickpass Agent to your Customers' systems via the Connectwise Automate Solution.

 

Prerequisites

Agent Deployment – Install Token and Agent ID Changes

As of Agent version 6.5.3.1, the Agent ID parameter is optional:

1) Leave the Agent ID field blank, or

2) Enter the Customer name

If the customer name is left blank or does not resolve (for example, due to a typo or duplicate customer names), the Agent will install as an Unassigned Agent.

Unassigned Agents can be manually assigned to the appropriate customer from the CyberQP Dashboard.  
Refer to: Assign an Unassigned Agent
 

 

Method 1 (Recommended):
Automate Scripting Implementation

1. Download the preferred Automate script linked below (choose one based on your preferred deployment method):

  • Option A – Using Agent ID: Use this if you want to manually provide the Agent ID during installation.
  • Option B – Using Customer/Client Name (New): Use this if your RMM Customer Name matches the Customer Name in CyberQP. The script will leverage the Automate internal properties to match the client name with a QP Customer and automatically retrieve the customer Agent ID from our API.
NOTE: Option B requires the client/location name spelling in Automate to be an exact match for a QP Customer name inside your CyberQP tenant (case insensitive).

 

2. Open Connectwise Control > System > General > Import > XML Expansion > import the downloaded file.

The XML will import as 'Deploy Quickpass Server Agent' to the following location:

  • Automation > Scripts

3. Navigate to Automation > Scripts > Software > find script name Deploy Quickpass Server Agent or Deploy Quickpass Server Agent_w_Client Name.xml (you may move the script to a new folder if desired)

4. Open the import script.

5. Select Globals and Parameters tab.

6. In the Parameters window, add a parameter called 'agentID' with a blank value

  • NOTE: Skip this step if using Deploy Quickpass Server Agent_w_Client Name.xml

7. Click the installToken variable > assign the variable value the Install Token from your QP tenant > click Save.

  • QP Dashboard > Settings > copy Install Token.
NOTE: The default region is NA, if your tenant is based in Europe or Canada edit the 'region' variable to EU for Europe or CA for Canada.

 

8. Leave the agentID parameter blank - DO NOT populate a value here. 

  • NOTE: Skip this step if using Deploy Quickpass Server Agent_w_Client Name.xml

9. Review the Automate script in the Script Editor and adjust if desired regarding script logging and ticketing.

10. Click Save in the bottom right corner.

11. In Connectwise Control client or Web App, navigate to the desired machine(s) and deploy the Automate script

 

If using Agent ID deployment - Deploy Quickpass Server Agent.xml 

 

1. When the script is selected to run, the technician will be prompted to populate the run-time agentID parameter value.

Use the Agent ID according to the desired QP Customer you wish to deploy the QP Agent for:

  • QP Dashboard > Customers > Find the desired customer > Right click 3 dot icon > Copy Agent ID

2. If you need to push the script to another QP Customer, run the script again and populate the agentID parameter value to be the Agent ID value for the desired QP Customer

3. Repeat as needed.

 

 

Method 2 (Legacy):
PowerShell Implementation

  • Using Customer/Client Name (New): Use this if your RMM Customer Name matches the Customer Name in CyberQP. The script will leverage the Automate internal properties to match the client name with a QP Customer and automatically retrieve the customer Agent ID from our API.

(NEW!)

The Cyber QP agent now supports deployment via Customer/Client name.

if your RMM Customer Name matches the Customer Name in CyberQP. The script will leverage the Automate internal properties to match the client name with a QP Customer and automatically retrieve the customer Agent ID from our API.

NOTE: This requires the client/location name spelling in Automate to be an exact match for a QP Customer name inside your CyberQP tenant (case insensitive).

 

 

1. Navigate to Automation. Here, you can add a script and place it in a folder of your choice.

 

2. Fill out the required fields under the Script Editor and hit Next.

 

3. Click Global Variables

  • Create two variables named installToken and agentID
  • Assign the installToken value the Install Token from your QP tenant
    • QP Dashboard > Settings > Copy Install Token
  • DO NOT ASSIGN a value to the agentID variable - leave this blank.
  • Click Save

4. Click Parameters

  • Create a parameter named agentID - leave this blank.

When the script is selected to run, the user will be prompted to populate the agentID parameter value, which will then be assigned to the agentID variable.

Use the Agent ID according to the desired QP Customer you wish to deploy the QP Agent to:

  • QP Dashboard > Customers > Find the desired customer > Right click 3 dot icon > Copy Agent ID

5. In the Editor tab, Select Execute Script, drag into the right open space and this will open up to add the PowerShell script. Copy and paste the script from PowerShell Script for Agent Installation – CyberQP (getquickpass.com)

6. After pasting the script, edit line 12 and 13 'InstallToken' and 'CustomerAgentID' with the @installToken@ and @agentID@ variables as seen below.

  • For Customer/Client name, replace @agentID@ with %ClientName%
NOTE: The default region is NA, if your tenant is based in Europe or Canada edit the 'RegionID' variable to "EU" for Europe or "CA" for Canada.

7. Add the variables as parameters to the Script Parameters field as shown below (You may type '@' and have an autofill window select the desired variable)

8. Ensure Script Credentials is set to Admin and hit the Save button

NOTE: In some instances, Script Credentials need to be set as 'Local Agent'

9. This can now be pushed against the machines for your client.

10. If you need to push the script to a different QP Customer, run the script again and populate the agentID parameter value to be the Agent ID value for the desired QP Customer (see step No. 4).

11. Repeat as needed.


Next Steps

Additional Connectwise Automate Quickpass monitoring articles

 

 

 

Related articles

Comments

0 comments

Please sign in to leave a comment.