salt.modules.status¶

Module for returning various status data about a minion. These data can be useful for compiling into stats later.

salt.modules.status.all_status()¶

Return a composite of all status data and info for this minion. Warning: There is a LOT here!

CLI Example:

salt '*' status.all_status

salt.modules.status.cpuinfo()¶

Return the CPU info for this minion

CLI Example:

salt '*' status.cpuinfo

salt.modules.status.cpustats()¶

Return the CPU stats for this minion

CLI Example:

salt '*' status.cpustats

salt.modules.status.custom()¶

Return a custom composite of status data and info for this minion, based on the minion config file. An example config like might be:

status.cpustats.custom: [ 'cpu', 'ctxt', 'btime', 'processes' ]

Where status refers to status.py, cpustats is the function where we get our data, and custom is this function It is followed by a list of keys that we want returned.

This function is meant to replace all_status(), which returns anything and everything, which we probably don't want.

By default, nothing is returned. Warning: Depending on what you include, there can be a LOT here!

CLI Example:

salt '*' status.custom

salt.modules.status.diskstats()¶

Return the disk stats for this minion

CLI Example:

salt '*' status.diskstats

salt.modules.status.diskusage(*args)¶

Return the disk usage for this minion

Usage:

salt '*' status.diskusage [paths and/or filesystem types]

CLI Example:

salt '*' status.diskusage         # usage for all filesystems
salt '*' status.diskusage / /tmp  # usage for / and /tmp
salt '*' status.diskusage ext?    # usage for ext[234] filesystems
salt '*' status.diskusage / ext?  # usage for / and all ext filesystems

salt.modules.status.loadavg()¶

Return the load averages for this minion

CLI Example:

salt '*' status.loadavg

salt.modules.status.master(master=None, connected=True)¶

New in version 2014.7.0.

Fire an event if the minion gets disconnected from its master. This function is meant to be run via a scheduled job from the minion. If master_ip is an FQDN/Hostname, is must be resolvable to a valid IPv4 address.

CLI Example:

salt '*' status.master

salt.modules.status.meminfo()¶

Return the memory info for this minion

CLI Example:

salt '*' status.meminfo

salt.modules.status.netdev()¶

Return the network device stats for this minion

CLI Example:

salt '*' status.netdev

salt.modules.status.netstats()¶

Return the network stats for this minion

CLI Example:

salt '*' status.netstats

salt.modules.status.nproc()¶

Return the number of processing units available on this system

CLI Example:

salt '*' status.nproc

salt.modules.status.pid(sig)¶

Return the PID or an empty string if the process is running or not. Pass a signature to use to find the process via ps. Note you can pass a Python-compatible regular expression to return all pids of processes matching the regexp.

CLI Example:

salt '*' status.pid <sig>

salt.modules.status.procs()¶

Return the process data

CLI Example:

salt '*' status.procs

salt.modules.status.uptime()¶

Return the uptime for this minion

CLI Example:

salt '*' status.uptime

salt.modules.status.version()¶

Return the system version for this minion

CLI Example:

salt '*' status.version

salt.modules.status.vmstats()¶

Return the virtual memory stats for this minion

CLI Example:

salt '*' status.vmstats

salt.modules.status.w()¶

Return a list of logged in users for this minion, using the w command

CLI Example:

salt '*' status.w