You are viewing docs from the master branch, some of these features are not yet released.

execution modules¶

Virtual modules

`aix_group`	Manage groups on Solaris
`aix_shadow`	Manage account locks on AIX systems
`aixpkg`	Package support for AIX
`aliases`	Manage the information in the aliases file
`alternatives`	Support for Alternatives system
`ansiblegate`	Ansible Support
`apache`	Support for Apache
`apf`	Support for Advanced Policy Firewall (APF) maintainer Mostafa Hussein <mostafa.hussein91@gmail.com> maturity new depends python-iptables platform Linux
`aptpkg`	Support for APT (Advanced Packaging Tool)
`archive`	A module to wrap (non-Windows) archive calls
`arista_pyeapi`	Arista pyeapi
`artifactory`	Module for fetching artifacts from Artifactory
`asymmetric`	New in version 3008.0.
`at`	Wrapper module for at(1)
`at_solaris`	Wrapper for at(1) on Solaris-like systems
`baredoc`	Baredoc walks the installed module and state directories and generates dictionaries and lists of the function names and their arguments.
`bcache`	Module for managing BCache sets
`beacons`	Module for managing the Salt beacons on a minion
`bridge`	Module for gathering and managing bridging information
`cassandra_cql`	Cassandra Database Module
`celery`	Support for scheduling celery tasks.
`chef`	Execute chef in server or solo mode
`chocolatey`	A module that wraps calls to the Chocolatey package manager (http://chocolatey.org)
`chronos`	Module providing a simple management interface to a chronos cluster.
`chroot`	Module for chroot :maintainer: Alberto Planas <aplanas@suse.com> :maturity: new :depends: None :platform: Linux
`cloud`	Salt-specific interface for calling Salt Cloud directly
`cmdmod`	A module for shelling out.
`config`	Return config information
`cp`	Minion side functions for salt-cp
`cron`	Work with cron
`cryptdev`	Salt module to manage Unix cryptsetup jobs and the crypttab file
`data`	Manage a local persistent data structure that can hold any arbitrary data specific to the minion
`debconfmod`	Support for Debconf
`debian_ip`	The networking module for Debian-based distros
`debian_service`	Service support for Debian systems (uses update-rc.d and /sbin/service)
`debuild_pkgbuild`	Debian Package builder system
`defaults`	Module to work with salt formula defaults files
`devinfo`	Module for devinfo :maintainer: Alberto Planas <aplanas@suse.com> :maturity: new :depends: None :platform: Linux
`devmap`	Device-Mapper module
`dig`	Compendium of generic DNS utilities.
`disk`	Module for managing disks and blockdevices
`dnsutil`	Compendium of generic DNS utilities.
`dpkg_lowpkg`	Support for DEB packages
`dummyproxy_pkg`	Package support for the dummy proxy used by the test suite
`dummyproxy_service`	Provide the service module for the dummy proxy used in integration tests
`environ`	Support for getting and setting the environment variables of the current salt process.
`etcd_mod`	Execution module to work with etcd
`ethtool`	Module for running ethtool command
`event`	Use the Salt Event System to fire events from the master to the minion and vice-versa.
`extfs`	Module for managing ext2/3/4 file systems
`file`	Manage information about regular files, directories, and special files on the minion, set/read user, group, mode, and data
`firewalld`	Support for firewalld.
`git`	Support for the Git SCM
`gpg`	Manage GPG keychains, add keys, create keys, retrieve keys from keyservers.
`grains`	Return/control aspects of the grains data
`groupadd`	Manage groups on Linux, OpenBSD and NetBSD
`hashutil`	A collection of hashing and encoding functions
`highstate_doc`	This module renders highstate configuration into a more human readable format.
`hosts`	Manage the information in the hosts file
`http`	Module for making various web calls.
`idem`	Idem Support
`incron`	Work with incron
`ini_manage`	Edit ini files
`iosconfig`	Cisco IOS configuration manipulation helpers
`ipset`	Support for ipset
`iptables`	Support for iptables
`iwtools`	Support for Wireless Tools for Linux
`jinja`	Module for checking jinja maps and verifying the result of loading JSON/YAML files
`junos`	Module to interact with Junos devices.
`kernelpkg_linux_apt`	Manage Linux kernel packages on APT-based systems
`kernelpkg_linux_yum`	Manage Linux kernel packages on YUM-based systems
`key`	Functions to view the minion's public key information
`keyboard`	Module for managing keyboards on supported POSIX-like systems using systemd, or such as Redhat, Debian and Gentoo.
`kmod`	Module to manage Linux kernel modules
`linux_acl`	Support for Linux File Access Control Lists
`linux_ip`	The networking module for Non-RH/Deb Linux distros
`linux_lvm`	Support for Linux LVM2
`linux_service`	If Salt's OS detection does not identify a different virtual service module, the minion will fall back to using this basic module, which simply wraps sysvinit scripts.
`linux_shadow`	Manage the shadow file on Linux systems
`linux_sysctl`	Module for viewing and modifying sysctl parameters
`localemod`	Module for managing locales on POSIX-like systems.
`locate`	Module for using the locate utilities
`logmod`	On-demand logging
`logrotate`	Module for managing logrotate.
`mac_assistive`	This module allows you to manage assistive access on macOS minions with 10.9+
`mac_brew_pkg`	Homebrew for macOS
`mac_desktop`	macOS implementations of various commands in the "desktop" interface
`mac_group`	Manage groups on Mac OS 10.7+
`mac_keychain`	Install certificates into the keychain on Mac OS
`mac_pkgutil`	Installer support for macOS.
`mac_portspkg`	Support for MacPorts under macOS.
`mac_power`	Module for editing power settings on macOS
`mac_service`	The service module for macOS
`mac_shadow`	Manage macOS local directory passwords and policies
`mac_softwareupdate`	Support for the softwareupdate command on MacOS.
`mac_sysctl`	Module for viewing and modifying sysctl parameters
`mac_system`	System module for sleeping, restarting, and shutting down the system on Mac OS X
`mac_timezone`	Module for editing date/time settings on macOS
`mac_user`	Manage users on Mac OS 10.7+
`mac_xattr`	This module allows you to manage extended attributes on files or directories
`macdefaults`	Set defaults settings on macOS.
`macpackage`	Install pkg, dmg and .app applications on macOS minions.
`match`	The match module allows for match routines to be run and determine target specs
`mdadm_raid`	Salt module to manage RAID arrays with mdadm
`mine`	The function cache system allows for data to be stored on the master so it can be easily read by other minions
`minion`	Module to provide information about minions
`mod_random`	Provides access to randomness generators.
`mount`	Salt module to manage Unix mounts and the fstab file
`mysql`	Module to provide MySQL compatibility to salt.
`nacl`	This module helps include encrypted passwords in pillars, grains and salt state files.
`napalm_bgp`	NAPALM BGP
`napalm_formula`	NAPALM Formula helpers
`napalm_mod`	NAPALM helpers
`napalm_netacl`	NAPALM ACL
`napalm_network`	NAPALM Network
`napalm_ntp`	NAPALM NTP
`napalm_probes`	NAPALM Probes
`napalm_route`	NAPALM Route
`napalm_snmp`	NAPALM SNMP
`napalm_users`	NAPALM Users
`napalm_yang_mod`	NAPALM YANG
`netaddress`	Module for getting information about network addresses.
`network`	Module for gathering and managing network information
`nfs3`	Module for managing NFS version 3.
`nftables`	Support for nftables
`npm`	Manage and query NPM packages.
`nxos`	Execution module for Cisco NX OS Switches.
`nxos_api`	Execution module to manage Cisco Nexus Switches (NX-OS) over the NX-API
`nxos_upgrade`	Execution module to upgrade Cisco NX-OS Switches.
`oracle`	Oracle DataBase connection module
`osquery`	Support for OSQuery - https://osquery.io.
`out`	Output Module
`pacmanpkg`	A module to wrap pacman calls, since Arch is the best (https://wiki.archlinux.org/index.php/Arch_is_the_best)
`pam`	Support for pam
`parted_partition`	Module for managing partitions on POSIX-like systems.
`pillar`	Extract the pillar data for this minion
`pip`	Install Python packages with pip to either the system or a virtualenv
`pkg_resource`	Resources needed by pkg providers
`pkgin`	Package support for pkgin based systems, inspired from freebsdpkg module
`pkgng`	Support for `pkgng`, the new package manager for FreeBSD
`pkgutil`	Pkgutil support for Solaris
`postgres`	Module to provide Postgres compatibility to salt.
`proxy`	This module allows you to manage proxy settings
`ps`	A salt interface to psutil, a system and process library.
`publish`	Publish a command from a minion to a target
`puppet`	Execute puppet routines
`pw_group`	Manage groups on FreeBSD
`pw_user`	Manage users with the pw command
`pyenv`	Manage python installations with pyenv.
`quota`	Module for managing quotas on POSIX-like systems.
`rabbitmq`	Module to provide RabbitMQ compatibility to Salt.
`rbac_solaris`	Module for Solaris' Role-Based Access Control
`rdp`	Manage RDP Service on Windows servers
`reg`	Manage the Windows registry
`rest_pkg`	Package support for the REST example
`rest_sample_utils`	Utility functions for the rest_sample
`rest_service`	Provide the service module for the proxy-minion REST sample
`restartcheck`	checkrestart functionality for Debian and Red Hat Based systems
`ret`	Module to integrate with the returner system and retrieve data sent to a salt returner
`rh_ip`	The networking module for RHEL/Fedora based distros
`rh_service`	Service support for RHEL-based systems, including support for both upstart and sysvinit
`rpm_lowpkg`	Support for rpm
`rpmbuild_pkgbuild`	RPM Package builder system
`rsync`	Wrapper for rsync
`salt_proxy`	Salt proxy module
`salt_version`	Access Salt's elemental release code-names.
`saltcheck`	A module for testing the logic of states and highstates on salt minions
`saltcloudmod`	Control a salt cloud system
`saltutil`	The Saltutil module is used to manage the state of the salt minion itself.
`schedule`	Module for managing the Salt schedule on a minion
`scp_mod`	SCP Module
`scsi`	SCSI administration module
`sdb`	Module for Manipulating Data via the Salt DB API
`seed`	Virtual machine image management tools
`selinux`	Execute calls on selinux
`slack_notify`	Module for sending messages to Slack
`slsutil`	Utility functions for use with or in SLS files
`smbios`	Interface to SMBIOS/DMI
`smf_service`	Service support for Solaris 10 and 11, should work with other systems that use SMF also.
`snapper`	Module to manage filesystem snapshots with snapper
`solaris_fmadm`	Module for running fmadm and fmdump on Solaris
`solaris_group`	Manage groups on Solaris
`solaris_shadow`	Manage the password database on Solaris systems
`solaris_system`	Support for reboot, shutdown, etc
`solaris_user`	Manage users with the useradd command
`solarisipspkg`	IPS pkg support for Solaris
`solarispkg`	Package support for Solaris
`sqlite3`	Support for SQLite3
`ssh`	Manage client ssh components
`ssh_pkg`	Service support for the REST example
`ssh_service`	Provide the service module for the proxy-minion SSH sample .
`state`	Control the state system on the minion.
`status`	Module for returning various status data about a minion.
`supervisord`	Provide the service module for system supervisord or supervisord in a virtualenv
`sysfs`	Module for interfacing with SysFS
`syslog_ng`	Module for getting information about syslog-ng
`sysmod`	The sys module provides information about the available functions on the minion
`system`	Support for reboot, shutdown, etc on POSIX-like systems.
`systemd_service`	Provides the service module for systemd
`temp`	Simple module for creating temporary directories and files
`test`	Module for running arbitrary tests
`test_virtual`	Module for testing that a __virtual__ function returning False will not be available via the Salt Loader.
`textfsm_mod`	TextFSM
`timezone`	Module for managing timezone on POSIX-like systems.
`tls`	A salt module for SSL/TLS.
`udev`	Manage and query udev info
`upstart_service`	Module for the management of upstart systems.
`useradd`	Manage users with the useradd command
`vagrant`	Work with virtual machines managed by Vagrant.
`virtualenv_mod`	Create virtualenv environments.
`vsphere`	Manage VMware vCenter servers and ESXi hosts.
`webutil`	Support for htpasswd command.
`win_appx`	Manage provisioned apps
`win_auditpol`	A salt module for modifying the audit policies on the machine
`win_autoruns`	Module for listing programs that automatically run on startup (very alpha...not tested on anything but my Win 7x64)
`win_certutil`	This module allows you to install certificates into the windows certificate manager.
`win_dacl`	Manage DACLs on Windows
`win_disk`	Module for gathering disk information on Windows
`win_dism`	Install features/packages for Windows using DISM, which is useful for minions not running server versions of Windows.
`win_dns_client`	Module for configuring DNS Client on Windows systems
`win_dsc`	Module for working with Windows PowerShell DSC (Desired State Configuration)
`win_event`	A module for working with the Windows Event log system.
`win_file`	Manage information about files on the minion, set/read user, group data, modify the ACL of files/directories
`win_firewall`	Module for configuring Windows Firewall using `netsh`
`win_groupadd`	Manage groups on Windows
`win_iis`	Microsoft IIS site management via WebAdministration powershell module
`win_ip`	The networking module for Windows based systems
`win_lgpo`	Manage Local Policy on Windows
`win_lgpo_reg`	LGPO - Registry.pol
`win_license`	This module allows you to manage windows licensing via slmgr.vbs
`win_network`	Module for gathering and managing network information
`win_ntp`	Management of NTP servers on Windows
`win_path`	Manage the Windows System PATH
`win_pkg`	A module to manage software on Windows
`win_pki`	Microsoft certificate management via the PKI Client PowerShell module.
`win_powercfg`	This module allows you to control the power settings of a windows minion via powercfg.
`win_psget`	Module for managing PowerShell through PowerShellGet (PSGet)
`win_servermanager`	Manage Windows features via the ServerManager powershell module.
`win_service`	Windows Service module.
`win_shadow`	Manage the shadow file
`win_shortcut`	Execution module for creating shortcuts on Windows.
`win_smtp_server`	Module for managing IIS SMTP server configuration on Windows servers.
`win_snmp`	Module for managing SNMP service settings on Windows servers.
`win_status`	Module for returning various status data about a minion.
`win_system`	Module for managing Windows systems and getting Windows system information.
`win_task`	Windows Task Scheduler Module .
`win_timezone`	Module for managing timezone on Windows systems.
`win_useradd`	Module for managing Windows Users.
`win_wua`	Module for managing Windows Updates using the Windows Update Agent.
`win_wusa`	Microsoft Update files management via wusa.exe
`winrepo`	Module to manage Windows software repo on a Standalone Minion
`x509`	Manage X509 certificates
`x509_v2`	Manage X.509 certificates
`xfs`	Module for managing XFS file systems.
`xml`	XML file manager
`yaml`	Yaml helper module for troubleshooting yaml
`yumpkg`	Support for YUM/DNF
`zk_concurrency`	Concurrency controls in zookeeper
`zoneadm`	Module for Solaris 10's zoneadm
`zonecfg`	Module for Solaris 10's zonecfg

Generated on July 10, 2025 at 18:39:29 UTC.

You are viewing docs built from a recent snapshot of the master branch. Switch to docs for the latest stable release, 3007.6.

saltproject.io