IFsrmReportJob Interface

 

Used to configure a report job.

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

<GuidAttribute("38E87280-715C-4C7D-A280-EA1651A19FEF")>
Public Interface IFsrmReportJob
	Inherits IFsrmObject

NameDescription
System_CAPS_pubpropertyDescription

Retrieves or sets the description of the object.

System_CAPS_pubpropertyFormats

Retrieves or sets an array of formats that determine the content format of the reports.

System_CAPS_pubpropertyid

Retrieves the identifier of the object.

System_CAPS_pubpropertyLastError

Retrieves the error message from the last time the reports were run.

System_CAPS_pubpropertyLastGeneratedInDirectory

Retrieves the local directory path where the reports were stored the last time the reports were run.

System_CAPS_pubpropertyLastRun

Retrieves the time stamp for when the reports were last run.

System_CAPS_pubpropertyMailTo

Retrieves or sets the email addresses of those that will receive the reports via email.

System_CAPS_pubpropertyNamespaceRoots

Retrieves or sets an array of local directory paths that will be scanned when the report job is run.

System_CAPS_pubpropertyRunningStatus

Retrieves the running status of the report job.

System_CAPS_pubpropertyTask

Retrieves or sets the name of the report job.

NameDescription
System_CAPS_pubmethodCancel()

Cancels the running reports for this report job.

System_CAPS_pubmethodCommit()

Saves the report job object in the server's list of objects.

System_CAPS_pubmethodCreateReport(_FsrmReportType)

Creates a new report object of the specified type.

System_CAPS_pubmethodDelete()

Removes the report job object from the server's list of objects.

System_CAPS_pubmethodEnumReports()

Enumerates all the reports configured for this report job.

System_CAPS_pubmethodRun(_FsrmReportGenerationContext)

Runs all the reports in the job.

System_CAPS_pubmethodWaitForCompletion(Int32)

Waits for the reports in the job to complete.

The job specifies a set of directories that will be scanned to generate one or more different type of reports. The reports help the administrator analyze how the storage is used. The job may also be associated with a scheduled task that will trigger report generation.

To create this interface, call the CreateReportJob method.

The following methods return this interface:

  1. EnumReportJobs

  2. GetReportJob

To commit the job, you must specify at least one report type, at least one namespace root, and the task name.

To run the job, you must specify at least one report type and namespace root.

Return to top

Community Additions

ADD
Show: