Share via

Creating a System Health Report

  • Article

Updated: October 22, 2009

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

A system health report gives you important information about how well your Active Directory Rights Management Services (AD RMS) cluster is functioning. You can obtain reports on the following areas of server activity:

  • Request
    A Request report provides information about user requests that the cluster processed, including the number and success rate of requests of each type, as well as the average duration (in milliseconds) of each request type.
  • Server
    A Server report provides information about user requests that each server processed, including the total number and success rates of the requests, as well as the average duration (in milliseconds) of each request.
  • Domain
    A Domain report provides information about user requests that the cluster processed for each domain, including the total number and success rates of the requests, as well as the average duration (in milliseconds) of each request.
  • User
    A User report provides information about requests from each user that the cluster processed, including the number and success rate of requests of each user, as well as the average duration (in milliseconds) of each user’s requests.

You can request summary reports that display all items for each request type, or you can narrow the report to a specific set of items.

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

To create a summary system health report

  • At the Windows PowerShell command prompt, type:

    Get-RmsSystemHealthReport -Path <drive>:\Report [-StartTime <start_time>] [-EndTime <end_time>] -ReportType <report_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, and <report_type> is the type (Request, Server, Domain, or User) of the report you want to create. 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 of request types 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-RmsSystemHealthReport -Path Z:\Report -StartTime "1/1/2009 16:00" -EndTime "1/9/2009 07:59" -ReportType Request

To create a system health report for a specific request type

  • At the Windows PowerShell command prompt, type:

    Get-RmsSystemHealthReport -Path <drive>:\Report [-StartTime <start_time>] [-EndTime <end_time>] -ReportType Request -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, and <request_type> is the type of request (such as FindServiceLocationsForUser, Certify, GetClientLicensorCert, AcquireLicense, or TemplateDistribution.AcquireTemplateInformation) for which you want to create a report. Times are expressed as Coordinated Universal Time (UTC), also known as Greenwich Mean Time. The default range is the preceding 14 days.

To create a system health report for a specific server

  • At the Windows PowerShell command prompt, type:

    Get-RmsSystemHealthReport -Path <drive>:\Report [-StartTime <start_time>] [-EndTime <end_time>] -ReportType Server -ServerName <server_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, and <server_name> is the name of the server for which you want to create a report. Times are expressed as Coordinated Universal Time (UTC), also known as Greenwich Mean Time. The default range is the preceding 14 days.

To create a system health report for a specific domain

  • At the Windows PowerShell command prompt, type:

    Get-RmsSystemHealthReport -Path <drive>:\Report -StartTime [<start_time>] [-EndTime <end_time>] -ReportType Domain -DomainName <domain_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, and <domain_name> is the name of the domain for which you want to create a report. Times are expressed as Coordinated Universal Time (UTC), also known as Greenwich Mean Time. The default range is the preceding 14 days.

To create a system health report for a specific user

  • At the Windows PowerShell command prompt, type:

    Get-RmsSystemHealthReport -Path <drive>:\Report [-StartTime <start_time>] [-EndTime <end_time>] -ReportType User -UserName <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, and <user_name > is the name of the user for which you want to create a report. Times are expressed as Coordinated Universal Time (UTC), also known as Greenwich Mean Time. The default range is the preceding 14 days.

See Also

Concepts

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