Get-RmsUserRequestReport
Get-RmsUserRequestReport is accessible with the help of ADRMSAdmin module. To install ADRMSAdmin on your system please refer to this ADRMSAdmin.
Synopsis
Generates a user requests statistical report for the Active Directory Rights Management Services (AD RMS) cluster.
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 “:\Report” where 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
-EndTime
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
-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
-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 for which you are requesting a user request report, in the format <domain_name>\<user_name>.
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-RmsUserRequestReport [-StartTime <DateTime>] [-EndTime <DateTime>] [-UserName <String>] [-RequestType <String>] [-Path] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
————– EXAMPLE 1 ————–
C:\PS>Get-RmsUserRequestReport -Path . -UserName TOSSolution\KPavan
This command displays a summary report of the requests from the user KPavan
————– EXAMPLE 2 ————–
C:\PS>Get-RmsUserRequestReport -Path . -StartTime 2/1/2020 -EndTime 2/28/2020 -UserName TOSSolution\KPavan -RequestType AcquireLicense
This command displays the request by a specified user to acquire a license.
————– EXAMPLE 3 ————–
C:\PS>Get-RmsUserRequestReport -Path . -RequestType AcquireLicense -UserName TOSSolution\KPavan | 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.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Get-RmsUserRequestReport
You can also read about
- Get-RmsCertChain
- Get-RmsCertInfo
- Get-RmsRequestInfo