Get-FsrmStorageReport
Get-FsrmStorageReport
Gets storage reports.
Syntax
Parameter Set: Query (cdxml)
Get-FsrmStorageReport [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed 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.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies an arrary of names of storage reports.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
true |
-ThrottleLimit<Int32>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMStorageReport
Examples
Example 1: Get all storage reports.
This command gets all storage reports on the server.
PS C:\> Get-FsrmStorageReport
Example 2: Get a storage report by using a name
This command gets the storage report named "Find big files".
PS C:\> Get-FsrmStorageReport -Name "Find big files"