Creating a User Request Report

Updated: October 22, 2009

Applies To: Windows Server 2008 R2, Windows Server 2008 R2 with SP1

You can create a user request report to learn details about a particular user request, including such details as the time of the request, the server that responded to the request, and the results of the request.

The first step in creating a user request report is to produce a summary request report for a user that lists the user ID and request types processed for the user. You can then use this information to create a report that shows the details of the specific requests of a particular type by the user.

Membership in the local AD RMS Enterprise Administrators, or equivalent, is the minimum required to complete this procedure.

To create a summary request report for a user

  • At the Windows PowerShell command prompt, type:

    Get-RmsUserRequestReport -Path <drive>:\Report [-StartTime <start_time>] [-EndTime <end_time>] -UserName <user_domain>\<user_name>

    where <drive> is the name of the Windows PowerShell drive, <start_time> and <end_time> are the beginning and ending time of the range of requests you want to report, <user_domain> is the Active Directory Domain Services domain name of the user you want to create a report for, and <user_name> is the name of the user you want to create a report for. Times are expressed as Coordinated Universal Time (UTC), also known as Greenwich Mean Time. The default range is the preceding 14 days.

    For example, for a Windows PowerShell drive named Z, to create a summary report for a user named kelly in a domain named corpmain for the period beginning January 1, 2009 at 8:00 AM Pacific Standard Time (which is eight hours behind UTC time) and ending January 8, 2009 at 11:59 PM Pacific Standard Time, type:

    Get-RmsUserRequestReport -Path Z:\Report -StartTime "1/1/2009 16:00" -EndTime "1/9/2009 07:59" -UserName corpmain\kelly

Tip

If Service Pack 1 (SP1) for Windows Server® 2008 R2 is installed, you can also specify user names in the format <user_name>@<domain>.

To create a detailed request report for a user

  • Do one of the following

    1. If Service Pack 1 (SP1) for Windows Server® 2008 R2 is not installed, at the Windows PowerShell command prompt, type:

      Get-RmsUserRequestReport -Path <drive>:\Report [-StartTime <start_time>] [-EndTime <end_time>] -UserID <user_ID> -RequestType <request_type>

      where <drive> is the name of the Windows PowerShell drive, <start_time> and <end_time> are the beginning and ending time of the range of requests you want to report, <user_ID> is the integer ID (obtained from a summary report) of the user you want to create a report for, and <request_type> is the type of request (such as FindServiceLocationsForUser, Certify, GetClientLicensorCert, AcquireLicense, or TemplateDistribution.AcquireTemplateInformation) you want to create a report for. Times are expressed as Coordinated Universal Time (UTC), also known as Greenwich Mean Time. The default range is the preceding 14 days.

    2. If SP1 for Windows Server 2008 R2 is installed, at the Windows PowerShell command prompt, type:

      Get-RmsUserRequestReport -Path <drive>:\Report [-StartTime <start_time>] [-EndTime <end_time>] -UserName <user_domain>\<user_name> -RequestType <request_type>

      where <drive> is the name of the Windows PowerShell drive, <start_time> and <end_time> are the beginning and ending time of the range of requests you want to report, <user_domain> is the Active Directory Domain Services domain name of the user you want to create a report for, <user_name> is the name of the user you want to create a report for, and <request_type> is the type of request (such as FindServiceLocationsForUser, Certify, GetClientLicensorCert, AcquireLicense, or TemplateDistribution.AcquireTemplateInformation) you want to create a report for. Times are expressed as Coordinated Universal Time (UTC), also known as Greenwich Mean Time. The default range is the preceding 14 days.

Tip

You can also specify user names in the format <user_name>@<domain>.

Important

The request IDs displayed in this report are specific to the AD RMS cluster identified by <drive>. You cannot use them as parameter values for cmdlets that you run with a Windows PowerShell drive that identifies another AD RMS cluster.

See Also

Concepts

Using Windows PowerShell to Administer AD RMS
Understanding the AD RMS Administration Provider Namespace
AD RMS Administration Cmdlets
Working with Reports