A salt interface to psutil, a system and process library. See http://code.google.com/p/psutil.
depends: |
|
---|
Return the boot time in number of seconds since the epoch began.
CLI Example:
Optionally specify a strftime format string. Use time_format='%c' to get a nicely-formatted locale specific date and time (i.e. Fri May 2 19:08:32 2014).
New in version 2014.1.4.
salt '*' ps.boot_time
Return the amount cached memory.
CLI Example:
salt '*' ps.cached_physical_memory
Return the percent of time the CPU is busy.
CLI Example:
salt '*' ps.cpu_percent
Return the percent of time the CPU spends in each state, e.g. user, system, idle, nice, iowait, irq, softirq.
CLI Example:
salt '*' ps.cpu_times
Return disk I/O statisitics.
CLI Example:
salt '*' ps.disk_io_counters
Return a list of disk partitions plus the mount point, filesystem and usage statistics.
CLI Example:
salt '*' ps.disk_partition_usage
Return a list of disk partitions and their device, mount point, and filesystem type.
CLI Example:
salt '*' ps.disk_partitions
Given a path, return a dict listing the total available space as well as the free space, and used space.
CLI Example:
salt '*' ps.disk_usage /home
Return a list of process ids (PIDs) for all running processes.
CLI Example:
salt '*' ps.get_pid_list
Return logged-in users.
CLI Example:
salt '*' ps.get_users
Kill a proccess by PID.
salt 'minion' ps.kill_pid pid [signal=signal_number]
Example:
Send SIGKILL to process with PID 2000:
salt 'minion' ps.kill_pid 2000 signal=9
Return network I/O statisitics.
CLI Example:
salt '*' ps.network_io_counters
Return the number of CPUs.
CLI Example:
salt '*' ps.num_cpus
Return the pids for processes matching a pattern.
If full is true, the full command line is searched for a match, otherwise only the name of the command is searched.
salt '*' ps.pgrep pattern [user=username] [full=(true|false)]
Examples:
Find all httpd processes on all 'www' minions:
salt 'www.*' ps.pgrep httpd
Find all bash processes owned by user 'tom':
salt '*' ps.pgrep bash user=tom
Return the amount of physical memory buffers.
CLI Example:
salt '*' ps.physical_memory_buffers
Return a dict that describes free and available physical memory.
CLI Examples:
salt '*' ps.physical_memory_usage
Kill processes matching a pattern.
salt '*' ps.pkill pattern [user=username] [signal=signal_number] \
[full=(true|false)]
Examples:
Send SIGHUP to all httpd processes on all 'www' minions:
salt 'www.*' ps.pkill httpd signal=1
Send SIGKILL to all bash processes owned by user 'tom':
salt '*' ps.pkill bash signal=9 user=tom
Return a list of top CPU consuming processes during the interval. num_processes = return the top N CPU consuming processes interval = the number of seconds to sample CPU usage over
CLI Examples:
salt '*' ps.top
salt '*' ps.top 5 10
Return the total number of bytes of physical memory.
CLI Example:
salt '*' ps.total_physical_memory
Return a dict that describes free and available memory, both physical and virtual.
CLI Example:
salt '*' ps.virtual_memory_usage
Current Salt release: 2014.1.6
Docs for previous releases on salt.rtfd.org.