Set-FasServer
Synopsis
Set information on a Federated Authentication Service (FAS) server.
Syntax
Set-FasServer [-MaintenanceMode <Boolean>] [-KspRemoting <Boolean>]
[-AllowMaintenanceModeAutoCertCreation <Boolean>] [-Address <String>] [-UserName <String>]
[-Password <String>] [<CommonParameters>]
<!--NeedCopy-->
Description
This cmdlet can modify information about a Federated Authentication Service (FAS) server.
In particular, it can enable or disable maintenance mode. When maintenance mode is enabled, FAS indicates to StoreFront or Workspace that the server is unavailable for use, so a different FAS server should be selected.
Additionally this cmdlet can be used to:
-
Enable or disable KSP remoting (enabled by default). When enabled, a Windows VDA which supports it will use a KSP (Key Storage Provider) module for remoting crypto operations back to the FAS server. If disabled, or if not supported by the VDA, a CSP (Cryptographic Service Provider) is used instead. KSP is newer than CSP and supports more cryptographic options, such as Elliptic Curve Cryptography.
-
Allow or disallow automatic user certificate creation when the server is in maintenance mode (disallowed by default). When disallowed, any request from StoreFront or Workspace requiring a new user certificate to be created (because there is no cached certificate) is failed, thus ensuring no new user certificates are created while the server is in maintenance mode. Note however, FAS administrators can still create new user certificates using powershell such as New-FasUserCertificate.
Examples
Example 1
PS C:\>
C:\PS> $CitrixFasAddress = (Get-FasServer)[0].Address
C:\PS> Set-FasServer -MaintenanceMode $FALSE
<!--NeedCopy-->
Description
This code brings the FAS server out of maintenance mode.
Example 2
PS C:\>
C:\PS> Set-FasServer -Address localhost -KspRemoting $false
<!--NeedCopy-->
Description
This code disables KSP remoting on the FAS server.
Parameters
-MaintenanceMode
Set the MaintenanceMode flag
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $NULL
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
<!--NeedCopy-->
-KspRemoting
Set the KSP remoting flag
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $NULL
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
<!--NeedCopy-->
-AllowMaintenanceModeAutoCertCreation
Set whether automatic user certificate creation is permitted when the server is in maintenance mode
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $NULL
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
<!--NeedCopy-->
-Address
Address of FAS Server (or $NULL to use $CitrixFasAddress)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $CitrixFasAddress
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
<!--NeedCopy-->
-UserName
User name to use for authentication to FAS server ($NULL for current user account)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $NULL
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
<!--NeedCopy-->
-Password
Password for authentication to FAS server ($NULL for current user account)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $NULL
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
<!--NeedCopy-->
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Variable, based on property name.
This cmdlet does accept input from the pipeline but only by property name.
Outputs
void
This cmdlet does not return a value