Export (0) Print
Expand All
Expand Minimize

Install-AdfsFarm

Windows Server 2012 R2 and Windows 8.1

Updated: April 8, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Install-AdfsFarm

Creates the first node of a new federation server farm.

Syntax

Parameter Set: ADFSFarmCreateLocalDatabase
Install-AdfsFarm -ServiceAccountCredential <PSCredential> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [-OverwriteConfiguration] [-SSLPort <Int32> ] [-TlsClientPort <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: __AllParameterSets
Install-AdfsFarm -FederationServiceName <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [-FederationServiceDisplayName <String> ] [-OverwriteConfiguration] [-SSLPort <Int32> ] [-TlsClientPort <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ADFSFarmCreateLocalDatabaseDisableAutoCertRollover
Install-AdfsFarm -DecryptionCertificateThumbprint <String> -ServiceAccountCredential <PSCredential> -SigningCertificateThumbprint <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [-OverwriteConfiguration] [-SSLPort <Int32> ] [-TlsClientPort <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: AdfsFarmCreateLocalDatabaseDisableAutoCertRolloverGmsa
Install-AdfsFarm -DecryptionCertificateThumbprint <String> -GroupServiceAccountIdentifier <String> -SigningCertificateThumbprint <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [-OverwriteConfiguration] [-SSLPort <Int32> ] [-TlsClientPort <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: AdfsFarmCreateLocalDatabaseGmsa
Install-AdfsFarm -GroupServiceAccountIdentifier <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [-OverwriteConfiguration] [-SSLPort <Int32> ] [-TlsClientPort <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ADFSFarmCreateSharedDatabase
Install-AdfsFarm -ServiceAccountCredential <PSCredential> -SQLConnectionString <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [-OverwriteConfiguration] [-SSLPort <Int32> ] [-TlsClientPort <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ADFSFarmCreateSharedDatabaseDisableAutoCertRollover
Install-AdfsFarm -DecryptionCertificateThumbprint <String> -ServiceAccountCredential <PSCredential> -SigningCertificateThumbprint <String> -SQLConnectionString <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [-OverwriteConfiguration] [-SSLPort <Int32> ] [-TlsClientPort <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: AdfsFarmCreateSharedDatabaseDisableAutoCertRolloverGmsa
Install-AdfsFarm -DecryptionCertificateThumbprint <String> -GroupServiceAccountIdentifier <String> -SigningCertificateThumbprint <String> -SQLConnectionString <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [-OverwriteConfiguration] [-SSLPort <Int32> ] [-TlsClientPort <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: AdfsFarmCreateSharedDatabaseGmsa
Install-AdfsFarm -GroupServiceAccountIdentifier <String> -SQLConnectionString <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [-OverwriteConfiguration] [-SSLPort <Int32> ] [-TlsClientPort <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Install-AdfsFarm cmdlet creates the first node of a new federation server farm.

Parameters

-CertificateThumbprint<String>

Specifies the value of the certificate thumbprint of the certificate that should be used in the Secure Sockets Layer (SSL) binding of the Default Web Site in Internet Information Services (IIS). This value should match the thumbprint of a valid certificate in the Local Computer certificate store.


Aliases

none

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. To use this cmdlet, you must supply credentials that have domain administrator privileges.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DecryptionCertificateThumbprint<String>

Specifies the value of the certificate thumbprint of the certificate that should be used for token decryption. If this parameter is used, the automatic certificate rollover feature will be disabled, and a token signing certificate must also be specified using the SigningCertificateThumbprint parameter. This value should match the thumbprint of a valid certificate in the Local Computer certificate store.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FederationServiceDisplayName<String>

Specifies the display name of the Federation Service. The name that you specify is the organization for which this Federation Service issues tokens. For instance, you might specify Contoso Corporation. If you do not specify a value for this parameter, the Federation Service uses the value specified by the FederationServiceName parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FederationServiceName<String>

Specifies the DNS name of the federation service. This value must match the subject name of the certificate configured on the SSL binding in IIS.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-GroupServiceAccountIdentifier<String>

Specifies the Active Directory® Domain Services Group Managed Service Account under which the Active Directory Federation Services (AD FS) service runs.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OverwriteConfiguration

This parameter must be used to remove an existing Active Directory Federation Services (AD FS) configuration database and overwrite it with a new database.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServiceAccountCredential<PSCredential>

Specifies the Active Directory account under which the AD FS service runs.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SigningCertificateThumbprint<String>

Specifies the value of the certificate thumbprint of the certificate that should be used for token signing. If this parameter is used, the automatic certificate rollover feature will be disabled, and a token decryption certificate must also be specified using the DecryptionCertificateThumbprint parameter. This value should match the thumbprint of a valid certificate in the Local Computer certificate store.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SQLConnectionString<String>

Specifies the SQL Server database that will store the AD FS configuration settings. If not specified, the AD FS installer uses the Windows Internal Database to store configuration settings.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SSLPort<Int32>

Specifies the value of the port number of the SSL binding that the AD FS web site will use.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TlsClientPort<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1

Description

Creates the first node in a federation server farm that uses the Windows Internal Database (WID) on the local server computer.

In this example, a certificate thumbprint value is supplied for the CertificateThumbprint parameter. This certificate will be used as the SSL certificate and the service communications certificate. Automatically generated, self-signed certificates will be used for the token signing and token decryption certificates.

To specify certificates for token signing and token decryption, specify thumbprint values for the SigningCertificateThumbprint and DecryptionCertificateThumbprint parameters.


PS C:\> $fscredential = Get-Credential
PS C:\> Install-AdfsFarm -CertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -FederationServiceName fs.corp.contoso.com -ServiceAccountCredential $fscredential

Example 2

Description

This example creates the first node in a federation server farm that uses a group Managed Service Account as the service account. In this example, a certificate thumbprint value is supplied for the CertificateThumbprint parameter. This certificate will be used as the SSL certificate and the service communications certificate. Automatically generated, self-signed certificates will be used for the token signing and token decryption certificates.To specify certificates for token signing and token decryption, specify thumbprint values for the SigningCertificateThumbprint and DecryptionCertificateThumbprint parameters

Lists thumbprint values of currently installed certificates.


PS C:\> Install-AdfsFarm -CertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -FederationServiceName fs.corp.contoso.com -GroupServiceAccountIdentifier CONTOSO\GroupAccount01

Example 3

Description

-----------

Creates the first node in a federation server farm that uses a Microsoft SQL server database on a remote computer named "SQLHost".

In this example, a certificate thumbprint value is supplied for the CertificateThumbprint parameter. This certificate will be used as the SSL certificate and the service communications certificate. Automatically generated, self-signed certificates will be used for the token signing and token decryption certificates.

To specify certificates for token signing and token decryption, specify thumbprint values for the SigningCertificateThumbprint and DecryptionCertificateThumbprint parameters.


PS C:\> $fscredential = Get-Credential
PS C:\> Install-AdfsFarm -CertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -FederationServiceName fs.corp.contoso.com -ServiceAccountCredential $fscredential -SQLConnectionString "Data Source=SQLHost;Integrated Security=True"

Example 4

Description

-----------

Overwrites an existing AD FS configuration database and creates the first node in a federation server farm that uses a Microsoft SQL server database on a remote computer named "SQLHost".

In this example, certificate thumbprint values are specified for the token signing certificate and for the token encryption certificate using the SigningCertificateThumbprint and DecryptionCertificateThumbprint parameters respectively.


PS C:\> $fscredential = Get-Credential
PS C:\> Install-AdfsFarm -CertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -FederationServiceName fs.corp.contoso.com -ServiceAccountCredential $fscredential -SQLConnectionString "Data Source=SQLHost;Integrated Security=True" -OverwriteConfiguration -SigningCertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -DecryptionCertificateThumbprint cf2e5064c521d625c8d53536bc98aa8e08f5f2ad

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft