AD FS 2.0 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 manage and administer Active Directory Federation Services (AD FS) 2.0.
You can use AD FS 2.0 cmdlets to perform various administrative, configuration, and diagnostic tasks in your federated identity deployment and environments.
The following table lists all the cmdlets that are available in this release of the AD FS 2.0.
Cmdlet | Description |
---|---|
Adds an attribute store to the Federation Service. |
|
Adds a new certificate to the Federation Service for signing, decrypting, or securing communications. |
|
Adds a claim description to the Federation Service. |
|
Adds a new claims provider trust to the Federation Service. |
|
Adds a new relying party trust to the Federation Service. |
|
Disables a claims provider trust in the Federation Service. |
|
Disables an endpoint of the Federation Service. |
|
Disables a relying party trust of the Federation Service. |
|
Enables a claims provider trust in the Federation Service. |
|
Enables an endpoint in the Federation Service. |
|
Enables a relying party trust of the Federation Service. |
|
Gets the attribute stores of the Federation Service. |
|
Gets the certificates that are in the Federation Service. |
|
Gets claim descriptions that are in the Federation Service. |
|
Gets the claims provider trusts in the Federation Service. |
|
Gets the endpoints in the Federation Service. |
|
Gets the properties of the Federation Service. |
|
Gets the properties of the federation server proxy. |
|
Gets the relying party trusts of the Federation Service. |
|
Gets the configuration database synchronization properties of the Federation Service. |
|
Creates a new set of claim rules. |
|
Creates a new contact person object. |
|
Creates a new organization information object. |
|
Creates a new SAML protocol endpoint object. |
|
Removes an attribute store from the Federation Service. |
|
Removes a certificate from the Federation Service. |
|
Removes a claim description from the Federation Service. |
|
Removes a claims provider trust from the Federation Service. |
|
Removes a relying party trust from the Federation Service. |
|
Revokes all proxy trust for the Federation Service. |
|
Sets the properties of the attribute store. |
|
Sets the properties of an existing certificate that the Federation Service uses to sign, decrypt, or secure communications. |
|
Sets the account that is used for sharing managed certificates in a federation server farm. |
|
Sets the properties of an existing claim description. |
|
Sets the properties of a claims provider trust. |
|
Sets the properties of a Federation Service endpoint. |
|
Sets the properties of the Federation Service. |
|
Sets the properties of the federation server proxy. |
|
Sets the properties of a relying party trust. |
|
Sets the properties of the database synchronization engine for the federation server farm. |
|
Updates the certificates of the Federation Service. |
|
Updates the claims provider trust from federation metadata. |
|
Updates the relying party trust from federation metadata. |
Note
To list all the cmdlets that are available in the AD FS 2.0, use the Get-Command -ADFS cmdlet.
For more information about—or for the syntax for—any of the AD FS 2.0 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:
Get-Help <cmdlet name> -Detailed
Get-Help <cmdlet name> -Full
Get-Help <cmdlet name> -Detailed
Get-Help <cmdlet name> -Examples
For more information about the AD FS 2.0 cmdlets, see the following: