Test-AdfsFarmInstallation

Module:

ADFS

Runs prerequisite checks for installing a new federation server farm.

Syntax

Test-AdfsFarmInstallation
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    -FederationServiceName <String>
    [-FederationServiceDisplayName <String>]
    -ServiceAccountCredential <PSCredential>
    [-OverwriteConfiguration]
    [-SSLPort <Int32>]
    [-TlsClientPort <Int32>]
    [-AdminConfiguration <Hashtable>]
    [<CommonParameters>]

Test-AdfsFarmInstallation
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    -DecryptionCertificateThumbprint <String>
    -FederationServiceName <String>
    [-FederationServiceDisplayName <String>]
    -ServiceAccountCredential <PSCredential>
    -SigningCertificateThumbprint <String>
    [-OverwriteConfiguration]
    [-SSLPort <Int32>]
    [-TlsClientPort <Int32>]
    [-AdminConfiguration <Hashtable>]
    [<CommonParameters>]

Test-AdfsFarmInstallation
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    -DecryptionCertificateThumbprint <String>
    -FederationServiceName <String>
    [-FederationServiceDisplayName <String>]
    -ServiceAccountCredential <PSCredential>
    -SigningCertificateThumbprint <String>
    -SQLConnectionString <String>
    [-OverwriteConfiguration]
    [-SSLPort <Int32>]
    [-TlsClientPort <Int32>]
    [-AdminConfiguration <Hashtable>]
    [<CommonParameters>]

Test-AdfsFarmInstallation
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    -DecryptionCertificateThumbprint <String>
    -FederationServiceName <String>
    [-FederationServiceDisplayName <String>]
    -GroupServiceAccountIdentifier <String>
    -SigningCertificateThumbprint <String>
    [-OverwriteConfiguration]
    [-SSLPort <Int32>]
    [-TlsClientPort <Int32>]
    [-AdminConfiguration <Hashtable>]
    [<CommonParameters>]

Test-AdfsFarmInstallation
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    -DecryptionCertificateThumbprint <String>
    -FederationServiceName <String>
    [-FederationServiceDisplayName <String>]
    -GroupServiceAccountIdentifier <String>
    -SigningCertificateThumbprint <String>
    -SQLConnectionString <String>
    [-OverwriteConfiguration]
    [-SSLPort <Int32>]
    [-TlsClientPort <Int32>]
    [-AdminConfiguration <Hashtable>]
    [<CommonParameters>]

Test-AdfsFarmInstallation
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    -FederationServiceName <String>
    [-FederationServiceDisplayName <String>]
    -ServiceAccountCredential <PSCredential>
    -SQLConnectionString <String>
    [-OverwriteConfiguration]
    [-SSLPort <Int32>]
    [-TlsClientPort <Int32>]
    [-AdminConfiguration <Hashtable>]
    [<CommonParameters>]

Test-AdfsFarmInstallation
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    -FederationServiceName <String>
    [-FederationServiceDisplayName <String>]
    -GroupServiceAccountIdentifier <String>
    [-OverwriteConfiguration]
    [-SSLPort <Int32>]
    [-TlsClientPort <Int32>]
    [-AdminConfiguration <Hashtable>]
    [<CommonParameters>]

Test-AdfsFarmInstallation
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    -FederationServiceName <String>
    [-FederationServiceDisplayName <String>]
    -GroupServiceAccountIdentifier <String>
    -SQLConnectionString <String>
    [-OverwriteConfiguration]
    [-SSLPort <Int32>]
    [-TlsClientPort <Int32>]
    [-AdminConfiguration <Hashtable>]
    [<CommonParameters>]

Description

The Test-AdfsFarmInstallation cmdlet performs the checks that you must complete before you run the Install-AdfsFarm cmdlet to install a new federation server farm.

Examples

Example 1: Test the creation of a node in a federation server farm

PS C:\> $Cred = Get-Credential
PS C:\> Test-AdfsFarmInstallation -CertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -FederationServiceName "FS.Corp.Contoso.com" -ServiceAccountCredential $Cred

The first command uses the Get-Credential cmdlet to create a credential object for the Active Directory account under which the AD FS service runs. The command stores the credential object in the $Cred variable.

The second command tests the creation the first node in a federation server farm that uses the Windows Internal Database on the local server computer. The command specifies a thumbprint of the certificate. AD FS uses this certificate as the SSL certificate and the service communications certificate. The command uses automatically generated, self-signed certificates for the token signing and token decryption certificates. The command specifies the credentials stored in $Cred for the Active Directory account under which the AD FS service runs.

Parameters

-AdminConfiguration

Specifies admin configuration.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CertificateThumbprint

Specifies the value of the thumbprint of the certificate that the Secure Sockets Layer (SSL) binding of the default website uses in Internet Information Services (IIS). This value must match the thumbprint of a valid certificate in the certificate store of the local computer.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Specifies a PSCredential object based on a user name and password. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Type:	PSCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DecryptionCertificateThumbprint

Specifies the value of the thumbprint of the certificate that Active Directory Federation Services (AD FS) uses for token decryption. If you specify this parameter, AD FS disables automatic certificate rollover, and you must specify a token signing certificate by specifying the SigningCertificateThumbprint parameter. This value must match the thumbprint of a valid certificate in the certificate store of the local computer.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-FederationServiceDisplayName

Specifies the display name of the Federation Service. The name of the Federation Service appears by default in sign-in pages.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FederationServiceName

Specifies the Domain Name System (DNS) name of the Federation Service. This value must match the subject name of the certificate that you configure on the SSL binding in IIS.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-GroupServiceAccountIdentifier

Specifies the name of the group Managed Service Account that the AD FS service uses as the logon identity for the AD FS Windows service.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-OverwriteConfiguration

Indicates that the AD FS service removes an existing AD FS configuration database and overwrites it with a new database.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServiceAccountCredential

Specifies a PSCredential object based on a user name and password for the service account in Active Directory® Domain Services under which the AD FS service runs. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Type:	PSCredential
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SigningCertificateThumbprint

Specifies the value of the thumbprint of the certificate that the AD FS service uses for token signing. If you specify this parameter, AD FS disables automatic certificate rollover, and you must also specify a token decryption certificate by using the DecryptionCertificateThumbprint parameter. This value must match the thumbprint of a valid certificate in the certificate store of the local computer.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SQLConnectionString

Specifies the Microsoft SQL Server database that stores the AD FS configuration settings. If you do not specify this parameter, the AD FS installer uses the Windows Internal Database to store configuration settings.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SSLPort

Specifies the value of the port number of the SSL binding that the AD FS website uses.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TlsClientPort

Specifies the port number that the AD FS service uses for Transport Layer Security (TLS) authentication for the user certificate client. The default value is 49443.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

Object

Related Links

• Get-Credential
• Install-AdfsFarm
• Test-AdfsFarmJoin