Product documentation
Citrix Provisioning
Current Release 2402 LTSR 2311 2308 2305 2303 2212 2209 2206 2203 LTSR 1912 LTSR 7.15
View PDF

Farm

June 21, 2024
Contributed by: 
C

Use the information in this section to configure a farm using the Citrix Provisioning console. This section includes information about the following elements:

  • General Tab
  • Security Tab
  • Groups Tab
  • Licensing Tab
  • Options Tab
  • Virtual disk Version Tab
  • Status Tab
  • Problem Report Tab

Image of farm properties

The tables that follow identify and describe properties on each tab of the Farm Properties dialog.

General tab

Field Description
Name Enter or edit the name of this farm.
Description Enter or edit a description for this farm.

Security tab

Field Description
Add button Click the Add button to apply farm administrator privileges to a group. Check each box next the groups to which farm administrator privileges apply.
Remove button Click the Remove button to remove groups from those groups with farm administrator privileges. Check each box next the groups to which farm administrator privileges do not apply.

Groups tab

Field Description
Add button Click the Add button to open the Add System Groups dialog. To display all security groups, leave the text box set to the default *. To display groups, type part of the name using wildcards *. For example, if you want to see MY_DOMAIN\Builtin\Users, type: User*, Users, or ser. However, if you type MY_DOMAIN\Builtin\*, you get all groups, not just those groups in the MY_DOMAIN\Builtin path. Select the check boxes next to each group included in this farm. Note: Filtering on groups was introduced in 5.0 SP2 for efficiency purposes.
Remove button Click the Remove button to remove existing groups from this farm. Highlight the groups to which privileges do not apply.

Licensing tab

Field Description
License server name Type the name of the Citrix License Server in this textbox.
License server port Type the port number that the license server uses or accept the default, which is 27000.

Options tab

Field Description
Auto add When using this feature, select the site used by new target devices. If the No default site is chosen, the site of that Citrix Provisioning server that logs in the target device is used. Use the No default site setting if your farm has site scoped PXE/TFTP servers. Important: Enable this feature when adding new target devices. Enabling this feature results in computers being added without the approval of a farm administrator.
Auditing Enable or disable the auditing feature for this farm.
Offline database support Enable or disable the offline database support option. This option allows servers within this farm to use a snapshot of the database in case the connection is lost.

Virtual disk version tab

Field Description
Alert if number of versions from base image exceeds Set an alert if the number of versions from the base image is exceeded.
Default access mode for new merge versions Select the access mode for the virtual disk version after a merge completes. Options include; Maintenance, Test (default), or Production. Note: If the access mode is set to Production and a test version exists, the state of the resulting auto-merged version is automatically set to Maintenance or Test. If a Maintenance version exists, an automatic merge is not performed.
Merge after automated virtual disk update, if over alert threshold Enable automatic merge. Enable the automatic merge feature if the number or virtual disk versions exceeds the alert threshold. Minimum value is 3 and maximum value is 100.

Status tab

Field Description
Status of the farm Provides database status information and information on group access rights being used.

Problem report tab

Field Description
My Citrix Name Enter your Citrix username.
Password Enter the password associated with the Citrix user name.
Confirm Password Confirm the password associated with the Citrix user name.

Note:

The password is not saved because a login token is acquired. For more information, see CIS Problem Reporting

Using the console to configure a farm

Run the Configuration Wizard on a provisioning server when creating a farm, adding new provisioning servers to an existing farm, or reconfiguring an existing provisioning server.

If all provisioning servers in the farm share configuration settings such as site and store information, consider Running the Configuration Wizard Silently.

Configuration wizard settings

Before running the Configuration Wizard, be prepared to make the following selections:

  • Network topology
  • Identify the farm
  • Identify the database
  • Identify the site
  • Citrix License Server settings
  • Select Network Cards for the Stream Service
  • Configure bootstrap Server

Note:

If errors occur during processing, the log is written to a ConfigWizard.log file, which is at C:\ProgramData\Citrix\Citrix Provisioning.

Tip:

The Configuration Wizard was modified at release 7.12 to include support for Linux streaming. See the installation article for information about the Linux streaming component.

Starting the configuration wizard

The Configuration Wizard starts automatically after Citrix Provisioning software is installed. The wizard can also be started by selecting Start > All Programs > Citrix > Citrix Provisioning > Citrix Provisioning Configuration Wizard.

Network topology

