Scheduled Reports
Scheduled Reports
A scheduled report emails the output of up to six List commands — the same read-only commands you'd otherwise run yourself and read on screen — to a set of recipients on a recurring schedule. Use it to keep stakeholders who don't log into StorONE up to date: a weekly capacity summary to management, a daily list of snapshot status to an ops distribution list, and so on.
Only read-only List commands can be included in a report; a report can't perform any action. (For running action commands — whether on demand or in a saved, reusable sequence — see Automation.)
Creating a scheduled report
Using the web interface
- Open Administration > Scheduled Reports.
- Click Create.
- Fill in:
- Report Name — up to 25 characters.
- Recipients Emails — the email addresses to send the report to.
- Periodicity — how often to send it: Daily, Weekly, Monthly, Quarterly, or Yearly.
- Time To Send First Report — the date and time of the first send; it must be in the future. Later sends follow the same time, spaced out by the periodicity.
- Under Report Commands, add each
Listcommand (path and parameters) whose output should be included — up to six. - Confirm to create the report.
Using the CLI
scheduled_reports create --reportName=<name> --recipientsEmails=<name...> --periodicity=<name> --timeToSendFirstReport=<date> --commandPaths=<command_path...> [--commandParameters=<command_args...>]
| Option | Description |
|---|---|
--reportName=<name> |
Name of the report (25 characters or fewer). |
--recipientsEmails=<name...> |
Email addresses to receive the report. |
--periodicity=<name> |
How often to send the report: Daily, Weekly, Monthly, Quarterly, or Yearly. |
--timeToSendFirstReport=<date> |
Date and time to send the first report (must be in the future). |
--commandPaths=<command_path...> |
Paths of the List commands to include in the report (up to 6). |
--commandParameters=<command_args...> |
Parameters for each command in --commandPaths, in matching order. |
Examples
Email a weekly volume and capacity summary to two people, starting next Monday at 8 AM:
scheduled_reports create --reportName "Weekly Volumes" --recipientsEmails ops@example.com,manager@example.com --periodicity Weekly --timeToSendFirstReport "2026-09-28 08:00" --commandPaths "applications volumes list" --commandParameters "--capacity"
Email a daily report that bundles two commands — a volume list and an application list:
scheduled_reports create --reportName "Daily Overview" --recipientsEmails ops@example.com --periodicity Daily --timeToSendFirstReport "2026-09-23 07:00" --commandPaths "applications volumes list","applications list" --commandParameters "--details","--vols"
Editing a scheduled report
Changing Time To Send First Report restarts the send schedule from that new date/time. Supplying --recipientsEmails replaces the entire recipient list — any address you leave out is removed (the CLI will ask you to confirm if that would drop existing recipients); if you only want to add or remove a couple of addresses without retyping the whole list, use the dedicated commands below instead.
Using the web interface
- Open Administration > Scheduled Reports.
- Select the report and click Edit.
- Update the fields and/or the Report Commands you need.
- Confirm the change.
Using the CLI
scheduled_reports edit --reportName=<name> [--newReportName=<name>] [--recipientsEmails=<name...>] [--periodicity=<name>] [--timeToSendFirstReport=<date>] [--commandPaths=<command_path...> --commandParameters=<command_args...>]
| Option | Description |
|---|---|
--reportName=<name> |
The report to edit. |
--newReportName=<name> |
New name for the report (25 characters or fewer). |
--recipientsEmails=<name...> |
Email addresses to receive the report. Replaces the current list; recipients left out are removed. |
--periodicity=<name> |
How often to send the report: Daily, Weekly, Monthly, Quarterly, or Yearly. |
--timeToSendFirstReport=<date> |
New date and time for the first report (must be in the future). Changing it restarts the send schedule. |
--commandPaths=<command_path...> |
Paths of the List commands to include in the report (up to 6). |
--commandParameters=<command_args...> |
Parameters for each command in --commandPaths, in matching order. |
Examples
Change the periodicity of Weekly Volumes to Monthly:
scheduled_reports edit --reportName "Weekly Volumes" --periodicity Monthly
Rename Daily Overview and reset its schedule to start tomorrow morning:
scheduled_reports edit --reportName "Daily Overview" --newReportName "Morning Overview" --timeToSendFirstReport "2026-09-23 06:00"
Adding recipients
A CLI-only shortcut for adding email addresses to a report without retyping the full recipient list. Duplicate addresses are ignored.
scheduled_reports recipients_emails add --reportName=<name> --recipientsEmails=<name...>
| Option | Description |
|---|---|
--reportName=<name> |
The report to add recipients to. |
--recipientsEmails=<name...> |
Email addresses to add (duplicates are ignored). |
Example
scheduled_reports recipients_emails add --reportName "Weekly Volumes" --recipientsEmails newhire@example.com
Removing recipients
A CLI-only shortcut for removing email addresses from a report without retyping the full recipient list. A report must always keep at least one recipient.
scheduled_reports recipients_emails delete --reportName=<name> --recipientsEmails=<name...>
| Option | Description |
|---|---|
--reportName=<name> |
The report to remove recipients from. |
--recipientsEmails=<name...> |
Email addresses to remove. At least one recipient must remain. |
Example
scheduled_reports recipients_emails delete --reportName "Weekly Volumes" --recipientsEmails former.employee@example.com
Deleting a scheduled report
Using the web interface
- Open Administration > Scheduled Reports.
- Select the report and click Delete.
- Confirm the deletion.
Using the CLI
scheduled_reports delete --reportName=<name>
| Option | Description |
|---|---|
--reportName=<name> |
The report to delete. |
Example
scheduled_reports delete --reportName "Daily Overview"
Listing scheduled reports
Non-admin users only see the reports they created; admins see every report.
Using the web interface
Open Administration > Scheduled Reports. The list shows each report's recipients, periodicity, commands, and next send time.
Using the CLI
scheduled_reports list [--reportName=<name>]
| Option | Description |
|---|---|
--reportName=<name> |
Filter by report name. |
Examples
List every scheduled report you can see:
scheduled_reports list
Look up just the Weekly Volumes report:
scheduled_reports list --reportName "Weekly Volumes"
See also: Automation — saved sequences of action commands you run on demand, rather than read-only reports sent on a schedule.