sys.report

Generate a report containing multiple system data sections.

By default, the report includes all available sections: CPU load, crontab, hardware, memory and storage usage, network, Operating System, sensors, and timezone info.

JSON-RPC Request

{"jsonrpc":"2.0","id":1,"method":"sys.report","params":{"includes":"<includes>"}}

Request Parameters

Argument	Type	Description	Required	Default
`includes`	String	A comma-separated list of system information sections to include in the report. Accepted values: `uptime`, `timezone`, `cluster`, `docker`, `kvm`, `storage`, `cpu_load`, `memory`, `network`, `sensors`, `crontab`, `hardware`, `os`, `all`.	No	`all`

JSON-RPC Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "<report_output>"
}

RVC CLI Example

rvc sys report

Response

Report: Uptime
==============
Since....: 2026-04-12T04:03:37Z
Humanized: up 7 weeks, 3 days, 13 hours, 20 minutes
Report: Timezone
================
Report: Cluster
===============
                    Disabled         Blocked         Total
-----------------------------------------------------------
 Resources                 0               0            11
-----------------------------------------------------------
 Last Update                      Wed Jun  3 13:24:21 2026
 Last Change                      Thu Apr  2 08:34:37 2026
           |     User             root                    
           |     Client           cibadmin                
           |     Origin           sit0001red0             
 Option                                              Value
-----------------------------------------------------------
 Stonith                                           Enabled
 Symetric Cluster                                      Yes
 Maintenance Mode                                       No
 No Quorum Policy                                      Yes
 Node            Standby     Unclean     Resources Running
-----------------------------------------------------------
 sit0001red0       No          No                        4
 sit0001red1       No          No                        7
Report: Docker
==============
 Containers           Running  Paused  Stopped  Total
------------------------------------------------------
 Cluster Managed            0       0        1      1
 Non Cluster Managed        2       0        0      2
 All                        3       0        0      3
Docker Version: 18.06.3-ce
Images........: 3
Report: KVM
===========
QEMU 2.8.0 hypervisor
libvirt 3.0.0
 Virtual Machines     Running  Total
-------------------------------------
 Cluster Managed            0      1
 Non Cluster Managed        0      0
 All                        0      1
Report: Storage
===============
 Device     Mount Point                                                                                             Filesystem  Total Size  Used
-------------------------------------------------------------------------------------------------------------------------------------------------
 /dev/dm-1  /                                                                                                       ext4               92G   23%
 /dev/sda1  /boot                                                                                                   ext2              236M   27%
 udev       /dev                                                                                                    devtmpfs           10M    0%
 tmpfs      /dev/shm                                                                                                tmpfs             7.9G    1%
 tmpfs      /run                                                                                                    tmpfs             3.2G   11%
 tmpfs      /run/lock                                                                                               tmpfs             5.0M    0%
 tmpfs      /run/user/1095                                                                                          tmpfs             1.6G    0%
 tmpfs      /run/user/8051                                                                                          tmpfs             1.6G    0%
 tmpfs      /sys/fs/cgroup                                                                                          tmpfs             7.9G    0%
 tmpfs      /tmp                                                                                                    tmpfs             7.9G    0%
Report: CPU Load
================
 CPU Core      Usage
---------------------
 CPU0          0.00%
 CPU1          0.00%
 CPU2        100.00%
 CPU3          0.00%
 CPU4          2.46%
 CPU5          0.50%
 CPU6          0.00%
 CPU7          0.50%
---------------------
 Average      12.87%
Report: Memory
==============
Mem Total....: 16408480
Mem Free.....: 13916036
Mem Available: 14797460
Swap Cached..: 0
Swap Total...: 9764860
Swap Free....: 9764860
Report: Network
===============
 Interface        Received  Transmitted
----------------------------------------
 br-5d2bf827d9aa   0 Bytes      0 Bytes
 br0               2.59 GB      2.59 GB
 docker0           0 Bytes      0 Bytes
 eth0              2.90 GB      2.90 GB
 eth1              0 Bytes      0 Bytes
 eth2              9.60 GB      9.60 GB
 eth3              0 Bytes      0 Bytes
 lo               25.04 MB     25.04 MB
 veth0f285cb       0 Bytes      0 Bytes
 veth341d145       0 Bytes      0 Bytes
Report: Sensors
===============
 Name              Status               Reading Unit
----------------------------------------------------------
 12V               OK                     12.13 Volts
 3.3V AUX          OK                      3.27 Volts
 3.3VCC            OK                      3.25 Volts
 5V Dual           OK                      4.89 Volts
 5VCC              OK                      4.87 Volts
 CPU Temp          OK                        47 C
 Chassis Intru     OK                      0x00 
 DIMMA1 Temp       OK                        40 C
 DIMMA2 Temp       NS                        -- 
 DIMMB1 Temp       OK                        40 C
 DIMMB2 Temp       NS                        -- 
 FAN1              OK                     3,400 RPM
 FAN2              NS                        -- 
 FAN3              NS                        -- 
 Peripheral Temp   OK                        39 C
 System Temp       OK                        39 C
 VBAT              OK                      3.02 Volts
 VCCP              OK                      0.87 Volts
 VDIMM             OK                      1.33 Volts
 Status: nominal
Report: Crontab
===============
Puppet Generated At: 2025-03-27 15:54:40 -0400
Cron Entries.......: [
  Puppet Name.: run_puppet_script
  Cron Entries: [
    Command: /opt/reliant/bin/puppet-launcher.sh
    Minute.: 0,30
    Hour...: *
    Day....: *
    Month..: *
    Weekday: *
 ]
  Puppet Name.: mcollective_facts_yaml_refresh
  Cron Entries: [
    Command: '/opt/puppetlabs/puppet/bin/ruby' '/opt/puppetlabs/mcollective/plugins/mcollective/refresh_facts.rb' -o '/etc/choria/generated-facts.yaml' -p '/var/run/puppetlabs/mcollective-facts_refresh.pid' &> /dev/null
    Minute.: 9,19,29,39,49,59
    Hour...: *
    Day....: *
    Month..: *
    Weekday: *
 ]
]
Report: Hardware
================
Bios Date......: 11/22/2019
Product Name...: SYS-5018A-FTN4
Board Name.....: A1SRi
Board Vendor...: Supermicro
Sys Vendor.....: Supermicro
Product Version: 123456789
Product Family.: SMC X10
Bios Version...: 2.2
Bios Release...: N/A
Report: OS
==========
Hostname....: sit0001red0
Kernel......: Linux 4.9.0-0.bpo.11-amd64
Architecture: x86_64
Os Name.....: Debian
Os Release..: 8.11 jessie

To request specific sections, use the --includes flag with a comma-separated list of section names:

rvc sys report --includes uptime,memory,cpu_load