Citrix StoreFront SDK PowerShell Modules

Set-STFFASResilienceConfiguration

June 20, 2025

Contributed by:

Set Federated Authentication Service resilience configuration

Syntax

Set-STFFASResilienceConfiguration [-StoreService] <StoreService> [-Enabled] <Boolean> [[-NumberOfExceptionsBeforeBreak] <Int32>] [[-DurationOfBreakInMinutes] <Int32>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Sets the Federated Authentication Service resilience configuration used to communicate with FAS service.

If failed to communicate with any FAS server Store will fallback to next available FAS server.’.

The configuration will be applied to Store and Authentication services of the Store.

Get-STFFASResilienceConfiguration

Parameters

Name	Description	Required?	Pipeline Input
StoreService	Store service	true	true (ByValue)
Enabled	Specifies whether to enable the resilience configuration.	true	false
NumberOfExceptionsBeforeBreak	Specifies number of attempts Store will give before break circuit open.	false	false
DurationOfBreakInMinutes	Specifies number of minutes store will take during break to retry or fallback.	false	false

Input Type

Citrix.StoreFront.Model.Store.StoreService

Parameter StoreService: A .NET class representing the configuration of a StoreFront Store service

System.Boolean

Parameter Enabled: The .NET System.Boolean value type

System.Int32

Parameter NumberOfExceptionsBeforeBreak: The .NET System.Int32 value type

System.Int32

Parameter DurationOfBreakInMinutes: The .NET System.Int32 value type

Return Values

None

Examples

EXAMPLE 1 Set Federated Authentication Service resilience configuration

$storeService = Get-STFStoreService /Citrix/Store
         Set-STFFasResilienceConfiguration -StoreService $storeService -Enabled $true -NumberOfExceptionsBeforeBreak 3 -DurationOfBreakInMinutes 5
<!--NeedCopy-->

REMARKS

Enables resilience.configuration for specific store to communicate with FAS

The configuration will be applied to provided Store’s Authentication and Store Services.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-STFFASResilienceConfiguration

June 20, 2025

Contributed by:

June 20, 2025

Contributed by:

Set-STFFASResilienceConfiguration

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.StoreFront.Model.Store.StoreService

System.Boolean

System.Int32

System.Int32

Return Values

None

Examples

EXAMPLE 1 Set Federated Authentication Service resilience configuration

In this article