1. Home
  2. Docs
  3. ClusterControl
  4. User Guide (CLI)
  5. s9s-report


Table of Contents

Manage operational reports.


s9s report {command} {options}


Name, shorthand Description
−−cat Prints the report text to the standard output.
−−create Creates and prints a new report. Please provide the --type command-line option with the report type (that was chosen from the template list printed with the --list-templates option) and the --cluster-id with the cluster ID.
−−delete Deletes a report that already exists. The report ID should be used to specify which report deleting.
−−list Lists the reports that already created.
−−list-templates Lists the report templates showing what kind of reports can be created. This command-line option is usually used together with the --long option.


Name, shorthand Description
−−cluster-id=ID This command-line option passes the numerical ID of the cluster.
−report-id=ID This command-line option passes the numerical ID of the report to manage. When a report is deleted (--delete option) or printed (--cat option) this option is mandatory.
−−type=NAME This command-line option controls the type of report. Use the --list-templates to list what types are available.


Lists already created reports for cluster ID 1:

$ s9s report \
        --list \
        --long \

Print the report ID 1 for cluster ID 1:

$ s9s report \
        --cat \
        --report-id=1 \

Create a database growth report for cluster ID 1:

$ s9s report \
        --create \
        --type=dbgrowth \

Delete an operation report with report ID 11:

$ s9s report \
        --delete \

Print the supported templates that can be used with type value when creating a new report:

$ s9s report \
        --list-templates \
Was this article helpful to you? Yes No