Skip to main content

Universal Install Script (Using CyberQP API)

  • Updated

This PowerShell script installs the Quickpass Agent for specific customers. The installation relies on your API token, which you can generate by following "Generating your API Credentials" in Getting started with the CyberQP API

The script retrieves the required install token and Customer ID (GUID) and then downloads and installs the agent on your system. Click here download the PS script.

 

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
 


Video


 

Setting the Customer Name

To specify the customer for this installation, you have two options for managing the $customerName variable in the script:

  1. Manual Edit:
    • You can directly replace the $customerName variable in the script with the actual customer name, such as $customerName = "Your Customer Name". This method is ideal for one-time or specific installations.
       
  2. Automated Replacement in RMM:

    • If deploying this script through an RMM tool across multiple clients, you can use a variable for the customer name, allowing the RMM to insert the correct name for each customer dynamically. This approach automates the process, reducing the need for manual edits.

       

      Help! How do I choose which method to use?

      A - If you're doing many (eg hundreds) of computers for 1 single customer. It will be much easier for you to type in the name using the manual edit method here in #1. You can still push this script out to a collection of computers using your RMM or any other system that can run a Powershell script in an automated manner.

      B - If you're going to do a batch of many customers (eg 250 in 1 week another 250 in another week) then may be more efficient to research how your RMM can pass its current "customer name" in place of $customerName in the script.
       

Additional Configuration Options

The script includes settings to customize the installation, such as:

  • Restart Options: Configure whether to restart the system after installation.
  • MSA Options: Determine whether the service will run under a Managed Service Account (MSA) or Local System Account.
  • Region ID: Specify NA for North America/Oceania tenants or EU for European tenants.
     

By using either manual replacement or automated variables, you can streamline the installation of the Quickpass Agent for your customers across different systems and regions.

Related articles

Comments

0 comments

Article is closed for comments.