Running the configuration wizard silently
Silent product software installs
You can silently install target devices, Citrix Provisioning servers, and consoles to a default installation directory using the following command:
<Installer Name>.exe /s /v"/qn"
<!--NeedCopy-->
To set a different destination, use the INSTALLDIR option:
<Installer Name>.exe /s /v"/qn INSTALLDIR=D:\Destination"
<!--NeedCopy-->
Note:
After performing a silent install of a Citrix Provisioning client, subsequent upgrades using the Upgrade Wizard fail because the client fails to reboot.
Workflow for running the configuration wizard silently
The basic steps involved in the silent configuration of servers in the farm are:
- Create a
ConfigWizard.ansfile from a configured provisioning server in the farm, or create the file manually. To create the file manually, see Create the ConfigWizard.ans file manually. - Copy the
ConfigWizard.ansfile onto the other servers in the farm, and modify the IP address in theConfigWizard.ansfile to match each server in the farm. - Run
ConfigWizard.exewith the/aparameter on each server.
Enhanced security for Configuration Wizard answer file
The configuration wizard answer files have sensitive fields such as passwords to database and domain accounts. Starting with Citrix Provisioning version 2303, these passwords are protected with enhanced security. Therefore, when you create a new answer file using the Configuration Wizard, provide a passphrase to encrypt passwords. You must use the same passphrase when you use the answer file. You can also continue using your answer files created by the Configuration Wizard prior to Citrix Provisioning version 2303.
Create the ConfigWizard.ans file using the Configuration wizard
-
Run ConfigWizard.exe with the
/sand/pparameter on a configured server. Use:-
/Pto be prompted for a passphrase -
/P:phraseto provide the passphrase on the command line
-
- On the Farm Configuration page, choose Join existing farm.
- On the Citrix Cloud page, select to Join Citrix Cloud or Do not join Citrix Cloud.
- Continue selecting configuration settings on the remaining wizard pages, and then select Finish.
- Copy the resulting
ConfigWizard.ansfile from the Citrix Provisioning application data directory in\\ProgramData\\Citrix\\Provisioning Services.
Copy and modify the ConfigWizard.ans file
- For each server, copy the
ConfigWizard.ansfile to the Citrix Provisioning application data directory. - Edit the StreamNetworkAdapterIP= value so that it matches the IP of the server being configured. If more than one IP is being used for Citrix Provisioning on the server, add a comma between each IP address.
Run the ConfigWizard.exe silently
To configure servers:
Run ConfigWizard.exe with the /a /p parameter on each server. The parameter /p ensures enhanced encryption with a passphrase. The passphrase must be the same that you provided while creating the answer file. For example, use:
-
/Pto be prompted for a passphrase -
/P:phraseto provide the passphrase on the command line
Note:
If you use an answer file created with Citrix Provisioning version 2212 or earlier, you can omit
/P.
If you join your farm to Citrix Cloud, then you must supply the Citrix Cloud administrator credentials to the Configuration Wizard when using the /a option. These credentials are necessary to register or re-register the Citrix Provisioning servers in the farm with Citrix Cloud. To supply the credentials non-interactively, do the following:
- Create a secure client for your Citrix Cloud administrator account and download the
secureclient.csvfile to your Citrix Provisioning server. -
On the Citrix Provisioning server, apply the secure client using the
Set-XdCredentialsPowerShell command, choosing the default profile. For example:Set-XDCredentials -SecureClientFile secureclient.csv -CustomerId xxxxxxx -ProfileType CloudApi -StoreAs default <!--NeedCopy-->
For instructions to create secure clients, see Get started with Citrix Cloud APIs in the Citrix Developer documentation https://developer.cloud.com/citrix-cloud/citrix-cloud-api-overview/docs/get-started-with-citrix-cloud-apis/.
For more information on Citrix DaaS Remote PowerShell SDK, see https://docs.citrix.com/en-us/citrix-daas/sdk-api.html/.
For a list of valid ConfigWizard parameters:
- Run
ConfigWizard.exewith the/?parameter. - In the Citrix Provisioning application data directory, open the resulting
ConfigWizard.outfile. - Scroll to the bottom of the file to view all valid parameters.
To get a list of commands and their descriptions, use the / c parameter.
Create the ConfigWizard.ans file manually
If you want to create the ConfigWizard.ans file from scratch, using a text editor that lets you save as Unicode, create a file named ConfigWizard.ans, and save it as Unicode. Enter the parameters shown in the table. Include all of the parameters relevant to your configuration.
| Screen | UI Option | Manual parameter |
|---|---|---|
| DHCP Services | The service that runs on this computer: Microsoft DHCP | IPServiceType=0 |
| Citrix Provisioning BootP service | IPServiceType=1 | |
| Other BootP or DHCP service | IPServiceType=2 | |
| The service that runs on another computer | Not included | |
| PXE Services | Microsoft DHCP on this computer | PXEServiceType=0 |
| Citrix Provisioning PXE service on this computer | PXEServiceType=1 | |
| The service that run on another computer | PXEServiceType=0 | |
| Farm Configuration | Farm is already configured | FarmConfiguration=0 |
| Create farm | FarmConfiguration=1 | |
| Join existing farm | FarmConfiguration=2 | |
| Database Server | DatabaseAdminAuthentication | DatabaseAdminAuthentication=< ActiveDirectoryIntegrated or SqlPassword>
|
| DatabaseAdminUsername | DatabaseAdminUsername=<SQL login> ( Used only if DatabaseAdminAuthentication is SqlPassword) |
|
| DatabaseAdminPassword | DatabaseAdminPassword=<password> (Used only if DatabaseAdminAuthentication is SqlPassword) |
|
| Database Server (after Create Farm or Join existing farm) | DatabaseAuthentication | DatabaseAuthentication=<ActiveDirectoryIntegrated or SqlPassword>
|
| DatabaseUsername | DatabaseUsername=<SQL login> (Used only if DatabaseAuthentication is SqlPassword) |
|
| DatabasePassword | DatabasePassword=<password> (Used only if DatabaseAdminAuthentication is SqlPassword) |
|
| Server name | DatabaseServer=<dBName>,<NonDefaultSQLPort> (If default port, omit port value) |
|
| Instance name | DatabaseInstance=<InstanceName>
|
|
| Database name | DatabaseNew=<DbName>
|
|
| Enable MultiSubnetFailover for SQL Server Always On | MultiSubnetFailover=<0 or 1>
|
|
| Database Mirror Failover Partner Server Name | FailoverDatabaseServer=<dBName>,<NonDefaultSQLPort> (If a database mirror failover partner is not used, this value is omitted, or has an empty value) |
|
| Database Mirror Failover Partner Instance Name | ||
| New Farm (when new farm is created) | Farm name | FarmNew=<FarmName>
|
| Site name | SiteNew=<SiteName>
|
|
| Collection name | CollectionNew=<CollectionName>
|
|
| Farm Administrator group: PVS server is in Active Directory | ADGroup=<Path to AD group> Ex: test.local/Users/Domain Users
|
|
| PVS server is in Workgroup | Group=<Path to local group> Ex: PVS-Server-1/Administrators |
|
| New Store (when new farm is created) | Store name | Store=<StoreName>
|
| Default path | DefaultPath=<Store path>
|
|
| Existing Farm (when joining an existing farm) | Farm name | FarmExisting=<database name>
|
| Site (when joining an existing farm) | Existing site; Site name | ExistingSite=<Site name>
|
| New site; Site name | Site=<Site name>
|
|
| Collection name | Collection=<Collection name>
|
|
| Store (when joining an existing farm) | Existing store; Store name | ExistingStore=<Store name>
|
| New store; Store name | Store=<Store name>
|
|
| Default path | DefaultPath=<Path to store>
|
|
| License Server | License server name | LicenseServer=<Citrix License Server’s IP, host name, FQDN>
|
| License server port | LicenseServerPort=<LicenseServerPort> (27000 is default port) |
|
| On-premises (license type) | licenseSKU=0 | |
| Cloud (license type) | licenseSKU=1 | |
| User account | Network service account | Network=1 |
| Web services for licensing port | LicenseWebServicesPort=<LicenseWebServicesPort> (8083 is default port) |
|
| User account | Network service account | Network=1 |
| Specified user account; User name/Domain |
<domain\username>
|
|
| Password | UserName2=<Password>
|
|
| Active Directory Computer Account Password | Days between password updates | PasswordManagementInterval=<#ofDays> (Including this parameter enables Automate computer account password updates) |
| Network Communications | Streaming network cards | StreamNetworkAdapterIP=<IPofStreamingNIC1,IPofStreamingNIC2,…> (comma-separated list of IPs) |
| Management network card | ManagementNetworkAdapterIP=<IPofManagementNIC> (only one IP) |
|
| Note: Network cards can be both streaming and management. | ||
| First communications port | IpcPortBase=6890 | |
| Total ports used for server communication | IpcPortCount=20 | |
| Console port | SoapPort=54321 | |
| Stream Servers Boot List | Specify boot servers (maximum of 4, LS1–LS4) | LS#=<IP,Default Subnet Mask,Device Gateway,Server Port> |
| For Default Subnet Mask and Device Gateway, use 0.0.0.0 if info is provided by DHCP | ||
| LS1=1.1.1.57,255.255.254.0,10.192.176.1,6910 | ||
| LS2=2.2.2.92,0.0.0.0,0.0.0.0,6910 | ||
| Advanced Stream Servers Boot List | Verbose mode (Display diagnostic information) | AdvancedVerbose=<0 or 1> |
| Interrupt safe mode (Select if target device hangs during boot) | AdvancedInterruptSafeMode=<0 or 1> | |
| Advanced Memory Support | AdvancedMemorySupport=<0 or 1> | |
| Network recovery method | AdvancedRebootFromHD=<0 for Restore Network Connection, 1 for Reboot from hard disk> | |
| Recovery time in seconds | AdvancedRecoverSeconds=<time in seconds>
|
|
| Login polling timeout | AdvancedLoginPolling=<time in milliseconds>
|
|
| Login general timeout | AdvancedLoginGeneral=<time in milliseconds>
|
|
| Soap SSL Configuration | SSL port | SSLPort=54323 |
| SSL certificate | SSLCert=<token>
|
|
| Problem Report Configuration | My Citrix Username | CisUserName=<username>
|
| Password | CisPassword=<password>
|
|
In this article
- Silent product software installs
- Workflow for running the configuration wizard silently
- Enhanced security for Configuration Wizard answer file
- Create the ConfigWizard.ans file using the Configuration wizard
- Copy and modify the ConfigWizard.ans file
- Run the ConfigWizard.exe silently
- Create the ConfigWizard.ans file manually