Complete the network configuration steps that follow.

  1. Select the network service to provide IP addresses

    Note: Use existing network services if possible. If existing network services cannot be used, choose to install the network services that are made available during the installation process.

    To provide IP addresses to target devices, select from the following network service options:

    • If the Dynamic Host Configuration Protocol (DHCP) service is on this server, select the radio button next to one of the following network services to use, then click Next:
      • Microsoft DHCP
      • Citrix Provisioning BOOTP service
      • Other BOOTP or DHCP service
    • If the DHCP service is not on this server, select the radio button next to The service is running on another computer, then click Next.

  2. Select the network service to provide PXE boot information

    Each target device downloads a boot file from a TFTP server.

    Select the network service to provide target devices with PXE boot information:

    • If you use Citrix Provisioning to deliver PXE boot information, select The service that runs on this computer. Then select from either of the following options, then click Next:
      • Microsoft DHCP (options 66 and 67)
      • Citrix Provisioning PXE Service
    • If Citrix Provisioning does not deliver PXE boot information, select The information is provided by a service on another device option, then click Next.

Identify the farm

  1. Select from the following farm options:

    • Farm is already configured

      Select this option to reconfigure an existing farm, then continue on to the Configure user account settings procedure. This option only appears if a farm exists.

    • Create the farm

      1. On the Farm Configuration dialog, select the Create Farm radio button to create a farm, then click Next.
      2. Use the Browse button to browse for existing SQL databases and instances in the network, or type the database server name and instance. Optionally, enter a TCP port number to use to communicate with this database server. Note: The combination of the database name and farm name must not exceed 54 characters. In such cases, the farm name displays as a truncated entry in the Existing Farms screen.
      3. To enable database mirroring, enable the Specify database mirror failover partner option. Use the Browse button to identify the failover database server and instance names. Optionally, enter a TCP port number to use to communicate with this server.
      4. Click Next to continue to the next step, select the database location.

    • Join an existing farm

      1. On the Farm Configuration dialog, select the Join Existing Farm radio button to add this provisioning server to an existing farm, then click Next.
      2. Use the Browse button to browse for the appropriate SQL database and instance within the network.
      3. Select the farm name that displays by default, or scroll to select the farm to join. Note: More than one farm can exist on a single server. This configuration is common in test implementations.
      4. To enable database mirroring, enable the Specify database mirror failover partner option Type or use the Browse button to identify the failover database server and instance names. Optionally, enter a TCP port number to use to communicate with this server.
      5. Click Next.
      6. Select from the following site options, then click Next:
        • Existing Site: Select the site from the menu to join an existing site.
        • New Site: Create a site by typing the name of the new site and a collection.

      Continue on to configure the user account settings.

Identify the database

Only one database exists within a farm. To identify the database:

  1. If the database server location and instance have not yet been selected, complete the following procedure.

    1. On the Database Server dialog, click Browse to open the SQL Servers dialog.
    2. From the list of SQL Servers, select the name of the server where this database exists. Specify the instance to use (to use the default instance, SQLEXPRESS, leave the instance name blank). In a test environment, this configuration can be a staged database. Note: Rerunning the Configuration Wizard to add extra provisioning server database entries, populates the Server Name and Instance Name text boxes. By default, SQL Server Express installs as an instance named SQLEXPRESS.
    3. Click Next. If this database is a new farm, continue on to the Defining a Farm procedure.

  2. To change the database to a new database

    1. On the old database server, perform a backup of the database to a file.
    2. On the new database server, restore the database from the backup file.
    3. Run the Configuration Wizard on each Citrix Provisioning server.
    4. Select Join existing farm on the Farm Configuration dialog.
    5. Enter the new database server and instance on the Database Server dialog.
    6. Select the restored database on the Existing Farm dialog.
    7. Select the site that the provisioning server was previously a member of on the Site dialog.
    8. Click Next until the Configuration Wizard finishes.

  3. Define a farm. Select the security group to use:

    • Use Active Directory groups for security Note: When selecting the Active Directory group to act as the farm administrator from the menu, choices include any group the current user belongs to. This list includes Built in groups, which are local to the current machine. Avoid using these groups as administrators, except for test environments. Some group names might be misleading and appear to be domain groups, but are local domain groups. For example, ForestA.local/Builtin/Administrators.
    • Use Windows groups for security

  4. Click Next.

    Continue on to select the license server.

Create a store for a new farm

A new store can be created and assigned to the Citrix Provisioning server being configured:

Note: The Configuration Wizard only allows a server to create or join an existing store if it is new to the database. If a server exists in the database and it rejoins a farm, the Configuration Wizard might prompt the user to join a store or create a store. During this process, the selection is ignored.

  1. On the New Store page, name the new Store.
  2. Browse or enter the default path (for example: C:\PVSStore) to use to access this store, then click Next. If an invalid path is selected, an error message appears. Reenter a valid path, then continue. The default write cache location for the store is located under the store path for example: C:\PVSStore\WriteCache.

Identify the site

When joining an existing farm, identify the site where this provisioning server is a member. Identify a site by either creating a site or selecting an existing site within the farm. When a site is created, a default target device collection is automatically created for that site.

Select the license server

  1. Enter the name (or IP address) and port number of the license server (default is 27000). The provisioning server must be able to communicate with the license server to get the appropriate product licenses.
  2. Optionally, select the check box Validate license server version and communication. This option verifies that the license server can communicate with this server and that the appropriate version of the license server is used. If the server is not able to communicate with the license server, or the wrong version of the license server is being used, an error message appears. You cannot proceed.
  3. Click Next to continue on to configure user account settings.

Configure user account settings

The Stream and Soap services run under a user account. Configure data reader and data writer database roles automatically using the Configuration Wizard to provide database access privileges to a user account.

  1. On the User Account dialog, select the user account that the Stream and Soap services run under:
    • Network service account (minimum privilege local account that authenticates on the network as computers domain machine account).
    • Specified user account (required when using a Windows Share; workgroup or domain user account). Type the user name, domain, and password information in the appropriate text boxes.
  2. Click Next, then continue on to selecting network cards for the Stream Service.

Group managed service accounts

Citrix Provisioning supports Group Managed Service Accounts (gMSA). These accounts are managed domain accounts providing automatic password management and simplified SPN management over multiple servers.

Group managed service accounts

Deploy certificates

You must select a certificate for all the servers in the farm if you want to:

  • Join your farm to a Citrix Virtual Apps and Desktops site
  • Use the Imaging Wizard for Linux targets
  • Provision targets using the Citrix Provisioning API

Use the Citrix Provisioning Configuration Wizard to add the proper certificate from the local Computer personal certificates (My) store.

Note:

We recommend to use a CA-signed certificate but you can use a self-signed certificate if necessary.

For deploying a certificate:

  1. Import the certificate into My store on the Citrix Provisioning server.
  2. Install the root of trust of the certificate in the trusted root store of the client machines where connections are made (PVSAPI, Linux machine that is imaged and Citrix Virtual Apps and Desktops Delivery Controller).

Note:

The set of operations depends on whether you use a CA-signed certificate or self-signed certificate.

  1. Run the Configuration Wizard. On the SSL Configuration page, select the certificate to use.

Use a CA-signed certificate

The CA-signed certificate must include both public and private key and the private key must be exportable.

  1. Import the certificate into My store on the Citrix Provisioning server.

    Import-Certificate -FilePath <crt file> -CertStoreLocation Cert:\LocalMachine\My
<!--NeedCopy-->

  2. If the certificate authority root certificate is not in the trusted root store (Cert:\LocalMachine\Root) on every client machine, then add it on all client machines. However, this step is usually not required when using a public CA-signed certificate.

Use a self-signed certificate

  1. Create a self-signed certificate.

    $cert = New-SelfSignedCertificate -DnsName $PVS_SERVER_FQDN -CertStoreLocation cert:\LocalMachine\My
$cert_thumbprint = $cert.Thumbprint
<!--NeedCopy-->

    Note:

    When you create a certificate, you can specify multiple -DnsName, separated by a comma. This adds Subject Alternative Names to the certificate, one for each DnsName. When using the PVS API, you can connect using any of these names. Example: You can use -DnsName “servername.domain”, “servername”. Then, using PVS API connect with -PvsServerAddress “servername.domain” or -PvsServerAddress “servername”.

  2. Export the certificate to the .cer file without its private key.

    Export-Certificate -Cert $cert -FilePath $CERT_FILE
<!--NeedCopy-->

  3. On each client machine, import the exported self-signed into the Cert:\LocalMachine\Root trusted root store on the client.

    $file = ( Get-ChildItem -Path $CERT_FILE )
$file | Import-Certificate -CertStoreLocation Cert:\LocalMachine\Root
<!--NeedCopy-->

Use Configuration Wizard to deploy certificate

