Get-Fsrm Storage Report

Module:
fileserverresourcemanager
Gets storage reports.

Syntax 

Get-FsrmStorageReport
   [[-Name] <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-FsrmStorageReport cmdlet gets one or more storage reports on the server. This cmdlet gets all types of storage reports: scheduled, interactive, and incident reports. If you do not specify the Name parameter, this cmdlet gets all storage reports on the server.

The object that this cmdlet returns does not include a property to indicate if a report is interactive. Use the Schedule property to determine if a report is interactive or is launched by an event incident, such as a quota event. If the Schedule property has a value, the report is scheduled. If the schedule property is null, the report is interactive or generated by an event.

Examples

Example 1: Get all storage reports. 

PS C:\> Get-FsrmStorageReport

This command gets all storage reports on the server.

Example 2: Get a storage report by using a name 

PS C:\> Get-FsrmStorageReport -Name "Find big files"

This command gets the storage report named "Find big files".

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs .

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name

Specifies an arrary of names of storage reports.

Type: String[]
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Outputs

Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMStorageReport