Export (0) Print
Expand All
Expand Minimize

Get-RMSTemplate

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-31

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-RMSTemplate cmdlet to retrieve the current list of active rights policy templates from the Active Directory Rights Management Services (AD RMS) deployment for the organization.

For information about the parameter sets in the Syntax section below, see Syntax.

Get-RMSTemplate [-Organization <OrganizationIdParameter>] [-DomainController <Fqdn>] [-Identity <RmsTemplateIdParameter>] [-ResultSize <Unlimited>] [-TrustedPublishingDomain <RmsTrustedPublishingDomainIdParameter>] [-Type <Archived | Distributed | All>]

This example retrieves all RMS templates available from the RMS deployment.

Get-RMSTemplate -ResultSize unlimited

This example retrieves the Company Confidential RMS template.

Get-RMSTemplate -Identity "Company Confidential"

NoteNote:
The Get-RMSTemplate cmdlet doesn't return any active rights policy templates if internal licensing isn't enabled. Use the Get-IRMConfiguration cmdlet to check the InternalLicensingEnabled parameter.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Information Rights Management (IRM) configuration" entry in the Messaging policy and compliance permissions topic.

 

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.RmsTemplateIdParameter

The Identity parameter specifies the name of the RMS template.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. The default value is 1000. To return all results, use unlimited.

TrustedPublishingDomain

Optional

Microsoft.Exchange.Configuration.Tasks.RmsTrustedPublishingDomainIdParameter

This parameter is available only in the cloud-based service.

The TrustedPublishingDomain parameter specifies the trusted publishing domain you want to search for RMS templates. You can use any value that uniquely identifies the trusted publishing domain, for example:

  • Name

  • Distinguished name (DN)

  • GUID

Type

Optional

Microsoft.Exchange.Security.RightsManagement.RmsTemplateType

This parameter is available only in the cloud-based service.

The Type parameter specifies the type of RMS template. Use one of the following values:

  • All

  • Archived

  • Distributed

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

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