Product Documentation

Configure load balancing, failover, disaster recovery, and user mapping for a store

Oct 08, 2015

To set up load balancing, failover, disaster recovery, and user mapping, you edit the store configuration files. After configuring load balancing, failover, disaster recovery, and user mapping for a store, some tasks become unavailable in the Citrix StoreFront management console to prevent misconfiguration.

Important: In multiple server deployments, use only one server at a time to make changes to the configuration of the server group. Ensure that the Citrix StoreFront management console is not running on any of the other servers in the deployment. Once complete, propagate your configuration changes to the server group so that the other servers in the deployment are updated.
  1. Ensure that you have configured the store with details of all the XenDesktop, XenApp, and VDI-in-a-Box deployments that you want to use in your configuration, including disaster recovery deployments. For more information about adding deployments to stores, see Manage the resources made available in stores.
  2. Use a text editor to open the web.config file for the store, which is typically located in the C:\inetpub\wwwroot\Citrix\storename\ directory, where storename is the name specified for the store when it was created.
  3. Locate the following section in the file.
    <resourcesWingConfigurations> 
      <resourcesWingConfiguration name="Default" wingName="Default" /> 
    </resourcesWingConfigurations>
    
  4. Specify your configuration as shown below.
    <resourcesWingConfigurations> 
      <resourcesWingConfiguration name="Default" wingName="Default"> 
        <userFarmMappings> 
          <clear /> 
          <userFarmMapping name="user_mapping"> 
            <groups> 
              <group name="domain\usergroup" sid="securityidentifier" /> 
              <group ... /> 
              ... 
            </groups> 
            <equivalentFarmSets> 
              <equivalentFarmSet name="setname" loadBalanceMode="{LoadBalanced | Failover}"  
               aggregationGroup="aggregationgroupname"> 
                <primaryFarmRefs> 
                  <farm name="primaryfarmname" /> 
                  <farm ... /> 
                  ... 
                </primaryFarmRefs> 
                <backupFarmRefs> 
                  <farm name="backupfarmname" /> 
                  <farm ... /> 
                  ... 
                </backupFarmRefs> 
              </equivalentFarmSet> 
              <equivalentFarmSet ... > 
                ... 
              </equivalentFarmSet> 
            </equivalentFarmSets> 
          </userFarmMapping> 
          <userFarmMapping> 
            ... 
          </userFarmMapping> 
        </userFarmMappings> 
      </resourcesWingConfiguration> 
    </resourcesWingConfigurations>
    

    Use the following elements to define your configuration.

    userFarmMapping
    Specifies groups of deployments and defines the load balancing and failover behavior between those deployments. Identifies deployments to be used for disaster recovery. Controls user access to resources by mapping Microsoft Active Directory user groups to the specified groups of deployments.
    groups
    Specifies the names and security identifiers (SIDs) of Active Directory user groups to which the associated mapping applies. User group names must be entered in the format domain\usergroup. Where more than one group is listed, the mapping is only applied to users who are members of all the specified groups. To enable access for all Active Directory user accounts, set the group name & sid to Everyone.
    equivalentFarmSet
    Specifies a group of equivalent deployments providing resources to be aggregated for load balancing or failover, plus an associated group of disaster recovery deployments. The loadBalanceMode attribute determines the allocation of users to deployments. Set the value of the loadBalanceMode attribute to LoadBalanced to randomly assign users to deployments in the equivalent deployment set, evenly distributing users across all the available deployments. When the value of the loadBalanceMode attribute is set to Failover, users are connected to the first available deployment in the order in which they are listed in the configuration, minimizing the number of deployments in use at any given time. Specify names for aggregation groups to identify equivalent deployment sets providing resources to be aggregated. Resources provided by equivalent deployment sets belonging to the same aggregation group are aggregated. While deployments within an equivalent deployment set must be identical, deployments aggregated from different sets do not need to provide exactly the same resources. To specify that the deployments defined in a particular equivalent deployment set should not be aggregated with others, set the aggregation group name to None.
    primaryFarmRefs
    Specifies a set of equivalent XenDesktop, XenApp, or VDI-in-a-Box deployments providing identical resources. Enter the names of deployments that you have already added to the store. The names of the deployments you specify must match exactly the names you entered when you added the deployments to the store.
    optimalGatewayForFarms
    Specifies groups of deployments and defines the optimal NetScaler Gateway appliances for users to access resources provided by these deployments. Typically, the optimal appliance for a deployment is collocated in the same geographical location as that deployment. You only need to define optimal NetScaler Gateway appliances for deployments where the appliance through which users access StoreFront is not the optimal appliance.