Test-AdfsFarmJoin

Test-AdfsFarmJoin is accessible with the help of adfs module. To install adfs on your system please refer to this adfs.

Synopsis

Runs prerequisite checks for adding the server computer to a federation server farm.

Description

The Test-AdfsFarmJoin cmdlet performs the checks that you must complete before you run the Add-AdfsFarmNode cmdlet to add the local server computer to an existing federation server farm.

Parameters

-CertificateThumbprint
Specifies the value of the certificate 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.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Credential <PSCredential>
    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.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-FarmBehavior <Int32>
    Specifies farm behavior.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-GroupServiceAccountIdentifier <String>
    Specifies the name of the group Managed Service Account that the Active Directory Federation Services (AD FS) service uses as the logon identity for the AD FS service.

    Required?                    true
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-PrimaryComputerName <String>
    Specifies the name of the primary adfs2_fs in a adfs2_fs farm. The cmdlet checks the adfs2_fs farm that has the primary adfs2_fs that you specify.

    Required?                    true
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-PrimaryComputerPort <Int32>
    Specifies the primary computer port. The computer uses the HTTP port that you specify to connect with the primary computer in order to synchronize configuration settings. Specify a value of 80 for this parameter, or specify an alternative value if the HTTP port on the primary computer is not 80. If you do not specify this parameter, the cmdlet assigns the default port value of 443.

    Required?                    false
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-ServiceAccountCredential <PSCredential>
    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.

    Required?                    true
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

-SQLConnectionString <String>
    Specifies the Microsoft SQL Server database that will store the AD FS configuration settings. If you do not specify this parameter, AD FS uses the Windows Internal Database to store configuration settings.

    Required?                    true
    Position?                    named
    Default value                none
    Accept pipeline input?       false
    Accept wildcard characters?  false

Syntax

Test-AdfsFarmJoin [-CertificateThumbprint <String>] -GroupServiceAccountIdentifier <String> [-Credential <PSCredential>] -PrimaryComputerName <String> [-PrimaryComputerPort <Int32>] [<CommonParameters>]

Test-AdfsFarmJoin [-CertificateThumbprint <String>] -ServiceAccountCredential <PSCredential> [-Credential <PSCredential>] -PrimaryComputerName <String> [-PrimaryComputerPort <Int32>] [<CommonParameters>]

Test-AdfsFarmJoin [-CertificateThumbprint <String>] -ServiceAccountCredential <PSCredential> [-Credential <PSCredential>] -SQLConnectionString <String> [-FarmBehavior <Int32>] [<CommonParameters>]

Test-AdfsFarmJoin [-CertificateThumbprint <String>] -GroupServiceAccountIdentifier <String> [-Credential <PSCredential>] -SQLConnectionString <String> [-FarmBehavior <Int32>] [<CommonParameters>]

—————–Example 1—————–
Test a server computer as a node in an existing federation server farm
PS C:> $FScred = Get-Credential
PS C:> Test-AdfsFarmJoin -ServiceAccountCredential $FScred -SQLConnectionString “Data Source=SQLHost;Integrated Security=True”
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 $FScred variable.
The second command tests the joining of the local server computer as a node in an existing federation server farm that uses a SQL Server database that is installed on a computer named SQLHost. The command specifies the credentials that are stored in the $FScred variable for the Active Directory account under which the AD FS service runs.

—————–Example 2—————–
Test the overwrites of an existing AD FS configuration database
PS C:> $FScred = Get-Credential
PS C:> Test-AdfsFarmJoin -OverwriteConfiguration -PrimaryComputerName “PrimaryWIDHost” -PrimaryComputerPort 80 -ServiceAccountCredential $FScred -CertificateThumbprint 9edf2me23ec6e77eb2ae17f028fe5be3a87bc2db
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 $FScred variable.
The second command tests the overwrites of an existing AD FS configuration database and tests the joining of the local server computer as a node in an existing federation server farm that uses the Windows Internal Database. The primary node of the farm is installed on a computer named PrimaryWIDHost. The command specifies the credentials that are stored in $FScred for the Active Directory account under which the AD FS service runs.
The CertificateThumbprint parameter must specify the thumbprint of a certificate that is currently installed in the certificate store of the local computer. The certificate must be the same certificate that is used as the service communications certificate on the primary node.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Test-AdfsFarmJoin

You can also read about

To know more PowerShell cmdlets(Commands) on Active Directory Federation Services(ADFS) click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft