AD RMS Deployment Cmdlets in Windows PowerShell

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

Active Directory Rights Management Services – Installation and Configuration

This topic contains brief descriptions of the Windows PowerShell® cmdlets that are for use in deploying in Windows Server® 2012. Each cmdlet in the table is linked to additional information about that cmdlet. These cmdlets give you the ability to install, upgrade, or remove an cluster using Windows PowerShell.


The server role is supported by two sets of Windows PowerShell cmdlets. The set discussed in this topic assists in deploying and configuring , and the other set is used to administer an cluster. For more information on administering using Windows PowerShell, see AD RMS Administration Cmdlets in Windows Server 2012.

For complete information about using Windows PowerShell to install or remove , see Using Windows PowerShell to Deploy AD RMS.

Cmdlet Description


This cmdlet configures the server role. Before running this cmdlet, prepare the server by setting properties on containers in the deployment provider namespace. You can also use this cmdlet to install Identity Federation Support on an existing cluster.


This cmdlet removes configuration of the server role. You can also use this cmdlet to remove configuration of Identity Federation Support from a cluster if it has been installed previously.


This cmdlet upgrades the server role following an upgrade of the operating system. This cmdlet is also used to update the cryptographic mode. You can use the WhatIf parameter to view the actions that would be taken by the cmdlet without changing the system.


To display these cmdlets, you will need to run the following commands from Windows PowerShell. You need only run the Add-WindowsFeature cmdlet for the specific server role that you would like to add.

  • Add-WindowsFeature ADRMS – Adds the server role and all its related installation files.

  • Add-WindowsFeature ADRMS -IncludeManagementTools – Adds the installation files for the server role and management tools.

  • Add-WindowsFeature ADRMS -IncludeAllSubFeature – Adds the installation files for the server role and Identity Federation Support.

  • Get-Command -Module ADRMS – Displays all the above cmdlets that are associated with deployment.

For more information about—or for the syntax for—any of the deployment 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> -Examples