Recon

Recon is a type of an order that returns either plain str or MachineFacts object.

Warning

As everything in this library, these approaches were only tested on Ubuntu and Raspbian. Do not rely on it too much. Nevertheless, recon is read-only and expected to be non-destructive.

Catalog

HOSTNAME - hostname of a machine

hostname: office-1

CPU - architecture, number of cores and model of the CPU

cpu:
  arch: x86_64
  cores: 8
  model: Intel(R) Core(TM) i5-8265U CPU @ 1.60GHz

RAM - available and total RAM in bytes

ram:
  available: 185180
  total: 7863628

OS - name and version of the OS

os:
  name: Ubuntu
  version: 20.04.4 LTS (Focal Fossa)

Machine Facts

class MachineFacts(Model):
    hostname: Optional[str] = None
    cpu: Optional[Processor] = None
    ram: Optional[RAM] = None
    os: Optional[OS] = None

Hostname

A plain string value returned from a hostname command.

OS

class OS(MachineInfo):
    name: str
    version: str

Parses info in output of

cat /etc/os-release

CPU

CPU structures information about CPU of the target machine:

class Processor(MachineInfo):
    model: str
    cores: int
    arch: str

It gets it by executing and parsing three commands:

cat /proc/cpuinfo && getconf _NPROCESSORS_ONLN && arch

Memory

Memory is a parent for all parameters following a memory format: having total bytes and available bytes

class Memory(MachineInfo):
    total: int
    available: int

RAM

class RAM(Memory):
    pass

Gets ram by executing free command.

Disk

class Disk(Memory):
    pass

Not implemented