Storrept reports add

  • Article

Applies To: Windows Server 2008, Windows Server 2008 R2

Adds a report to a scheduled task.

Note

To use this command, you must be logged on as an administrator or a member of the Administrators group.

Important

Before you can add a storage report to a task, you must create the task. To create tasks, you use the schtasks command. For more information, see Creating a task for File Server Resource Manager reports by using the schtasks command.

For examples of how to use this command, see Examples.

Syntax

storrept reports add /task:<TaskName> /scope:"<Scope>" /add-report:<Type>
   [/format:"<FormatList>"] [/mailto=<EmailList>] [/name:"<Name>"] 
   [/filename:<Pattern>] [/minsize:<Size>[kb|mb|gb]] [/maxage:<Age>] 
   [/minage:<Age>] [/minuse:<Usage>] [/owner:"<OwnerList>"] 
   [/filegroup:"<FgList>"] [/quiet] [/remote:<ComputerName>]

Parameters

Parameter Description

/task:<TaskName>

Specifies the name of the scheduled task with which the report will be associated.

/scope:"<Scope>"

Gathers data for the report from Scope, which is a list of volume and folder paths. Use a pipe character (|) to separate multiple paths, without leaving blank spaces.

/add-report:<Type>

Specifies the report to be scheduled. Type must be one of the following:

  • DuplicateFiles — Lists files that appear to be duplicates (files with the same size and last-modified time).

  • Export — Includes all the unfiltered data gathered during a file system scan. You can use this data to perform customized storage analysis.

  • FileScreenAudit —- Lists file screening events that have occurred on the server for a specified number of days. Use this report to identify users or applications that violate screening policies.

    Important
    Before you schedule a File Screening Audit report, you must enable the recording of file screening activity in the auditing database by using the Dirquota admin options command with the /screenaudit:enabled parameter. You can also enable file screening auditing by using the File Server Resource Manager snap-in (in the main node, click Configure Options).

  • FilesByFileGroup — Lists files that belong to specified file groups.

  • FilesByOwner — Lists files, grouped by the users who own them.

  • LargeFiles — Lists files that are of a specified size or larger.

  • LeastRecentlyAccessed — Lists files that have not been accessed for a specified number of days.

  • MostRecentlyAccessed — Lists files that have been accessed within a specified number of days.

  • QuotaUsage — Lists quotas for which the quota usage is higher than a specified percentage. Use this report to identify quotas with high usage levels so that appropriate action can be taken.

    Note

    The Quota Usage report includes quotas that were created for volumes and folders in File Server Resource Manager only.

/format:"<FormatList>"

Specifies the format or formats in which the reports will be generated. Use a pipe character (|) to separate multiple report formats, without leaving blank spaces. FormatList must be one or more of the following values:

  • html — Generates the report in HyperText Markup Language (HTML) format.

  • dhtml — Generates the report in Dynamic HTML (DHTML) format.

  • xml — Generates the report in Extensible Markup Language (XML) format.

  • csv — Generates the report in comma-separated values (CSV) format.

  • txt — Generates the report in text format.

If you do not specify a report format, reports are generated in DHTML and XML formats by default, except for the Export report, whose default format is XML. Also note that you can generate the Export report only in CSV or XML format.

/mailto=<EmailList>

Specifies the list of e-mail addresses for the recipients of the reports. Use a semicolon to separate multiple e-mail addresses, without leaving blank spaces. All e-mail addresses must be in the format account@domain.

Note

You can use the [Admin Email] variable instead of an e-mail address to send the reports to the default e-mail addresses for the administrators. To display and configure the default e-mail addresses, use the Dirquota admin options command.

/name:"<Name>"

Specifies a new name for the report. This name will be used for the files and folders that will be created when the report is generated. If you do not specify a report name, the default report name will be used. To see the default name for a scheduled report, use the Storrept reports list command.

/filename:<Pattern>

Specifies the file name pattern for the report type specified in the /add-report parameter. Only those files that have a file name that matches Pattern will be included in the report. You can include wildcard characters in the Pattern value (for example, *.exe).

If you do not specify Pattern, the default pattern will be used. To display the default pattern, use the Storrept admin defaults command. The default pattern for each report type will be listed under Filter. If Filter is not listed for a report type, files with any file name pattern are included in that report.

Note that this parameter is valid only when the Type value for the /add-report parameter is FilesByOwner, LargeFiles, LeastRecentlyAccessed, or MostRecentlyAccessed.

