Export (0) Print
Expand All

AD RMS Administration 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 administering 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 administer 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 administering AD RMS, and the other set is used to deploying and configuring an AD RMS cluster. For more information on deploying and configuring AD RMS using Windows PowerShell, see AD RMS Deployment 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

Export-RmsReportDefinitionLanguage

Exports all report definition (.rdl) files for this version of AD RMS.

Export-RmsTPD

Exports a trusted publishing domain (TPD) in AD RMS.

Export-RmsTUD

Exports a trusted user domain (TUD) in AD RMS.

Get-RmsCertChain

Generates a report containing information about the certificate chain of a particular user request for the AD RMS cluster.

Get-RmsCertInfo

Generates a report containing information about a particular certificate used in a user request for the AD RMS cluster.

Get-RmsChildCert

Returns all child certificates from a parent certificate used in a user request for the AD RMS cluster.

Get-RmsEncryptedIL

Returns use-license information from an issuance license used in a user request for the AD RMS cluster.

Get-RmsRequestInfo

Generates a report containing information about a particular user request for the AD RMS cluster.

Get-RmsSvcAccount

Gets service account credentials for an AD RMS cluster.

Get-RmsSystemHealthReport

Generates a system health report of the AD RMS cluster.

Get-RmsUserRequestReport

Generates a user requests statistical report for the AD RMS cluster.

Import-RmsTPD

Imports a trusted publishing domain (TPD) from a file in AD RMS.

Import-RmsTUD

Imports a trusted user domain (TUDs) from a file in AD RMS or specifies to trust Microsoft account IDs.

Initialize-RmsCryptoMode2

Prepares an AD RMS server for transitioning to Cryptographic Mode 2.

Install-RmsMfgEnrollment

Enrolls an AD RMS server with Microsoft Federation Gateway.

Install-RmsMfgSupport

Adds Microsoft Federation Gateway support to an AD RMS server.

Set-RmsSvcAccount

Sets the service account for an AD RMS cluster.

Uninstall-RmsMfgEnrollment

Terminates the enrollment of an AD RMS server with the Microsoft Federation Gateway.

Uninstall-RmsMfgSupport

Removes Microsoft Federation Gateway support from an AD RMS server.

Update-RmsCluster

Updates the AD RMS cluster information.

Update-RmsMfgEnrollment

Updates enrollment information for an AD RMS server enrolled with the Microsoft Federation Gateway service.

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.

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

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