Download full document:


Modify a Rule's configuration (a named instance of the Federated Authentication Service running on a server).


Set-FasRule -Name <String> [-CertificateDefinitions <String[]>] [-StoreFrontAcl <String>] [-UserAcl <String>] [-VdaAcl <String>] [-DelegatedAdministrationAcl [<Boolean>]] [-Address <String>] [-UserName <String>] [-Password <String>] [<CommonParameters>]

Detailed Description

Set the configuration of an existing named rule controlling which trusted StoreFront servers can assert logon identities. The caller must be a member of the Rule's administration groups. Normally to log in to a Windows computer the Active Directory Domain Controllers require that "primary credentials" be present—that is a password, or a smartcard, etc. An instance of a Federated Authentication Service allows trusted servers to "assert" user identities without knowledge of primary credentials. The configuration options are:

  • The name of the Rule or Service instance. Usually there will be at least one service named "default", but further, independent services can be run.
  • A reference to the certificate definitions used to issue Virtual Smart Card certificates when user identities are asserted. Note that only Certificate Definitions marked "InSession" can be used after the logon stage.
  • A reference to the Virtual Smart Card to use for log on. By default this is the first in the list of Certificate Definitions.
  • A list of Windows Accounts that are trusted to assert identities for this Rule. For security reasons, this must be chosen very carefully: usually it will be the explicit machine accounts of your StoreFront servers.
  • A list of Windows User Accounts that can be asserted. Usually this will be restricted to a security group. For example "ExternalCitrixUserGroup"
  • A list of VDA Windows Accounts that can act as relying parties to log users in. For example, "CitrixVdaMachines"
  • A list of administrators who have can modify (but not create or delete) the rule.


Name Description Required? Pipeline Input Default Value
Name Specify the name of the rule to update. The caller must be an administrator of the rule. true true (ByPropertyName) (default)
CertificateDefinitions Change the a list of CertificateDefinition names for Virtual Smart Cards to create. The first in the list will be used for the log on process. false true (ByPropertyName) \$NULL
StoreFrontAcl Change the SDDL Security Descriptor controlling which servers are trusted to assert user identities using this rule. E.g. "D:P(A;OICI;CC;;;XXXX)" replacing xxxx with a security identifier (SID) string. false true (ByPropertyName) \$NULL
UserAcl Change the SDDL Security Descriptor controlling which user identities can be asserted by this rule. E.g."D:P(A;OICI;LC;;;DU)" for "Domain Users". false true (ByPropertyName) \$NULL
VdaAcl Change the SDDL Security Descriptor controlling which VDAs can be logged into by this rule. E.g. "D:P(A;OICI;DC;;;DC)" for "Domain Computers". false true (ByPropertyName) \$NULL
DelegatedAdministrationAcl Change the SDDL Security Descriptor controlling which users can change the configuration of this rule. E.g. "D:P(A;OICI;SW;;;BA)" for "Built-in Administrators" on the FAS Server. false true (ByPropertyName) \$NULL
Address Address of FAS Server (or \$NULL to use \$CitrixFasAddress) false true (ByPropertyName) \$CitrixFasAddress
UserName User name to use for authentication to FAS server (\$NULL for current user account) false true (ByPropertyName) \$NULL
Password Password for authentication to FAS server (\$NULL for current user account) false true (ByPropertyName) \$NULL

Input Type

Variable, based on property name

This cmdlet does accept input from the pipeline but only by property name.

Return Values


This cmdlet does not return a value



C:\PS> $CitrixFasAddress=(Get-FasServer)[0].Address
C:\PS> $CertificateDefinition=(Get-FasCertificateDefinition)[0].name
C:\PS> Set-FasRule -Name "default" -CertificateDefinitions @($CertificateDefinition)

This code changes the CertificateDefinitions used by the rule named "default".