Smos Logo Smos

A comprehensive self-management system

Custom reports

Documentation about the smos-query report command, for running prepared reports

This command, without arguments, shows you an overview of the custom reports you have configured. With an argument, it will show you that report.

Reference

Arguments

Usage: smos-query report [REPORT] [--pretty | --yaml | --json | --pretty-json]
  Run preconfigured reports

Available options:
  REPORT                   The preconfigured report to run
  --pretty                 pretty text
  --yaml                   Yaml
  --json                   single-line JSON
  --pretty-json            pretty JSON
  -h,--help                Show this help text

Environment

This command does not use any extra environment variables.

Configuration

# Configuration
report: # optional
  # or <null>
  # PreparedReportConfiguration
  reports: # optional
    # or <null>
    # Custom reports
    <key>: # PreparedReport
      description: # optional
        # or <null>
        # A description of the report
        <string>
      filter: # optional
        # or <null>
        # The entry filter to get the results in the report
        <string>
      columns: # optional
        - # or <null>
          # The columns of the report
          <string>
      sorter: # optional
        # or <null>
        # The sorter to sort the rows of the report by
        <string>
      hide-archive: # optional
        # or <null>
        # Whether to consider the archive for the report
        <boolean>