Get-RmsSystemHealthReport

Get-RmsSystemHealthReport is accessible with the help of ADRMSAdmin module. To install ADRMSAdmin on your system please refer to this ADRMSAdmin.

Synopsis

Generates a system health report of the Active Directory Rights Management Services (AD RMS) cluster.

Description

This cmdlet generates a report that contains information about the overall health of the Active Directory Rights Management Services (AD RMS) cluster.

To obtain the report, set the parameters for the type of report you want and then set the Path parameter to the AD RMS provider drive subpath “:\Report” where is the provider drive ID. You can also specify a relative path. For example, “.” specifies the current location.

The cmdlet generates a summary report for the specified ReportType unless you specify RequestType, ServerName, DomainName, or UserName.

Parameters

 -DomainName
Specifies the domain name of the e-mail of the user.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByValue, ByPropertyName)
    Accept wildcard characters?  false

-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.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByValue, ByPropertyName)
    Accept wildcard characters?  false

-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.

    Required?                    true
    Position?                    1
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-ReportType <ReportType>
    Specifies the type of report. Possible values are “Server”, ”Request”, “Domain”, and “User”.

    Required?                    true
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByValue, ByPropertyName)
    Accept wildcard characters?  false

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

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByValue, ByPropertyName)
    Accept wildcard characters?  false

-ServerName <String>
    Specifies the name of the server for which you are requesting the health report.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByValue, ByPropertyName)
    Accept wildcard characters?  false

-StartTime <DateTime>
    Specifies the beginning of a time period. This parameter specifies a time value.


    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByValue, ByPropertyName)
    Accept wildcard characters?  false

-UserName <String>
    Specifies the user name for which you are requesting a system health report.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByValue, ByPropertyName)
    Accept wildcard characters?  false

-Confirm <SwitchParameter>
    Prompts you for confirmation before running the cmdlet.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

-WhatIf <SwitchParameter>
    Shows what would happen if the cmdlet runs. The cmdlet is not run.

    Required?                    false
    Position?                    named
    Default value                false
    Accept pipeline input?       false
    Accept wildcard characters?  false

Syntax

Get-RmsSystemHealthReport [-StartTime <DateTime>] [-EndTime <DateTime>] [-ServerName <String>] [-RequestType <String>] [-DomainName <String>] [-UserName <String>] -ReportType <ReportType> [-Path] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

————– EXAMPLE 1 ————–
C:\PS>Get-RmsSystemHealthReport -Path . -ReportType Request
This command displays a summary report of requests processed by the AD RMS cluster.

————– EXAMPLE 2 ————–
C:\PS>Get-RmsSystemHealthReport -Path . -StartTime 1/1/2020 -EndTime 1/31/2020 -ReportType User
This command displays a summary report of user activity during calendar year 2020 January.

————– EXAMPLE 3 ————–
C:\PS>Get-RmsSystemHealthReport -Path . -ReportType User -Domain Research
This command displays a summary report of requests by all users in the Research domain.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Get-RmsSystemHealthReport

You can also read about

To know more PowerShell cmdlets(Commands) on ADRMSAdmin (Active Directory Rights Management Services Admin) click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft