IFsrmReportManager Interface

 

Used to manage report jobs.

Namespace:   Microsoft.Storage
Assembly:  srmlib (in srmlib.dll)

Syntax

[GuidAttribute("27B899FE-6FFA-4481-A184-D3DAADE8A02B")]
public interface IFsrmReportManager
[GuidAttribute("27B899FE-6FFA-4481-A184-D3DAADE8A02B")]
public interface class IFsrmReportManager
[<GuidAttribute("27B899FE-6FFA-4481-A184-D3DAADE8A02B")>]
type IFsrmReportManager = interface end
<GuidAttribute("27B899FE-6FFA-4481-A184-D3DAADE8A02B")>
Public Interface IFsrmReportManager

Methods

Name Description
System_CAPS_pubmethod CreateReportJob()

Creates a report job.

System_CAPS_pubmethod EnumReportJobs(_FsrmEnumOptions)

Enumerates the report jobs.

System_CAPS_pubmethod GetDefaultFilter(_FsrmReportType, _FsrmReportFilter)

Retrieves the default report filter value that is used with the specified report type.

System_CAPS_pubmethod GetOutputDirectory(_FsrmReportGenerationContext)

Retrieves the local directory path where the reports with the specified context are stored.

System_CAPS_pubmethod GetReportJob(String)

Retrieves the specified report job.

System_CAPS_pubmethod GetReportSizeLimit(_FsrmReportLimit)

Retrieves the current value of the specified report size limit.

System_CAPS_pubmethod IsFilterValidForReportType(_FsrmReportType, _FsrmReportFilter)

Retrieves a value that determines whether a specified report filter is configurable for the specified report type.

System_CAPS_pubmethod SetDefaultFilter(_FsrmReportType, _FsrmReportFilter, Object)

Sets the default report filter value to use with the specified report type.

System_CAPS_pubmethod SetOutputDirectory(_FsrmReportGenerationContext, String)

Sets the local directory path where reports are stored.

System_CAPS_pubmethod SetReportSizeLimit(_FsrmReportLimit, Object)

Sets the current value of the specified report size limit.

Remarks

A storage report job specifies a set of directories that will be analyzed to generate one or more different report types that help administrators to better understand how storage is utilized in the specified directories. You can configure report jobs to execute according to a schedule or on demand.

To create this object from a script, use the "Fsrm.FsrmReportManager" program identifier.

See Also

FsrmReportManager
Microsoft.Storage Namespace

Return to top