Skip to main content

Using CyberQP Pre-Created Scripts

  • Updated

Prerequisites

  • Ensure that you have reviewed and understand the Agent installation prerequisites and syntax outlined - Scripted Agent Installation
  • Ensure the Agent Deployment is done with an account that has Administrator permissions (Run as Administrator)

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
 

 

Pre-Configured Scripts

CyberQP publishes pre-configured scripts to assist with the deployment.  You can access these scripts via 2 locations.
 

  1. Main Dashboard Screen - > Agents -> Add Agents (you will select the Customer to deploy to from here)
  2. Customer -> Agents -> Add Agents (this will be the specific install process for JUST this customer.)

 

Selecting the Installation Method

This page will load with multiple options to do the installation.  You will need to select the one that will work best for your customer.
 

 

Select the method you wish to install the Agent to your customer.
 

RMMs

RMM Installations can be done through a Component/XML/Import file to import to your RMM, or via a PreBuilt Powershell script that you can copy/paste directly within your RMM.

For a guided walk through on deploying the Agent via your selected RMM, click the hyperlink 'Deploy Quickpass agent using [insert RMM name]' on the Agent deployment page.

Scripted Installation

Scripted Installations can be done via Command Prompt (if you have downloaded the installer and pushed it to the system) or via PowerShell (the script automatically downloads and installs the agent).

Intune

Intune supports 3 methods of installation:

  1. App Bundle - wrapping the EXE and script into a Microsoft App Bundle to Deploy to systems.
  2. PowerShell Script - directly install the Agent via PowerShell (see this KB for instructions)
  3. Command Line Arguments - COMING SOON! (see this KB for instructions)

Manual

  1. A Manual install would be used when the technician has direct access to a system and wants to manually install via the GUI.  (most commonly used for troubleshooting)

Other

  1. This section will link you directly to the KB Articles for installation via scripting or API.

 

 

Generating the installation script.

The script will be dynamically updated based upon the Customer and options chosen on this portion of the screen.  (If you started this process directly from a Customer, the Customers value will be automatically populated)

 

  1. Select the Customer you want to deploy the Agent for - this will populate the AgentID (CustomerID) value
  2. Install Token and Region are hardcoded for you - the page will be automatically updated if the Install Token is altered - you will need to modify the value in your existing customer scripts OR just copy/paste the whole new script if the Tenant Token is rotated.
  3. Run as a Managed Account - this option is for Domain Controllers - it will be ignored on any other system Role - this is used when Local System doesn't have WRITE permissions to Active Directory.  You CAN switch to a Managed Service Account later if Local System is found to not have sufficient permissions.
    Why use Domain Admin for Agent MSA
    Changing from Local System to Managed Service Account for the Quickpass Service
    Using MSA for Agent on Domain Controllers - Resolving Inability to Start Service
     
  4. Reboot after installation - Do you want the system to reboot after the agent is installed?  This is only required for Domain Controllers to load the Password Filter DLL.  You can arrange this at a later time during your Customers' Outage Window.

 

Using the Generated Installation Script

  1. Copy the script via the "COPY" button in the upper right corner of the script that was generated.

  2. Paste the script into any of the desired solutions or save the PowerShell script as a PS1 file and copy to the Customer's system. (or use PowerShell ISE and paste into a new Editor screen)
  3. Run the script or submit the job/task via your RMM.

 

 

Monitoring Installations of Agents

With these generated Agent scripts, you can monitor the Agent installation as it is processing (individually or in bulk via RMM/management solution).

The agents that are currently in the process of installation will be shown in the lower portion of the screen:

NOTE: This screen is dynamic (any running agent installation will appear here), however, if you click away from the screen or refresh, the existing content will be cleared from view.

You can see each system installation progress as it reaches each phase:

  1. Started script
  2. Agent Download
  3. Started installation
    1. Any install errors during installation will be shown
  4. Success/Failure to complete the installation
  5. Agent Successfully started and communicating to the backend.

Related articles

Comments

0 comments

Please sign in to leave a comment.