server Facts¶

`server.Arch`¶

host.get_fact(Arch)

Returns the system architecture according to uname.

`server.AuthorizedKeys`¶

host.get_fact(AuthorizedKeys, user, path=None)

Returns the SSH public keys listed in a user's ~/.ssh/authorized_keys file as a list of full key strings. Empty lines and lines starting with # are skipped; the file's order is preserved.

[
    "ssh-ed25519 AAAAC3Nz... user@host",
    "ssh-rsa AAAAB3Nz... other@host",
]

`server.Command`¶

host.get_fact(Command, command)

Returns the raw output lines of a given command.

`server.Date`¶

host.get_fact(Date)

Returns the current datetime on the server.

`server.EtcHosts`¶

host.get_fact(EtcHosts, path='/etc/hosts')

Returns /etc/hosts (or the file at path) parsed as a mapping of IP address to the list of hostnames declared on the matching lines. Comments and empty lines are ignored; when the same IP is listed more than once, hostnames are merged in file order.

{
    "127.0.0.1": ["localhost", "localhost.localdomain"],
    "::1": ["localhost"],
    "192.168.1.10": ["db.internal"],
}

`server.Groups`¶

host.get_fact(Groups)

Returns a list of groups on the system.

`server.HasGui`¶

host.get_fact(HasGui)

Returns a boolean indicating the remote side has GUI capabilities. Linux only.

`server.Home`¶

host.get_fact(Home, user='')

Returns the home directory of the given user, or the current user if no user is given.

`server.Hostname`¶

host.get_fact(Hostname)

Returns the current hostname of the server.

`server.Kernel`¶

host.get_fact(Kernel)

Returns the kernel name according to uname.

`server.KernelModules`¶

host.get_fact(KernelModules)

Returns a dictionary of kernel module name -> info.

{
    "module_name": {
        "size": 0,
        "instances": 0,
        "state": "Live",
    },
}

`server.KernelVersion`¶

host.get_fact(KernelVersion)

Returns the kernel version according to uname.

`server.Last`¶

host.get_fact(Last)

Returns login records parsed from last as a list of dicts.

Parsing is intentionally light: time holds the raw trailing string from the last output (e.g. "Thu Apr 17 14:00 still logged in") so that callers can re-parse the date format that matches their system if needed.

[
    {
        "user": "alice",
        "tty": "pts/0",
        "host": "192.168.1.5",
        "time": "Thu Apr 17 14:00   still logged in",
    },
    {
        "user": "reboot",
        "tty": "system boot",
        "host": "6.19.10-arch1-1",
        "time": "Thu Apr 17 11:00 - 12:00  (01:00)",
    },
]

`server.Lastb`¶

host.get_fact(Lastb)

Returns failed login records parsed from lastb (/var/log/btmp).

Output shape matches :class:Last; see that fact for details. lastb usually requires root to read /var/log/btmp.

`server.LinuxDistribution`¶

host.get_fact(LinuxDistribution)

Returns a dict of the Linux distribution version. Ubuntu, Debian, CentOS, Fedora & Gentoo currently. Also contains any key/value items located in release files.

{
    "name": "Ubuntu",
    "major": 20,
    "minor": 04,
    "release_meta": {
        "CODENAME": "focal",
        "ID_LIKE": "debian",
        ...
    }
}

`server.LinuxGui`¶

host.get_fact(LinuxGui)

Returns a list of available Linux GUIs.

`server.LinuxName`¶

host.get_fact(LinuxName)

Returns the name of the Linux distribution. Shortcut for host.get_fact(LinuxDistribution)['name'].

`server.LoadAverage`¶

host.get_fact(LoadAverage)

Returns the system load average keyed by window (1, 5 and 15 minutes).

Reads /proc/loadavg when available (Linux) and falls back to parsing uptime output on systems without procfs (e.g. FreeBSD).

{
    "1": 0.12,
    "5": 0.21,
    "15": 0.22,
}

`server.Locales`¶

host.get_fact(Locales)

Returns installed locales on the target host.

["C.UTF-8", "en_US.UTF-8"]

`server.LsbRelease`¶

host.get_fact(LsbRelease)

Returns a dictionary of release information using lsb_release.

{
    "id": "Ubuntu",
    "description": "Ubuntu 18.04.2 LTS",
    "release": "18.04",
    "codename": "bionic",
    ...
}

`server.MacosVersion`¶

host.get_fact(MacosVersion)

Returns the installed MacOS version.

`server.Mounts`¶

host.get_fact(Mounts)

Returns a dictionary of mounted filesystems and information.

{
    "/": {
        "device": "/dev/mv2",
        "type": "ext4",
        "options": [
            "rw",
            "relatime"
        ]
    },
}

`server.Os`¶

host.get_fact(Os)

Returns the OS name according to uname.

Warning

This fact is deprecated/renamed, please use the server.Kernel fact.

`server.OsRelease`¶

host.get_fact(OsRelease)

Returns a dictionary of release information stored in /etc/os-release.

{
  "name": "EndeavourOS",
  "pretty_name": "EndeavourOS",
  "id": "endeavouros",
  "id_like": "arch",
  "build_id": "2024.06.25",
  ...
}

