Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-11
Use the Test-IRMConfiguration cmdlet to test Information Rights Management (IRM) configuration and functionality.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Test-IRMConfiguration [-Identity
<OrganizationIdParameter>] [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-Recipient <SmtpAddress[]>] [-RMSOnline
<SwitchParameter>] [-RMSOnlineAuthCertSubjectNameOverride
<String>] [-RMSOnlineOrgOverride <Guid>] [-Sender
<SmtpAddress>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example tests the IRM configuration for messages sent from the sender adams@contoso.com.
 Copy Code |
|
|---|---|
Test-IRMConfiguration -Sender adams@contoso.com |
|
Detailed Description
The Test-IRMConfiguration cmdlet performs a series of steps to test IRM configuration and functionality, including availability of an Active Directory Rights Management Services (AD RMS) server, prelicensing, and journal report decryption. In Exchange Online organizations, it checks connectivity to RMS Online and obtains and validates the organization's Trusted Publishing Domain (TPD).
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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
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.OrganizationIdParameter |
The Identity parameter is reserved for internal Microsoft use. |
|
Recipient |
Optional |
Microsoft.Exchange.Data.SmtpAddress[] |
The Recipient parameter specifies the SMTP address of one or more recipients. The cmdlet tests prelicensing for the specified recipients. You can specify multiple recipient addresses separated by commas. If no recipient is specified, the sender address is used as the recipient. |
|
RMSOnline |
Optional |
System.Management.Automation.SwitchParameter |
The RMSOnline switch specifies whether to test connectivity from Exchange Online to RMS Online, obtain your Exchange Online organization's TPD, and test its validity. |
|
RMSOnlineAuthCertSubjectNameOverride |
Optional |
System.String |
This parameter is reserved for internal Microsoft use. |
|
RMSOnlineOrgOverride |
Optional |
System.Guid |
This parameter is reserved for internal Microsoft use. |
|
Sender |
Optional |
Microsoft.Exchange.Data.SmtpAddress |
The Sender parameter specifies the SMTP address of the sender to be tested. The cmdlet tests prelicensing and journal report decryption for the sender. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
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.
Return Types
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.