AD RMS Administration Cmdlets
Updated: October 22, 2009
Applies To: Windows Server 2008 R2, Windows Server 2008 R2 with SP1
The Active Directory Rights Management Services (AD RMS) Windows PowerShell administration module 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 module implements special-purpose cmdlets to perform tasks that cannot be performed by using common cmdlets. These cmdlets are available only when the current location or the Path parameter is set to a specific path in the AD RMS Windows 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.
Cmdlets that are marked with an asterisk (*) are available only on systems with Service Pack 1 (SP1) for Windows Server® 2008 R2 installed.
| Path | Cmdlet | Description |
|---|---|---|
<drive>:\ |
Get-RmsSvcAccount |
The Get-RmsSvcAccount cmdlet gets service account credentials for an AD RMS cluster. |
|
Set-RmsSvcAccount |
The Set-RmsSvcAccount cmdlet sets the service account for an AD RMS cluster. |
|
Update-RmsCluster |
The Update-RmsCluster cmdlet updates the cluster information including the hierarchy of content that defines the cluster. You must set the current location to the root before running this cmdlet; the Path parameter is ignored. |
Install-RmsMfgEnrollment* |
Enrolls the AD RMS cluster with the Microsoft Federation Gateway. |
|
Install-RmsMfgSupport* |
Adds Microsoft Federation Gateway Support to the AD RMS server. |
|
Uninstall-RmsMfgEnrollment* |
Removes the enrollment of the AD RMS cluster with the AD RMS. |
|
Uninstall-RmsMfgSupport* |
Removes Microsoft Federation Gateway Support from the AD RMS server. |
|
Update-RmsMfgEnrollment* |
Updates one or both of the Microsoft Federation Gateway Support certificates. |
|
<drive>:\Report |
Export-RmsReportDefinitionLanguage |
This cmdlet exports report definition (.rdl) files for this version of AD RMS. |
|
Get-RmsCertChain |
This cmdlet generates a report that contains information about the certificate chain of a particular user request on the AD RMS cluster. |
|
Get-RmsCertInfo |
This cmdlet generates a report that contains information about a particular certificate used in a user request on the AD RMS cluster. |
|
Get-RmsChildCert |
This cmdlet returns all issuance licenses from a parent client licensor certificate (CLC) or all end-user licenses (EULs) from a parent issuance license used in a user request on the AD RMS cluster. |
|
Get-RmsEncryptedIL |
This cmdlet generates a report containing information about an issuance license used in a user request on the AD RMS cluster. To use this cmdlet, you must be logged in as an Enterprise Administrator and XrML certificate logging must be enabled. See Creating an Issuance License Report for more information. |
|
Get-RmsRequestInfo |
This cmdlet generates a report that contains detailed information about a particular user request on the AD RMS cluster. |
|
Get-RmsSystemHealthReport |
This cmdlet generates a report that contains information about the overall health of the AD RMS cluster. |
|
Get-RmsUserRequestReport |
This cmdlet generates a report that contains statistics about the request activity of a single user on the AD RMS cluster. |
<drive>:\TrustPolicy\TrustedPublishingDomain |
Export-RmsTPD |
This cmdlet exports a trusted publishing domain (TPD) to a file. |
|
Import-RmsTPD |
This cmdlet imports a TPD from a file. |
<drive>:\TrustPolicy\TrustedUserDomain |
Export-RmsTUD |
This cmdlet exports a trusted user domain (TUD) to a file. |
|
Import-RmsTUD |
This cmdlet imports a TUD from a file. |
For complete information about these cmdlets, see AD RMS Cmdlets in Windows PowerShell (https://go.microsoft.com/fwlink/?LinkID=165547).