Export (0) Print
Expand All

AD RMS Deployment Cmdlets in Windows PowerShell

Updated: August 15, 2012

Applies To: Windows Server 2012

This topic contains brief descriptions of the Windows PowerShell® cmdlets that are for use in deploying Active Directory Rights Management Services (AD RMS) 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 AD RMS cluster using Windows PowerShell.

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

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

 

Cmdlet Description

Install-ADRMS

This cmdlet configures the AD RMS 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.

Uninstall-ADRMS

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

Update-ADRMS

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

TipTip
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 AD RMS server role and all its related installation files.

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

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

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

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

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