# state modules

`acme` | ACME / Let's Encrypt certificate management state
`alias` | Configuration of email aliases
`alternatives` | Configuration of the alternatives system
`ansiblegate` | Execution of Ansible modules from within states
`apache` |
`apache_conf` |
`apache_module` |
`apache_site` |
`aptpkg` | Package management operations specific to APT- and DEB-based systems
`archive` | Extract an archive
`artifactory` | This state downloads artifacts from artifactory.
`at` | Configuration disposable regularly scheduled tasks for at.
`augeas` | Configuration management using Augeas
`aws_sqs` | Manage SQS Queues
`beacon` | Management of the Salt beacons
`bigip` | A state module designed to enforce load-balancing configurations for F5 Big-IP entities.
`blockdev` | Management of Block Devices
`boto3_elasticache` | Manage Elasticache with boto3
`boto3_elasticsearch` | Manage Elasticsearch Service
`boto3_route53` | Manage Route53 records with Boto 3
`boto3_sns` | Manage SNS Topics
`boto_apigateway` | Manage Apigateway Rest APIs
`boto_asg` | Manage Autoscale Groups
`boto_cfn` | Connection module for Amazon Cloud Formation
`boto_cloudfront` | Manage CloudFront distributions
`boto_cloudtrail` | Manage CloudTrail Objects
`boto_cloudwatch_alarm` | Manage Cloudwatch alarms
`boto_cloudwatch_event` | Manage CloudTrail Objects
`boto_cognitoidentity` | Manage CognitoIdentity Functions
`boto_datapipeline` | Manage Data Pipelines
`boto_dynamodb` | Manage DynamoDB Tables
`boto_ec2` | Manage EC2
`boto_elasticache` | Manage Elasticache
`boto_elasticsearch_domain` | Manage Elasticsearch Domains
`boto_elb` | Manage ELBs
`boto_elbv2` | Manage AWS Application Load Balancer
`boto_iam` | Manage IAM objects
`boto_iam_role` | Manage IAM roles
`boto_iot` | Manage IoT Objects
`boto_kinesis` | Manage Kinesis Streams
`boto_kms` | Manage KMS keys, key policies and grants.
`boto_lambda` | Manage Lambda Functions
`boto_lc` | Manage Launch Configurations
`boto_rds` | Manage RDSs
`boto_route53` | Manage Route53 records
`boto_s3` | Manage S3 Resources
`boto_s3_bucket` | Manage S3 Buckets
`boto_secgroup` | Manage Security Groups
`boto_sns` | Manage SNS Topics
`boto_sqs` | Manage SQS Queues
`boto_vpc` | Manage VPCs
`bower` | Installation of Bower Packages
`btrfs` | Manage BTRFS file systems.
`cabal` | Installation of Cabal Packages
`ceph` | Manage ceph with salt.
`chef` | Execute Chef client runs
`chocolatey` | Manage Windows Packages using Chocolatey .
`chronos_job` | Configure Chronos jobs via a salt proxy.
`cimc` | A state module to manage Cisco UCS chassis devices.
`cisconso` | State module for Cisco NSO Proxy minions
`cloud` | Using states instead of maps to deploy clouds
`cmd` | Execution of arbitrary commands
`composer` | Installation of Composer Packages
`consul` | Consul Management
`cron` | Management of cron, the Unix command scheduler
`cryptdev` | Opening of Encrypted Devices
`csf` | CSF Ip tables management
`cyg` | Installation of Cygwin packages.
`ddns` | Dynamic DNS updates
`debconfmod` | Management of debconf selections
`dellchassis` | Manage chassis via Salt Proxies.
`disk` | Disk monitoring state
`docker_container` |
`docker_image` |
`docker_network` |
`docker_volume` |
`drac` | Management of Dell DRAC
`dvs` | Manage VMware distributed virtual switches (DVSs) and their distributed virtual portgroups (DVportgroups).
`elasticsearch` | State module to manage Elasticsearch.
`elasticsearch_index` | State module to manage Elasticsearch indices
`elasticsearch_index_template` | State module to manage Elasticsearch index templates
`environ` | Support for getting and setting the environment variables of the current salt process.
`eselect` | Management of Gentoo configuration using eselect
`esxcluster` | Manage VMware ESXi Clusters.
`esxdatacenter` | Salt states to create and manage VMware vSphere datacenters (datacenters).
`esxi` | Manage VMware ESXi Hosts.
`esxvm` | Salt state to create, update VMware ESXi Virtual Machines.
`etcd_mod` | Manage etcd Keys
`ethtool` | Configuration of network device
`event` | Send events through Salt's event system during state runs
`file` | Operations on regular files, special files, directories, and symlinks
`firewall` | State to check firewall configurations
`firewalld` | Management of firewalld
`gem` | Installation of Ruby modules packaged as gems
`git` | States to manage git repositories and git configuration
`github` | Github User State Module
`glance_image` | Management of OpenStack Glance Images
`glassfish` | Manage Glassfish/Payara server .
`glusterfs` | Manage GlusterFS pool.
`gnomedesktop` | Configuration of the GNOME desktop
`gpg` | Manage GPG keychains
`grafana` | Manage Grafana Dashboards
`grafana4_dashboard` | Manage Grafana v4.0 Dashboards
`grafana4_datasource` | Manage Grafana v4.0 data sources
`grafana4_org` | Manage Grafana v4.0 orgs
`grafana4_user` | Manage Grafana v4.0 users
`grafana_dashboard` | Manage Grafana v2.0 Dashboards
`grafana_datasource` | Manage Grafana v2.0 data sources
`grains` | Manage grains on the minion
`group` | Management of user groups
`heat` | Management of Heat
`helm` |
`hg` | Interaction with Mercurial repositories
`highstate_doc` | To be used with processors in module highstate_doc.
`host` | Management of addresses and names in hosts file
`http` | HTTP monitoring states
`icinga2` | Icinga2 state
`idem` | Idem Support
`ifttt` | Trigger an event in IFTTT
`incron` | Management of incron, the inotify cron
`influxdb08_database` | Management of Influxdb 0.8 databases
`influxdb08_user` | Management of InfluxDB 0.8 users
`influxdb_continuous_query` | Management of Influxdb continuous queries
`influxdb_database` | Management of Influxdb databases
`influxdb_retention_policy` | Management of Influxdb retention policies
`influxdb_user` | Management of InfluxDB users
`infoblox_a` | Infoblox A record management.
`infoblox_cname` | Infoblox CNAME management.
`infoblox_host_record` | Infoblox host record management.
`infoblox_range` | Infoblox host record management.
`ini_manage` | Manage ini files
`ipmi` | Manage IPMI devices over LAN
`ipset` | Management of ipsets
`iptables` | Management of iptables
`jboss7` | Manage JBoss 7 Application Server via CLI interface
`jenkins` | Management of Jenkins
`junos` | State modules to interact with Junos devices.
`kapacitor` | Kapacitor state module.
`kernelpkg` | Manage kernel packages and active kernel version
`keyboard` | Management of keyboard layouts
`keystone` | Management of Keystone users
`keystone_domain` | Management of OpenStack Keystone Domains
`keystone_endpoint` | Management of OpenStack Keystone Endpoints
`keystone_group` | Management of OpenStack Keystone Groups
`keystone_project` | Management of OpenStack Keystone Projects
`keystone_role` | Management of OpenStack Keystone Roles
`keystone_role_grant` | Management of OpenStack Keystone Role Grants
`keystone_service` | Management of OpenStack Keystone Services
`keystone_user` | Management of OpenStack Keystone Users
`keystore` | State management of a java keystore
`kmod` | Loading and unloading of kernel modules
`kubernetes` |
`layman` | Management of Gentoo Overlays using layman
`ldap` | Manage entries in an LDAP database
`libcloud_dns` | Manage DNS records and zones using libcloud
`libcloud_loadbalancer` | Apache Libcloud Load Balancer State
`libcloud_storage` | Apache Libcloud Storage State
`linux_acl` | Linux File Access Control Lists
`locale` | Management of languages/locales
`logadm` | Management of logs using Solaris logadm.
`logrotate` | Module for managing logrotate.
`loop` | Loop state
`lvm` | Management of Linux logical volumes
`lvs_server` | Management of LVS (Linux Virtual Server) Real Server
`lvs_service` | Management of LVS (Linux Virtual Server) Service
`lxc` | Manage Linux Containers
`lxd` | Manage LXD profiles.
`lxd_container` | Manage LXD containers.
`lxd_image` | Manage LXD images.
`lxd_profile` | Manage LXD profiles.
`mac_assistive` | Allows you to manage assistive access on macOS minions with 10.9+
`mac_keychain` | Installing of certificates to the keychain
`mac_xattr` | Allows you to manage extended attributes on files or directories
`macdefaults` | Writing/reading defaults from a macOS minion
`macpackage` | Installing of mac pkg files
`makeconf` | Management of Gentoo make.conf
`marathon_app` | Configure Marathon apps via a salt proxy.
`mdadm_raid` | Managing software RAID with mdadm
`memcached` | States for Management of Memcached Keys
`modjk` | State to control Apache modjk
`modjk_worker` | Manage modjk workers
`module` | Execution of Salt modules from within states
`mongodb_database` | Management of MongoDB Databases
`mongodb_user` | Management of MongoDB Users
`monit` | Monit state
`mount` | Mounting of filesystems
`mssql_database` | Management of Microsoft SQLServer Databases
`mssql_login` | Management of Microsoft SQLServer Logins
`mssql_role` | Management of Microsoft SQLServer Databases
`mssql_user` | Management of Microsoft SQLServer Users
`msteams` | Send a message card to Microsoft Teams
`mysql_database` | Management of MySQL databases (schemas)
`mysql_grants` | Management of MySQL grants (user permissions)
`mysql_query` | Execution of MySQL queries
`mysql_user` | Management of MySQL users
`net_napalm_yang` | NAPALM YANG state
`netacl` | Network ACL
`netconfig` | Network Config
`netntp` | Network NTP
`netsnmp` | Network SNMP
`netusers` | Network Users
`network` | Configuration of network interfaces
`neutron_network` | Management of OpenStack Neutron Networks
`neutron_secgroup` | Management of OpenStack Neutron Security Groups
`neutron_secgroup_rule` | Management of OpenStack Neutron Security Group Rules
`neutron_subnet` | Management of OpenStack Neutron Subnets
`nexus` | This state downloads artifacts from Nexus 3.x.
`nfs_export` | Management of NFS exports
`nftables` | Management of nftables
`npm` | Installation of NPM Packages
`ntp` | Management of NTP servers
`nxos` | State module for Cisco NX-OS Switch Proxy and Native minions
`nxos_upgrade` | Manage NX-OS System Image Upgrades.
`openstack_config` | Manage OpenStack configuration file settings.
`openvswitch_bridge` | Management of Open vSwitch bridges.
`openvswitch_db` | Management of Open vSwitch database records.
`openvswitch_port` | Management of Open vSwitch ports.
`opsgenie` | Create/Close an alert in OpsGenie
`pagerduty` | Create an Event in PagerDuty
`pagerduty_escalation_policy` | Manage PagerDuty escalation policies.
`pagerduty_schedule` | Manage PagerDuty schedules.
`pagerduty_service` | Manage PagerDuty services
`pagerduty_user` | Manage PagerDuty users.
`panos` | A state module to manage Palo Alto network devices.
`pbm` | Manages VMware storage policies (called pbm because the vCenter endpoint is /pbm)
`pcs` | Management of Pacemaker/Corosync clusters with PCS
`pdbedit` | Manage accounts in Samba's passdb using pdbedit
`pecl` | Installation of PHP Extensions Using pecl
`pip_state` | Installation of Python Packages Using pip
`pkg` | Installation of packages using OS package managers such as yum or apt-get
`pkgbuild` | The pkgbuild state is the front of Salt package building backend.
`pkgng` | Manage package remote repo using FreeBSD pkgng
`pkgrepo` | Management of APT/DNF/YUM/Zypper package repos
`portage_config` | Management of Portage package configuration on Gentoo
`ports` | Manage software from FreeBSD ports
`postgres_cluster` | Management of PostgreSQL clusters
`postgres_database` | Management of PostgreSQL databases
`postgres_extension` | Management of PostgreSQL extensions
`postgres_group` | Management of PostgreSQL groups (roles)
`postgres_initdb` | Initialization of PostgreSQL data directory
`postgres_language` | Management of PostgreSQL languages
`postgres_privileges` | Management of PostgreSQL Privileges
`postgres_schema` | Management of PostgreSQL schemas
`postgres_tablespace` | Management of PostgreSQL tablespace
`postgres_user` | Management of PostgreSQL users (roles)
`powerpath` | Powerpath configuration support
`probes` | Network Probes
`process` | Process Management
`proxy` | Allows you to manage proxy settings on minions
`pushover` |
`pyenv` | Managing python installations with pyenv
`pyrax_queues` | Manage Rackspace Queues
`quota` | Management of POSIX Quotas
`rabbitmq_cluster` | Manage RabbitMQ Clusters
`rabbitmq_plugin` | Manage RabbitMQ Plugins
`rabbitmq_policy` | Manage RabbitMQ Policies
`rabbitmq_upstream` | Manage RabbitMQ Upstreams
`rabbitmq_user` | Manage RabbitMQ Users
`rabbitmq_vhost` | Manage RabbitMQ Virtual Hosts
`rbac_solaris` | Management of Solaris RBAC
`rbenv` | Managing Ruby installations with rbenv
`rdp` | Manage RDP Service on Windows servers
`redismod` | Management of Redis server
`reg` | Manage the Windows registry
`restconf` | RESTCONF State module for Proxy minions
`rsync` | State to synchronize files and directories with rsync.
`rvm` | Managing Ruby installations and gemsets with Ruby Version Manager (RVM)
`salt_proxy` | Salt proxy state
`saltmod` | Control the Salt command interface
`saltutil` | Saltutil State
`schedule` | Management of the Salt scheduler
`selinux` | Management of SELinux rules
`serverdensity_device` | Monitor Server with Server Density
`service` | Starting or restarting of services and daemons
`slack` | Send a message to Slack
`smartos` | Management of SmartOS Standalone Compute Nodes
`smtp` | Sending Messages via SMTP
`snapper` | Managing implicit state and baselines using snapshots
`solrcloud` | States for solrcloud alias and collection configuration
`splunk` | Splunk User State Module
`splunk_search` | Splunk Search State Module
`sqlite3` | Management of SQLite3 databases
`ssh_auth` | Control of entries in SSH authorized_key files
`ssh_known_hosts` | Control of SSH known_hosts entries
`stateconf` | Stateconf System
`status` | Minion status monitoring
`statuspage` | StatusPage
`supervisord` | Interaction with the Supervisor daemon
`svn` | Manage SVN repositories
`sysctl` | Configuration of the kernel using sysctl
`sysfs` | Configuration of the kernel using sysfs
`syslog_ng` | State module for syslog_ng
`sysrc` | State to work with sysrc
`telemetry_alert` | Manage Telemetry alert configurations
`test` | Test States
`testinframod` |
`timezone` | Management of timezones
`tls` | Enforce state for SSL/TLS
`tomcat` | Manage Apache Tomcat web applications
`trafficserver` | Control Apache Traffic Server
`tuned` | Interface to Red Hat tuned-adm module
`uptime` | Monitor Web Server with Uptime
`user` | Management of user accounts.
`vagrant` | Manage Vagrant VMs
`vault` |
`vbox_guest` | VirtualBox Guest Additions installer state
`victorops` | Create an Event in VictorOps
`virt` | Manage virt
`virtualenv_mod` | Setup of Python virtualenv sandboxes.
`webutil` | Support for htpasswd module.
`win_appx` | Manage Microsoft Store apps on Windows.
`win_certutil` | Installing of certificates to the Windows Certificate Manager
`win_dacl` | Windows Object Access Control Lists
`win_dism` | Installing of Windows features using DISM
`win_dns_client` | Module for configuring DNS Client on Windows systems
`win_firewall` | State for configuring Windows Firewall
`win_iis` | Microsoft IIS site management
`win_lgpo` | Manage Windows Local Group Policy
`win_lgpo_reg` | LGPO - Registry.pol
`win_license` | Installation and activation of windows licenses
`win_network` | Configuration of network interfaces on Windows hosts
`win_path` | Manage the Windows System PATH
`win_pki` | Microsoft certificate management via the Pki PowerShell module.
`win_powercfg` | This module allows you to control the power settings of a windows minion via powercfg.
`win_servermanager` | Manage Windows features via the ServerManager powershell module.
`win_shortcut` | State 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_system` | Management of Windows system information
`win_task` | State module for adding and removing scheduled tasks using the Windows Task Scheduler.
`win_wua` | Installation of Windows Updates using the Windows Update Agent
`win_wusa` | Microsoft Updates (KB) Management
`winrepo` | Manage Windows Package Repository
`wordpress` | This state module is used to manage Wordpress installations
`x509` | Manage X509 Certificates
`x509_v2` | Manage X.509 certificates
`xml` | XML Manager
`xmpp` | Sending Messages over XMPP
`zabbix_action` |
`zabbix_host` |
`zabbix_hostgroup` |
`zabbix_mediatype` |
`zabbix_template` |
`zabbix_user` |
`zabbix_usergroup` |
`zabbix_usermacro` |
`zabbix_valuemap` |
`zcbuildout` | Management of zc.buildout
`zenoss` | State to manage monitoring in Zenoss.
`zfs` | States for managing zfs datasets
`zk_concurrency` | Control concurrency of steps within state execution using zookeeper
`zone` | Management of Solaris Zones
`zookeeper` | Zookeeper State
`zpool` | States for managing zpools