AD RMS Cmdlets in Windows PowerShell
The Active Directory Rights Management Services (AD RMS) server role in Windows Server® 2008 R2 is supported by two sets of Windows PowerShell cmdlets. One set assists in deploying and configuring AD RMS, and the second set is used to administer an AD RMS cluster. The sections in this topic describe these two sets of cmdlets.
Deployment
The AD RMSWindows PowerShell deployment cmdlet provider gives you the ability to install, upgrade, or remove an AD RMS cluster by using Windows PowerShell cmdlets. The following describes these cmdlets.
- Install-ADRMS
This cmdlet installs the AD RMS server role and, if necessary, any features required by AD RMS. 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 federated identity support on an existing cluster.
- Uninstall-ADRMS
This cmdlet removes the AD RMS server role. You can also use this cmdlet to remove identity federation support from a cluster.
- Update-ADRMS
This cmdlet upgrades the AD RMS server role following an upgrade of the operating system to Windows Server 2008 R2. You can use the WhatIf parameter to view the actions that would be taken by the cmdlet without changing the system.
For complete information about using Windows PowerShell to install or remove AD RMS, see Using Windows PowerShell to Deploy AD RMS.
Administration
The AD RMS Windows PowerShell administration cmdlet provider gives you the ability to administer all aspects of an AD RMS cluster by using Windows PowerShell cmdlets. Most often, you will perform these tasks by using common Windows PowerShell cmdlets, such as New-Item and Set-ItemProperty, that manipulate objects in the AD RMS Windows PowerShell administration namespace. In cases where common cmdlets cannot provide the required functionality for AD RMS administration, the AD RMS Windows PowerShell administration cmdlet provider implements special-purpose cmdlets. These cmdlets are available only when the current location or the Path parameter is set to a specific path in the AD RMSWindows PowerShell administration namespace.
The following table briefly describes these cmdlets. For complete information about a cmdlet, at a Windows PowerShell prompt, type Get-Help*<cmdlet_name>*-full.
| Path | Cmdlet |
|---|---|
<drive>:\ |
|
|
|
|
|
<drive>:\Report |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<drive>:\TrustPolicy\TrustedPublishingDomain |
|
|
|
<drive>:\TrustPolicy\TrustedUserDomain |
|
|
For complete information about using these cmdlets, see Using Windows PowerShell to Administer AD RMS