AD FS Cmdlets in Windows PowerShell

Windows PowerShell™ is a task-based command-line shell and scripting language designed especially for system administration. This reference provides command-line reference documentation for the IT professional of the Windows PowerShell cmdlets that you can use to deploy and administer Active Directory Federation Services (AD FS) in Windows Server® 2012.

AD FS deployment cmdlets

With Windows Server 2012, the AD FS server role now includes cmdlets that you can use to perform PowerShell-based deployment within your federated identity installations and environments.

The following table lists all the cmdlets that are available for deploying AD FS in Windows Server 2012.

Sets up this computer as a stand-alone federation server for evaluation purposes or for a small lab environment.

AD FS administration cmdlets

In addition to deployment, you can continue to use AD FS cmdlets that were first made available in AD FS 2.0 to perform various administrative, configuration, and diagnostic tasks in your federated identity deployment and environments.

Note

The following cmdlets for getting and setting AD FS configuration properties have revised from their original naming in AD FS 2.0.

Get-ADFSProperties has been renamed Get-AdfsConfiguration.

Get-ADFSProxyProperties has been renamed has been renamed Get-AdfsProxyConfiguration.

Get-ADFSSyncProperties has been renamed Get-AdfsSyncConfiguration.

Set-ADFSProperties has been renamed Set-AdfsConfiguration.

Set-ADFSProxyProperties has been renamed Set-AdfsProxyConfiguration.

Set-ADFSSyncProperties has been renamed Set-AdfsSyncConfiguration.

The following table lists all the cmdlets that are available for administering AD FS in Windows Server 2012.

To use these cmdlets you must have previously installed the AD FS server role. This can be done using the Add Roles and Features Wizard in Server Manager or optionally, you can use the Install-WindowsFeature AD-Federation-Services cmdlet at a Windows PowerShell prompt to add the role.

Once the role is added, you can list all the cmdlets that are available in the AD FS module by using the Get-Command * -module ADFS cmdlet.

For more information about—or for the syntax for—any of the AD FS cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets: