Export (0) Print
Expand All
Expand Minimize

Start-FsrmStorageReport

Updated: December 6, 2012

Applies To: Windows Server 2012

Start-FsrmStorageReport

Starts generating storage reports.

Syntax

Parameter Set: Query (cdxml)
Start-FsrmStorageReport [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Queue] [-RunDuration <Int32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Start-FsrmStorageReport -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Queue] [-RunDuration <Int32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Start-FsrmStorageReport cmdlet starts generating one or more storage reports on demand. You cannot use this cmdlet to start interactive storage reports or storage reports that do not have a schedule.

You can view the reports immediately after the server generates them or e-mail the reports to a group of administrators. If you choose to open the reports immediately, you must wait while the reports are generated. Processing time varies, depending on the types of reports and the scope of the data.

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.


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

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names of storage reports.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

-Queue

Indicates that the server adds the report to a queue and the report should run in the next 5 minutes. Any reports that the server queues during the next 5 minutes are run together. If you do not specify this parameter, the server runs the report immediately.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunDuration<Int32>

Specifies the number of hours that the server runs the report job before canceling it. The value 0 indicates that the server runs the report job to completion.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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: Start a storage report

This command starts the storage report named "Monthly report" immediately.


PS C:\> Start-FsrmStorageReport "Monthly report"

Example 2: Queue a storage report and set the run duration

This command queues the storage report named "Monthly report" to start in the next 5 minutes and specifies that the server does not run the report job any longer than 4 hours.


PS C:\> Start-FsrmStorageReport "Monthly report" -Queue -RunDuration 4

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft