Product Documentation

Configure server bypass behavior

Mar 09, 2016

To improve performance when some of the servers providing resources become unavailable, StoreFront temporarily bypasses servers that fail to respond. While a server is being bypassed, StoreFront ignores that server and does not use it to access resources. Use these parameters to specify the duration of the bypass behavior:

  • bypassDuration specifies the time in minutes that StoreFront bypasses an individual server after a failed attempt to contact that server. The default is 60 minutes.
  • allFailedBypassDuration specifies a reduced duration in minutes that StoreFront uses instead of bypassDuration if all servers for a particular Delivery Controller are being bypassed. The default is 0 minutes.

Considerations when specifying allFailedBypassDuration

Setting a larger allFailedBypassDuration reduces the impact of unavailability of a particular Delivery Controller; however, it has the negative effect that resources from this Delivery Controller are unavailable to users for the specified duration after a temporary network outage or server unavailability. Consider the use of larger allFailedBypassDuration values when many Delivery Controllers have been configured for a Store, particularly for nonbusiness-critical Delivery Controllers.

Setting a smaller allFailedBypassDuration increases the availability of resources served by that Delivery Controller but increases the possibility of client-side timeouts if many Delivery Controllers are configured for a store and several of them become unavailable. It is worth keeping the default 0-minute value when not many farms are configured and for business-critical Delivery Controllers.

To change the bypass parameters for a Store

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 the other servers in the deployment are updated.
  1. 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.
  2. Locate the following element in the file for the Delivery Controller you want to configure:

    <farm name=”deliverycontrollername” ... allFailedBypassDuration=”0” ... > 

  3. Change the value of the allFailedBypassDuration attribute to the maximum number of minutes that StoreFront should allow all servers from the specified Delivery Controller to be bypassed.
  4. If desired, add (or update if the attribute is already present) the bypassDuration attribute to specify the number of minutes an individual server should be bypassed when StoreFront fails to contact that server.