Get-RmsUserRequestReport

Article
09/29/2009

Get-RmsUserRequestReport

Generates a user requests statistical report for the Active Directory Rights Management Services (AD RMS) cluster.

Syntax

Get-RmsUserRequestReport [-StartTime <DateTime>] [-EndTime <DateTime>] -UserName <String> [-Path] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]


Get-RmsUserRequestReport [-StartTime <DateTime>] [-EndTime <DateTime>] -UserId <Int64> -RequestType <String> [-Path] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet generates a report that contains statistics about the request activity of a single user on the Active Directory Rights Management Services (AD RMS) cluster.

To obtain the report, specify the UserName of the user for which you want a report and then set the Path parameter to the AD RMS provider drive subpath “<PSDrive>:\Report” where <PSDrive> is the provider drive ID. You can also specify a relative path. For example, “.” specifies the current location. This will return a UserId and applicable request types that you can then use with the cmdlet to produce a more detailed report.

The UserID value returned for a particular UserName is valid only for the cluster identified by the Path parameter specified when the UserID value was returned. You cannot use the UserID to identify the same user in different clusters.

Parameters

-StartTime <DateTime>

Specifies the beginning of a time period. This parameter specifies a time value.

The following examples show commonly-used syntax to specify a time. Time is assumed to be local time unless otherwise specified. When a time value is not specified, the time is assumed to 12:00:00 AM local time. When a date is not specified, the date is assumed to be the current date.
- “4/17/2006”
- “Monday, April 17, 2006”
- “2:22:45 PM”
- “Monday, April 17, 2006 2:22:45 PM”

These examples specify the same date and the time without the seconds.
- "4/17/2006 2:22 PM”
- "Monday, April 17, 2006 2:22 PM"
- "2:22 PM”

The following example shows how to specify a date and time by using the RFC1123 standard. This example defines time by using Greenwich Mean Time (GMT).
-"Mon, 17 Apr 2006 21:22:48 GMT”

The following example shows how to specify a round-trip value as Coordinated Universal Time (UTC). This example represents Monday, April 17, 2006 at 2:22:48 PM UTC.
-"2000-04-17T14:22:48.0000000"

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	named

-EndTime <DateTime>

Specifies the end of a time period for a system health report. This parameter specifies a time value. See the description of the StartTime parameter for information on specifying a time.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	named

-UserName <String>

Specifies the user for which you are requesting a user request report, in the format <domain_name>\<user_name>.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	named

-Path <String[]>

Specifies a provider drive and path or relative path on the current drive. This parameter is required. Use a dot (.) to specify the current location. This parameter does not accept wildcards and has no default value.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	1

-WhatIf <SwitchParameter>

Describes what would happen if you executed the command without executing the command.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-UserId <Int64>

Specifies an internal user ID.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	named

-RequestType <String>

Specifies the type of user request, such as “Acquire License”, “Pre-Certify”, and “Get Client Licensor Certificate”.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Position?	named

-CommonParameter

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see About Common Parameter

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Input Type	.
Return Type	.

Notes

Examples

EXAMPLE 1

C:\PS>Get-RmsUserRequestReport -Path . -UserName Research\RSun

This command displays a summary report of the requests from the user RSun of the Research domain.

EXAMPLE 2

C:\PS>Get-RmsUserRequestReport -Path . -StartTime 2/1/2009 -EndTime 2/28/2009 -UserID 3 -RequestType AcquireLicense

This command displays the request by a specified user to acquire a license. You can obtain a user's numeric ID and request types by running the command in Example 1.

EXAMPLE 3

C:\PS>Get-RmsUserRequestReport -Path . -RequestType GetClientLicensorCertificate -UserId 1 | Get-RmsCertChain -Path .

This command uses the Get-RmsUserRequestReport cmdlet to retrieve the ID of a user request and then pipes the ID to the Get-RmsCertChain cmdlet to display the certificate chain of the request.

EXAMPLE 4

C:\PS>Get-RmsUserRequestReport -Path . -RequestType AcquireLicense -UserID 1 | Get-RmsRequestInfo -Path .

This command displays detailed information about a user's request to acquire a license. The Get-RmsUserRequestReport cmdlet retrieves the user's license request and then pipes the results to the Get-RmsRequestInfo cmdlet to display the details of the request.

Get-RmsUserRequestReport