Automating Citrix Probe Agent Installation and Configuration
Article ID: CTX493268
Updated On:
Description
Purpose
This article contains instructions on using PowerShell to automate the installation and configuration of Citrix Probe Agent. The PowerShell script can be downloaded from this page. The same script can also be used to update the configured values for an existing installation of Probe Agent.
Where to download ?
Certain legacy Citrix tools are now available on request only. Please submit the request here - https://forms.gle/obA39PEz5qpDiSPq8
Once we verify your request, we will provide access to the download location.
Prerequisites
If the downloaded PowerShell script cannot be run due to Windows security policies, use the Unblock-File command on PowerShell. Eg:
Unblock-File -Path C:\Users\User01\Downloads\configure_agent.ps1
Refer here for more details on how to use this command.
Usage
What are the arguments for the PowerShell script?
| Argument | Description |
|---|---|
| StoreFrontUrl |
Citrix Storefront/Workspace URL or |
| StoreFrontUserName | Citrix Storefront/Workspace user name or Citrix Gateway username |
| StoreFrontPassword | Citrix Storefront/Workspace password or Citrix Gateway password |
| StorefrontSiteAggregation | Set this argument as: “1”, if storefront site aggregation is present “0”, if storefront site aggregation is absent |
| StorefrontAuthenticationMode |
Set this argument as: |
| StorefrontGatewayMfaRegistrationKey | Citrix Gateway MFA (Native OTP) registration key |
| DirectorUrl | Director URL |
| DirectorUserName | Director user name |
| DirectorPassword | Director password |
| SiteId | Director site id. This can be obtained from the response body of the GetInitializationData HTTP call when logging in to the Director from the browser. The JSON response of this call will have a “Sites” field with “Id” as a child field which would have the site id value. |
| SiteName | The Director site name. This can be obtained from the response body of the GetInitializationData HTTP call when logging in to the Director from the browser. The JSON response of this call will have a “Sites” field with “Name” as a child field which would have the site name value. |
| ClientId | The Citrix Cloud client ID. |
| SecretKey | The secret key corresponding to the Citrix Cloud client ID supplied. |
| CustomerId | The Citrix Cloud customer ID. |
| CloudEnabled | Set this argument as: “1” when configuring cloud environments. It can be skipped for on-prem environments. |
| Region | Set this argument as: “2”, if the cloud environment is in Japan. “3”, if the cloud environment is Gov. In all other cases, this argument can be skipped. |
| PathToMsi | This argument can be skipped if Probe Agent is already installed. If Probe Agent has to be installed, specify the absolute path to the .msi file as the value for this argument. |
Once Probe Agent is installed and all the necessary values are configured, we can update specific values by providing just those arguments to the script. When running the script for Citrix DaaS Monitor, always give the CloudEnabled argument with value as “1”, even when updating already configured values. Refer to the below examples for more information.
To install Probe Agent and configure credentials for Citrix DaaS environment:
.\configure_agent -StoreFrontUrl "https://myCustId.cloud.com/Citrix/StoreWeb/" -StoreFrontUserName "TAUQH\administrator1" -StoreFrontPassword "mySFPassword" -StorefrontSiteAggregation "0" -StorefrontAuthenticationMode "0" -SiteId "8934d109-xxxx-xxxx-xxxx-7032497e25c0" -SiteName "cloudxdsite" -ClientId "82f10814-454c-46d6-9a20-be5015de160a" -SecretKey "xxxxxxxxxxxxxxxxxxxxxx==" -CustomerId "myCustId" -CloudEnabled "1" -PathToMsi "C:\Users\Administrator\Downloads\CitrixProbeAgent.msi"
To configure credentials for Citrix DaaS environment, on an already installed Probe Agent:
.\configure_agent -StoreFrontUrl "https://myCustId.cloud.com/Citrix/StoreWeb/" -StoreFrontUserName "TAUQH\administrator1" -StoreFrontPassword "mySFPassword" -StorefrontSiteAggregation "0" -StorefrontAuthenticationMode "0" -SiteId "8934d109-xxxx-xxxx-xxxx-7032497e25c0" -SiteName "cloudxdsite" -ClientId "82f10814-454c-46d6-9a20-be5015de160a" -SecretKey "xxxxxxxxxxxxxxxxxxxxxx==" -CustomerId "myCustId" -CloudEnabled "1"
To update client id and secret for Citrix DaaS Monitor, on an already configured Probe Agent:
.\configure_agent -ClientId "82f10814-454c-46d6-9a20-be5015de160a" -SecretKey "xxxxxxxxxxxxxxxxxxxxxx==" -CloudEnabled "1"
To update Storefront password, on an already configured Probe Agent for Citrix DaaS:
.\configure_agent -StoreFrontPassword "mySFPassword" -CloudEnabled "1"
To install Probe Agent and configure credentials for Citrix Virtual Apps and Desktops (CVAD) environment:
.\configure_agent -StoreFrontUrl "http://10.xxx.xx.xxx/Citrix/StoreWeb/" -StoreFrontUserName "ARQWU\administrator" -StoreFrontPassword "mySFPassword" -StorefrontSiteAggregation "0" -StorefrontAuthenticationMode "0" -DirectorUrl "http://10.xxx.xx.xxx/Director/" -DirectorUserName "ARQWU\administrator" -DirectorPassword "myDIRPassword" -SiteId "cdaaa911-xxxx-xxxx-xxxx-ec58812d5f45" -SiteName "blrprobe" -PathToMsi "C:\Users\Administrator\Downloads\CitrixProbeAgent.msi"
To install Probe Agent and configure credentials for a CVAD environment with Citrix Gateway domain credentials as the authentication method for Storefront:
.\configure_agent -StoreFrontUrl "http://xx.xxx.xx.xxx/logon/LogonPoint/" -StoreFrontUserName "ARQWU\administrator" -StoreFrontPassword "myGatewayPassword" -StorefrontSiteAggregation "0" -StorefrontAuthenticationMode "1" -DirectorUrl "http://10.xxx.xx.xxx/Director/" -DirectorUserName "ARQWU\administrator" -DirectorPassword "myDIRPassword" -SiteId "cdaaa911-xxxx-xxxx-xxxx-ec58812d5f45" -SiteName "blrprobe" -PathToMsi "C:\Users\Administrator\Downloads\CitrixProbeAgent.msi"
To configure credentials for CVAD, on an already installed Probe Agent:
.\configure_agent -StoreFrontUrl "http://10.xxx.xx.xxx/Citrix/StoreWeb/" -StoreFrontUserName "ARQWU\administrator" -StoreFrontPassword "mySFPassword" -StorefrontSiteAggregation "0" -StorefrontAuthenticationMode "0" -DirectorUrl "http://10.xxx.xx.xxx/Director/" -DirectorUserName "ARQWU\administrator" -DirectorPassword "myDIRPassword" -SiteId "cdaaa911-xxxx-xxxx-xxxx-ec58812d5f45" -SiteName "blrprobe"
To install Probe Agent and configure credentials for a CVAD environment with Citrix Gateway MFA (Native OTP) credentials as the authentication method for Storefront:
.\configure_agent -StoreFrontUrl "http://xx.xxx.xx.xxx/logon/LogonPoint/" -StoreFrontUserName "ARQWU\administrator" -StoreFrontPassword "myGatewayPassword" -StorefrontSiteAggregation "0" -StorefrontAuthenticationMode "2" -StorefrontGatewayMfaRegistrationKey "abcdxxxxxxxxxxxx" -DirectorUrl "http://10.xxx.xx.xxx/Director/" -DirectorUserName "ARQWU\administrator" -DirectorPassword "myDIRPassword" -SiteId "cdaaa911-xxxx-xxxx-xxxx-ec58812d5f45" -SiteName "blrprobe" -PathToMsi "C:\Users\Administrator\Downloads\CitrixProbeAgent.msi"
To configure credentials for CVAD, on an already installed Probe Agent:
.\configure_agent -StoreFrontUrl "http://10.xxx.xx.xxx/Citrix/StoreWeb/" -StoreFrontUserName "ARQWU\administrator" -StoreFrontPassword "mySFPassword" -StorefrontSiteAggregation "0" -StorefrontAuthenticationMode "0" -DirectorUrl "http://10.xxx.xx.xxx/Director/" -DirectorUserName "ARQWU\administrator" -DirectorPassword "myDIRPassword" -SiteId "cdaaa911-xxxx-xxxx-xxxx-ec58812d5f45" -SiteName "blrprobe"
To update password for CVAD Director, on an already configured Probe Agent:
.\configure_agent -DirectorPassword "myNewDIRPassword"
To update CVAD Storefront password, on an already configured Probe Agent:
.\configure_agent -StoreFrontPassword "myNewSFPassword"
Issue/Introduction