/minsize:<Size>[kb|mb|gb]

Specifies the minimum size of the files that will be listed in the Large Files report. All files of size Size or larger will be listed. By default, Size is denoted in kilobytes (KB), but you can append kb, mb, or gb to specify the unit.

If you do not specify Size, the default minimum file size will be used. To display the default minimum file size, use the Storrept admin defaults command.

Note that this parameter is valid only when the Type value for the /add-report parameter is LargeFiles.

/maxage:<Age>

Specifies the maximum number of days since a file was last accessed. All files that were accessed Age days ago or more recently will be included in the Most Recently Accessed Files report.

If you do not specify Age, the default maximum number of days will be used. To display the default maximum number of days, use the Storrept admin defaults command.

Note that this parameter is valid only when the Type value for the /add-report parameter is MostRecentlyAccessed.

/minage:<Age>

Specifies the minimum number of days since a file was last accessed or since a file screening event occurred. All files that were accessed Age days ago and before will be included in the Least Recently Accessed Files report. All file screening audit events that happened Age days ago and before will be included in the File Screening Audit report. To specify all file screening events, set Age to 0 (zero).

If you do not specify Age, the default minimum number of days will be used. To display the default minimum number of days, use the Storrept admin defaults command.

Note that this parameter is valid only when the Type value for the /add-report parameter is either LeastRecentlyAccessed or FileScreenAudit.

/minuse:<Usage>

Specifies the minimum percentage of quota usage of the quotas that will be listed in the Quota Usage report. To specify all quotas, set Usage to 0 (zero).

If you do not specify Usage, the default minimum percentage of quota usage will be used. To display the default minimum percentage of quota usage, use the Storrept admin defaults command.

Note that this parameter is valid only when the Type value for the /add-report parameter is QuotaUsage.

/owner:"<OwnerList>"

Specifies the list of file owners for the File Screen Audit report or the Files by Owner report. OwnerList can be a list of one or more user names separated by a pipe character (|), enclosed in quotation marks. To specify all owners, set FgList to "".

If you do not specify OwnerList, the default list of owners will be included in the report. To display the default list of owners, use the Storrept admin defaults command.

Note that this parameter is valid only when the Type value for the /add-report parameter is either FileScreenAudit or FilesByOwner.

/filegroup:"<FgList>"]

Specifies a list of file groups for the Files by File Group report. FgList is a list of one or more file group names separated by a pipe character (|), enclosed in quotation marks. To display a list of file groups, use the Filescrn filegroup list command. To specify all file groups, set FgList to "".

If you do not specify a list of file groups, the default file groups for the Files by File Group report will be included. To display the list of default file groups, use the Storrept admin defaults command.

Note that this parameter is valid only when the Type value for the /add-report parameter is FilesByFileGroup.

/quiet

Schedules the storage report task without warning. By default, you are prompted to confirm that you want to schedule the storage report task.

/remote:<ComputerName>

Performs the operation on the remote computer ComputerName.

Remarks

  • The shortest sequence of characters that uniquely identifies a parameter can be used as an abbreviation. For example, the following two commands are equivalent:

    storrept r a /t:largefilestask /s:"d:\|e:\" /a:"LargeFiles"
storrept reports add /task:largefilestask /scope:"d:\|e:\" /add-report:"LargeFiles"

  • To perform operations on a remote computer by using the **/remote:**ComputerName parameter:

    • You must be logged on with a domain account that is a member of the Administrators group on both the local computer and the remote computer.

    • The remote computer must be running Windows Server 2008, and File Server Resource Manager must be installed.

    • The Remote File Server Resource Manager Management exception on the remote computer must be enabled. You enable this exception by using Windows Firewall in Control Panel.

Examples

  • To add to the scheduled LargeFilesTask task a Large Files report for drives D: and E:, and have that reports list only files the have the .zip file name extension and that are 50 MB or larger, type:

    storrept reports add /task:largefilestask /scope:"d:\|e:\" /add-report:largefiles /filename:"*.zip" /minsize:50mb

  • To add to the scheduled FSRMReport task a Quota Usage report for volumes C: and D: in HTML format, and have that report sent to the admin@contoso.com and storage.quota@contoso.com e-mail addresses, type:

    storrept reports add /task:fsrmreport /scope:"c:\|d:\" /add-report:quotausage /format:"html" /mailto:admin@contoso.com;storage.quota@contoso.com

Additional references

Command-Line Syntax Key

Storrept reports