`server.OsVersion`¶

host.get_fact(OsVersion)

Returns the OS version according to uname.

Warning

This fact is deprecated/renamed, please use the server.KernelVersion fact.

`server.Path`¶

host.get_fact(Path)

Returns the path environment variable of the current user.

`server.Port`¶

host.get_fact(Port, port, protocol='tcp')

Returns the process occupying a port and its PID.

Supports TCP and UDP protocols via the protocol argument (default "tcp"). Uses ss on Linux (with netstat fallback) and sockstat on FreeBSD.

# TCP (default)
host.get_fact(Port, port=80)
# UDP
host.get_fact(Port, port=53, protocol="udp")

`server.Ports`¶

host.get_fact(Ports)

Returns a list of all listening ports with their processes and PIDs.

Uses ss on Linux (with netstat fallback) and sockstat on FreeBSD.

host.get_fact(Ports)

`server.Processes`¶

host.get_fact(Processes, pid=None)

Returns a dictionary of running processes keyed by PID.

{
    1: {
        "user": "root",
        "state": "Ss",
        "cpu_percent": 0.0,
        "mem_percent": 0.1,
        "command": "init",
        "args": "/sbin/init",
    },
}

`server.RebootRequired`¶

host.get_fact(RebootRequired)

Returns a boolean indicating whether the system requires a reboot.

On Linux systems:

Checks /var/run/reboot-required and /var/run/reboot-required.pkgs
On Alpine Linux, compares installed kernel with running kernel

On FreeBSD systems:

Compares running kernel version with installed kernel version

`server.SecurityLimits`¶

host.get_fact(SecurityLimits)

Returns a list of security limits on the target host.

[
    {
        "domain": "*",
        "limit_type": "soft",
        "item": "nofile",
        "value": "1048576"
    },
    {
        "domain": "*",
        "limit_type": "hard",
        "item": "nofile",
        "value": "1048576"
    },
    {
        "domain": "root",
        "limit_type": "soft",
        "item": "nofile",
        "value": "1048576"
    },
    {
        "domain": "root",
        "limit_type": "hard",
        "item": "nofile",
        "value": "1048576"
    },
    {
        "domain": "*",
        "limit_type": "soft",
        "item": "memlock",
        "value": "unlimited"
    },
    {
        "domain": "*",
        "limit_type": "hard",
        "item": "memlock",
        "value": "unlimited"
    },
    {
        "domain": "root",
        "limit_type": "soft",
        "item": "memlock",
        "value": "unlimited"
    },
    {
        "domain": "root",
        "limit_type": "hard",
        "item": "memlock",
        "value": "unlimited"
    }
]

`server.Selinux`¶

host.get_fact(Selinux)

Discovers the SELinux related facts on the target host.

{
    "mode": "enabled",
}

`server.Sysctl`¶

host.get_fact(Sysctl, keys=None)

Returns a dictionary of sysctl settings and values.

{
    "fs.inotify.max_queued_events": 16384,
    "fs.inode-state": [
        44565,
        360,
    ],
}

`server.Timezone`¶

host.get_fact(Timezone)

Returns the current system timezone (e.g. Europe/Amsterdam).

`server.TmpDir`¶

host.get_fact(TmpDir)

Returns the temporary directory of the current server.

According to POSIX standards, checks environment variables in this order: 1. TMPDIR (if set and accessible) 2. TMP (if set and accessible) 3. TEMP (if set and accessible) 4. Falls back to empty string

`server.Uptime`¶

host.get_fact(Uptime)

Returns the number of seconds the system has been up.

`server.User`¶

host.get_fact(User)

Returns the name of the current user.

`server.Users`¶

host.get_fact(Users)

Returns a dictionary of users -> details.

{
    "user_name": {
        "comment": "Full Name",
        "home": "/home/user_name",
        "shell": "/bin/bash,
        "group": "main_user_group",
        "groups": [
            "other",
            "groups"
        ],
        "uid": user_id,
        "gid": main_user_group_id,
        "lastlog": last_login_time,
        "password": encrypted_password,
    },
}

`server.Which`¶

host.get_fact(Which, command)

Returns the path of a given command according to command -v, if available.

server Facts¶

server.Arch¶

server.AuthorizedKeys¶

server.Command¶

server.Date¶

server.EtcHosts¶

server.Groups¶

server.HasGui¶

server.Home¶

server.Hostname¶

server.Kernel¶

server.KernelModules¶

server.KernelVersion¶

server.Last¶

server.Lastb¶

server.LinuxDistribution¶

server.LinuxGui¶

server.LinuxName¶

server.LoadAverage¶

server.Locales¶

server.LsbRelease¶

server.MacosVersion¶

server.Mounts¶

server.Os¶

server.OsRelease¶

server.OsVersion¶

server.Path¶

server.Port¶

server.Ports¶

server.Processes¶

server.RebootRequired¶

server.SecurityLimits¶

server.Selinux¶

server.Sysctl¶

server.Timezone¶

server.TmpDir¶

server.Uptime¶

server.User¶

server.Users¶

server.Which¶