Use the Citrix Provisioning Configuration Wizard to add the proper certificate from the local Computer personal certificates (My) store.

The SSL Configuration page displays the certificate that is imported into My store on the Citrix Provisioning Server.

Soap SSL configuration

Tip:

When the Soap SSL Configuration page first loads, the certificate is highlighted which gives the appearance that it is selected. Ensure that the certificate is selected, it appears as a blue item in the table.

Select network cards for the stream service

  1. Select the check box next to each of the network cards that the Stream Service can use.
  2. Enter the base port number that is used for network communications in the First communications port: text box.

    Note:

    A minimum of 20 ports are required within the range. All provisioning servers within a farm must use the same port assignments.

  3. Select the Soap Server port (default is 54321) to use for Console access, then click Next.

Continue on to select the bootstrap server.

Configure the bootstrap server

  1. Select the bootstrap server. To use the TFTP service on this provisioning server:

    1. Select the Use the TFTP Service option, then enter or browse for the boot file. The default location is: C:\Documents and Settings\All Users\ProgramData\Citrix\Provisioning Services\Tftpboot

      If a previous version of Citrix Provisioning was installed on this server, and the default location is:

      C:\Program Files\Citrix\Provisioning Services\TftpBoot

      run the Configuration Wizard to change the default location to:

      C:\Documents and Settings\All Users\ProgramData or ApplicationData\Citrix\Provisioning Services\Tftpboot

      If the default is not changed, the bootstrap file cannot be configured from the Citrix Provisioning console and target devices fail to boot. The message ‘Missing TFTP’ appears.

    2. Click Next.

  2. Select Provisioning Servers to use for the boot process:

    1. Use the Add button to add more provisioning servers to the list. The Edit button to edit existing information, or to remove the server from the list. Use the Move up or Move down buttons to change the server boot preference order. The maximum length for the server name is 15 characters. Do not enter the FQDN for the server name. In a high availability implementation, at least two provisioning servers must be selected as boot servers.

    2. Optionally, highlight the IP address of the provisioning server that target devices boot from, then click Advanced. The Advanced Stream Servers Boot List appears.

      The following list describes advanced settings that you can choose from. After making your selections, click OK to exit the dialog, then click Next to continue.

    • Verbose mode: Select the Verbose Mode option if you want to monitor the boot process on the target device (optional) or view system messages.
    • Interrupt safe mode: Select Interrupt Safe Mode if you are having trouble with your target device failing early in the boot process. This option enables debugging of target device drivers that exhibit timing or boot behavior problems.
    • Advanced memory support: This setting enables the bootstrap to support newer Windows OS versions and is enabled by default. Disable this setting on Windows Server OS 32 bit versions that do not support PXE. Or if your target device is hanging or behaving erratically in early boot phase.
    • Network recovery method:
      • Restore Network Connections: Selecting this option results in the target device attempting indefinitely to restore its connection to the provisioning server.

        Note:

        Because the Seconds field does not apply, it becomes inactive when selecting the Restore Network Connections option.

      • Reboot to Hard Drive: (A hard drive must exist on the target device). Selecting this option instructs the target device to perform a hardware reset to force a reboot after failing to re-establish communications for a defined number of seconds. The user determines the number of seconds to wait before rebooting. Assuming the network connection cannot be established, PXE fails, and the system reboots to the local hard drive. The default number of seconds is 50, to be compatible with high availability configurations.
    • Logon polling timeout: Enter the time in milliseconds between retries when polling for provisioning servers. Each server is sent a login request packet in sequence. The first responding server is used. In non-HA configurations, this time-out simply defines how often to retry the single available server with the initial login request. This time-out defines how quickly the round-robin routine switches from one server to the next in trying to find an active server. The valid range is from 1,000 milliseconds to 60,000 milliseconds.
    • Log in general timeout: Enter the time-out in milliseconds for all login associated packets, except the initial login polling time-out. The time-out is longer than the polling time-out because the server needs time to contact all associated servers, some of which are unreachable. Unreachable servers require retries and time-outs from the provisioning server to the other provisioning servers to determine if they online. The valid range is from 1,000 milliseconds to 60,000 milliseconds.
  3. Verify that all configuration settings are correct, then click Finish.

Bootstrap configurations can be reconfigured by selecting the Configure Bootstrap option from the Provisioning Services Action menu in the console.

Farm
June 21, 2024
Contributed by: 
C
June 21, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.