System Information

Tools for retrieving system, CPU, memory, disk, and hardware information.

Remote execution

All tools on this page accept an optional host parameter (string) to execute the command on a remote machine via SSH instead of locally. See SSH Configuration for details.

get_cpu_information

Get CPU information.

Returns:

• model (string)
• logical_cores (integer)
• physical_cores (integer)
• frequency_mhz (number)
• load_avg_1m (number)
• load_avg_5m (number)
• load_avg_15m (number)
• cpu_line (string)

get_disk_usage

Get detailed disk space information including size, mount points, and utilization.

Returns:

• filesystems (array of object)
  • source (string or null)
  • fstype (string or null)
  • size (string or null)
  • used (string or null)
  • avail (string or null)
  • use% (string or null)
  • target (string or null)

get_hardware_information

Get hardware information such as CPU details, PCI devices, USB devices, and hardware information from DMI.

get_memory_information

Get detailed memory including physical and swap.

Returns:

• ram (object): Parsed memory information from free command.
  • total (integer)
  • used (integer)
  • free (integer)
  • shared (integer)
  • buffers (integer)
  • cached (integer)
  • available (integer)
• swap (object or null)
  • total (integer)
  • used (integer)
  • free (integer)

get_system_information

Get basic system information such as operating system, distribution, kernel version, uptime, and last boot time.

Returns:

• hostname (string)
• os_name (string)
• os_version (string)
• kernel (string)
• arch (string)
• uptime (string)
• boot_time (string)