Skip to main content

Deploy QuickPass Agent

Summary​

This script installs the QuickPass Agent on Windows machines where it is not already installed. The QuickPass EDF must be selected, and the QuickPass Agent ID EDF should be populated with the specified CustomerID at the client level. Additionally, the System Property QuickpassInstallToken must be filled with the installation token to ensure the script installs the agent successfully.

Note: The script attempt to uninstall QuickPass Agent before installing QuickPass Agent (64-bit) if QuickPass Agent is installed on the machine.

Sample Run​

First Run: Execute the script with the user parameter Set_Environment as 1 to import the System Property QuickpassInstallToken, and deployment EDFs needed for the script.
Sample Run

Regular Run:
Sample Run

Dependencies​

Global Parameters​

NameRequiredExampleDescription
regionFalseNASet it to the region code for the installation of the Quickpass

User Parameter​

NameRequiredExampleDescription
Set_EnvironmentFalse1Running the script with the user parameter Set_Environment as 1 will import the System Property QuickpassInstallToken and the required deployment EDFs needed for the script. Note: Set to 1 for first-time implementation.

System Property​

NameRequiredExampleDescription
QuickpassInstallTokenTrued7ksgi-yh67-kdsh77-jd888It must be filled with the installation token to initiate the QuickPass Agent installation

Extra Data Fields​

EDF NameLevelTypeSectionDescription
QuickPassClientCheckBoxQuickPass DeploymentCheck it if you would like to enable the client for QuickPass Deployment
QuickPass Agent IDClientTextFieldQuickPass DeploymentPopulate it with the specified CustomerID at the client level to initiate the installation on targeted client machines
QuickPass Agent IDLocationTextFieldQuickPass DeploymentPopulate it with the specified CustomerID at the location level to override the value stored in client-level EDF QuickPass Agent ID
Exclude from QuickPass DeploymentLocationCheckBoxExclusionsCheck it if you would like to exclude a location from QuickPass Deployment
Exclude from QuickPass DeploymentComputerCheckBoxExclusionsCheck it if you would like to exclude a computer from QuickPass Deployment

  • The QuickPass EDF must be selected, and the QuickPass Agent ID EDF should be populated with the specified CustomerID at the client level to initiate the installation on targeted client machines.
    QuickPass Agent ID
    For more information on how to fetch the QuickPass Agent ID, refer to the document Export Customers List, Status and Agent IDs – CyberQP (getquickpass.com).

  • The QuickPass Agent ID EDF can be populated with the specified CustomerID at the location level to override the value set in the client-level EDF.
    QuickPass Agent ID

  • The System Property QuickpassInstallToken must be filled with the installation token to initiate the QuickPass Agent installation.
    QuickpassInstallToken
    The QuickPass Installation Token can be fetched from the Quickpass Dashboard. Navigate to the Settings Menu and then to the Admin Login Details section. Click the COPY button for the Install Token.

  • Select the location-level EDF Exclude from QuickPass Deployment to exclude the desired location from receiving the QuickPass agent deployment.
    Exclude from QuickPass Deployment

  • Select the computer-level EDF Exclude from QuickPass Deployment to exclude the desired machine from receiving the QuickPass agent deployment.
    Exclude from QuickPass Deployment

Output​

  • Script Logs
  • Ticketing

Ticketing​

Subject: QuickPass Agent Installation Failed on %ComputerName%(%ComputerID%)

Ticket Body:

Failed to start Quickpass Server Agent Service. Confirm the variable `QuickPassDeploy` = '@QuickpassDeploy@',` QuickPassAgentID` = '@QuickpassAgentID@', `QuickPassToken` = '@Token@'. are defined and try again, or check the error logs: %shellresult%

When the script fails to download the installer:

Failed to download Quickpass-Agent-Setup.exe on %computername% at %clientname%. Please ensure that the computer can reach the download URL [https://storage.googleapis.com/qp-installer/production/Quickpass-Agent-Setup.exe](https://storage.googleapis.com/qp-installer/production/Quickpass-Agent-Setup.exe)

Changelog​

2026-03-06​

  • Updated the script to fetch the EDFs and system property value using SQL rather than script functionality.
  • Adjusted the script to create ticket if the TicketCategory is set in the monitor
  • Used latest vendor logic for the deployment

2025-04-10​

  • Initial version of the document