Test-FasKeyConfig

Synopsis

Tests the key configuration for the given certificate type

Syntax

Test-FasKeyConfig -CertificateType <String> [-Address <String>] [-UserName <String>] [-Password <String>]
 [<CommonParameters>]
<!--NeedCopy-->

Description

This command tests the key configuration for the given certificate type.

Use this command to verify that the key configuration is working.

This command attempts to create a key-pair using the FAS server’s key configuration settings. Any created key-pair is subsequently destroyed.

The command output indicates if key-pair creation succeeded, or gives an indication of why it failed.

Examples

Example 1

PS C:\>  Test-FasKeyConfig -Address localhost -CertificateType user
<!--NeedCopy-->

Tests the user certificate key configuration

Parameters

-CertificateType

The certificate type to test the key configuration for.

Valid options are ‘ra’ or ‘user’.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
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: None
Accept pipeline input: False
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: None
Accept pipeline input: False
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: None
Accept pipeline input: False
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

None

Outputs

Citrix.Authentication.FederatedAuthenticationService.PowerShell.FasDiagnosticTestResult

Notes

Get-FasKeyConfig

Set-FasKeyConfig

Reset-FasKeyConfig

Test-FasKeyConfig