Toggle navigation
Table of Contents
Glossary
all salt modules
index
Get Started
Salt Table of Contents
ΒΆ
Reference
Full list of builtin auth modules
salt.auth.auto
salt.auth.django
salt.auth.keystone
salt.auth.ldap
salt.auth.mysql
salt.auth.pam
salt.auth.pki
salt.auth.rest module
salt.auth.stormpath
salt.auth.yubico
Command Line Reference
Using the Salt Command
CLI Completion
salt-call
salt
salt-cloud
salt-cp
salt-key
salt-master
salt-minion
salt-proxy
salt-run
salt-ssh
salt-syndic
salt-api
spm
Client ACL system
Permission Issues
Python client API
Salt's
opts
dictionary
Salt's Loader Interface
Salt's Client Interfaces
Full list of Salt Cloud modules
salt.cloud.clouds.aliyun
salt.cloud.clouds.botocore_aws
salt.cloud.clouds.cloudstack
salt.cloud.clouds.digital_ocean
salt.cloud.clouds.ec2
salt.cloud.clouds.gce
salt.cloud.clouds.gogrid
salt.cloud.clouds.joyent
salt.cloud.clouds.libcloud_aws
salt.cloud.clouds.linode
salt.cloud.clouds.lxc
salt.cloud.clouds.msazure
salt.cloud.clouds.nova
salt.cloud.clouds.opennebula
salt.cloud.clouds.openstack
salt.cloud.clouds.parallels
salt.cloud.clouds.proxmox
salt.cloud.clouds.pyrax
salt.cloud.clouds.rackspace
salt.cloud.clouds.saltify
salt.cloud.clouds.softlayer
salt.cloud.clouds.softlayer_hw
salt.cloud.clouds.vmware
salt.cloud.clouds.vsphere
Configuration file examples
Example master configuration file
Example minion configuration file
Configuring Salt
Master Configuration
Minion Configuration
Running Salt
Key Identity
Key Management
Sending Commands
What's Next?
Configuring the Salt Master
Primary Master Configuration
Salt-SSH Configuration
Master Security Settings
Master Module Management
Master State System Settings
Master File Server Settings
Pillar Configuration
Syndic Server Settings
Peer Publish Settings
Master Logging Settings
Node Groups
Range Cluster Settings
Include Configuration
Windows Software Repo Settings
Configuring the Salt Minion
Minion Primary Configuration
Minion Module Management
State Management Settings
File Directory Settings
Pillar Settings
Security Settings
Thread Settings
Minion Logging Settings
Include Configuration
Frozen Build Update Settings
Standalone Minion Windows Software Repo Settings
Running the Salt Master/Minion as an Unprivileged User
Logging
Available Configuration Settings
External Logging Handlers
Logstash Logging Handler
Sentry Logging Handler
Salt File Server
File Server Backends
Dynamic Module Distribution
Requesting Files from Specific Environments
File Server Configuration
The cp Module
File Server Client Instance
Full list of builtin fileserver modules
salt.fileserver.azurefs
salt.fileserver.gitfs
salt.fileserver.hgfs
salt.fileserver.minionfs
salt.fileserver.roots
salt.fileserver.s3fs
salt.fileserver.svnfs
Full list of builtin grains modules
salt.grains.chronos
salt.grains.core
salt.grains.disks
salt.grains.esxi
salt.grains.extra
salt.grains.fx2
salt.grains.junos
salt.grains.marathon
salt.grains.mdadm
salt.grains.opts
salt.grains.philips_hue
salt.grains.rest_sample
Salt code and internals
Contents
Full list of builtin execution modules
salt.modules.pkg
salt.modules.aliases
salt.modules.alternatives
salt.modules.apache
salt.modules.aptpkg
salt.modules.archive
salt.modules.artifactory
salt.modules.at
salt.modules.augeas_cfg
salt.modules.aws_sqs
salt.modules.bamboohr
salt.modules.beacons
salt.modules.bigip
salt.modules.blockdev
salt.modules.bluez
salt.modules.boto_asg
salt.modules.boto_cfn
salt.modules.boto_cloudwatch
salt.modules.boto_dynamodb
salt.modules.boto_ec2
salt.modules.boto_elasticache
salt.modules.boto_elb
salt.modules.boto_iam
salt.modules.boto_kms
salt.modules.boto_rds
salt.modules.boto_route53
salt.modules.boto_secgroup
salt.modules.boto_sns
salt.modules.boto_sqs
salt.modules.boto_vpc
salt.modules.bower
salt.modules.brew
salt.modules.bridge
salt.modules.bsd_shadow
salt.modules.btrfs
salt.modules.cabal
salt.modules.cassandra
salt.modules.cassandra_cql
salt.modules.chassis
salt.modules.chef
salt.modules.chocolatey
salt.modules.cloud
salt.modules.cmdmod
salt.modules.composer
salt.modules.config
salt.modules.consul
salt.modules.container_resource
salt.modules.cp
salt.modules.cpan
salt.modules.cron
salt.modules.cyg
salt.modules.daemontools
salt.modules.darwin_pkgutil
salt.modules.darwin_sysctl
salt.modules.data
salt.modules.ddns
salt.modules.deb_apache
salt.modules.deb_postgres
salt.modules.debbuild
salt.modules.debconfmod
salt.modules.debian_ip
salt.modules.debian_service
salt.modules.defaults
salt.modules.devmap
salt.modules.dig
salt.modules.disk
salt.modules.djangomod
salt.modules.dnsmasq
salt.modules.dnsutil
salt.modules.dockerio
salt.modules.dockerng
salt.modules.dpkg
salt.modules.drac
salt.modules.dracr
salt.modules.drbd
salt.modules.ebuild
salt.modules.eix
salt.modules.elasticsearch
salt.modules.environ
salt.modules.eselect
salt.modules.esxi
salt.modules.etcd_mod
salt.modules.event
salt.modules.extfs
salt.modules.file
salt.modules.firewalld
salt.modules.freebsd_sysctl
salt.modules.freebsdjail
salt.modules.freebsdkmod
salt.modules.freebsdpkg
salt.modules.freebsdports
salt.modules.freebsdservice
salt.modules.gem
salt.modules.genesis
salt.modules.gentoo_service
salt.modules.gentoolkitmod
salt.modules.git
salt.modules.glance
salt.modules.glusterfs
salt.modules.gnomedesktop
salt.modules.gpg
salt.modules.grains
salt.modules.groupadd
salt.modules.grub_legacy
salt.modules.guestfs
salt.modules.hadoop
salt.modules.haproxyconn
salt.modules.hashutil
salt.modules.hg
salt.modules.hipchat
salt.modules.hosts
salt.modules.htpasswd
salt.modules.http
salt.modules.ifttt
salt.modules.ilo
salt.modules.img
salt.modules.incron
salt.modules.influx
salt.modules.ini_manage
salt.modules.inspectlib package
salt.modules.introspect
salt.modules.ipmi
salt.modules.ipset
salt.modules.iptables
salt.modules.jboss7
salt.modules.jboss7_cli
salt.modules.junos
salt.modules.kerberos
salt.modules.key
salt.modules.keyboard
salt.modules.keystone
salt.modules.kmod
salt.modules.launchctl
salt.modules.layman
salt.modules.ldapmod
salt.modules.linux_acl
salt.modules.linux_lvm
salt.modules.linux_sysctl
salt.modules.localemod
salt.modules.locate
salt.modules.logadm
salt.modules.logrotate
salt.modules.lvs
salt.modules.lxc
salt.modules.mac_group
salt.modules.mac_user
salt.modules.macports
salt.modules.makeconf
salt.modules.match
salt.modules.mdadm
salt.modules.memcached
salt.modules.mine
salt.modules.mod_random
salt.modules.modjk
salt.modules.mongodb
salt.modules.monit
salt.modules.moosefs
salt.modules.mount
salt.modules.mssql
salt.modules.munin
salt.modules.mysql
salt.modules.nacl
salt.modules.nagios
salt.modules.nagios_rpc
salt.modules.netbsd_sysctl
salt.modules.netbsdservice
salt.modules.netscaler
salt.modules.network
salt.modules.neutron
salt.modules.nfs3
salt.modules.nftables
salt.modules.nginx
salt.modules.node
salt.modules.nova
salt.modules.npm
salt.modules.nspawn
salt.modules.omapi
salt.modules.openbsd_sysctl
salt.modules.openbsdpkg
salt.modules.openbsdrcctl
salt.modules.openbsdservice
salt.modules.openstack_config
salt.modules.oracle
salt.modules.osquery
salt.modules.osxdesktop
salt.modules.pacman
salt.modules.pagerduty
salt.modules.pagerduty_util
salt.modules.pam
salt.modules.parted
salt.modules.pecl
salt.modules.pillar
salt.modules.pip
salt.modules.pkg_resource
salt.modules.pkgin
salt.modules.pkgng
salt.modules.pkgutil
salt.modules.portage_config
salt.modules.postfix
salt.modules.postgres
salt.modules.poudriere
salt.modules.powerpath
salt.modules.ps
salt.modules.publish
salt.modules.puppet
salt.modules.pushover_notify
salt.modules.pw_group
salt.modules.pw_user
salt.modules.pyenv
salt.modules.qemu_img
salt.modules.qemu_nbd
salt.modules.quota
salt.modules.rabbitmq
salt.modules.raet_publish
salt.modules.rallydev
salt.modules.random_org
salt.modules.rbenv
salt.modules.rdp
salt.modules.redis
salt.modules.reg
salt.modules.rest_package
salt.modules.rest_service
salt.modules.ret
salt.modules.rh_ip
salt.modules.rh_service
salt.modules.riak
salt.modules.rpm
salt.modules.rpmbuild
salt.modules.rsync
salt.modules.runit
salt.modules.rvm
salt.modules.s3
salt.modules.saltcloudmod
salt.modules.saltutil
salt.modules.schedule
salt.modules.scsi
salt.modules.sdb
salt.modules.seed
salt.modules.selinux
salt.modules.sensors
salt.modules.serverdensity_device
salt.modules.service
salt.modules.shadow
salt.modules.slack_notify
salt.modules.slsutil
salt.modules.smartos_imgadm
salt.modules.smartos_virt
salt.modules.smartos_vmadm
salt.modules.smbios
salt.modules.smf
salt.modules.smtp
salt.modules.softwareupdate
salt.modules.solaris_group
salt.modules.solaris_shadow
salt.modules.solaris_user
salt.modules.solarisips
salt.modules.solarispkg
salt.modules.solr
salt.modules.splay
salt.modules.splunk_search
salt.modules.sqlite3
salt.modules.ssh
salt.modules.state
salt.modules.status
salt.modules.stormpath
salt.modules.sudo
salt.modules.supervisord
salt.modules.svn
salt.modules.swift
salt.modules.sysbench
salt.modules.syslog_ng
salt.modules.sysmod
salt.modules.sysrc
salt.modules.system
salt.modules.system_profiler
salt.modules.systemd
salt.modules.temp
salt.modules.test
salt.modules.test_virtual
salt.modules.timezone
salt.modules.tls
salt.modules.tomcat
salt.modules.trafficserver
salt.modules.tuned
salt.modules.twilio_notify
salt.modules.udev
salt.modules.upstart
salt.modules.uptime
salt.modules.useradd
salt.modules.uwsgi
salt.modules.varnish
salt.modules.vbox_guest
salt.modules.victorops
salt.modules.virt
salt.modules.virtualenv
salt.modules.vsphere
salt.modules.win_autoruns
salt.modules.win_dacl
salt.modules.win_disk
salt.modules.win_dns_client
salt.modules.win_file
salt.modules.win_firewall
salt.modules.win_groupadd
salt.modules.win_ip
salt.modules.win_network
salt.modules.win_ntp
salt.modules.win_path
salt.modules.win_pkg
salt.modules.win_powercfg
salt.modules.win_repo
salt.modules.win_servermanager
salt.modules.win_service
salt.modules.win_shadow
salt.modules.win_status
salt.modules.win_system
salt.modules.win_timezone
salt.modules.win_update
salt.modules.win_useradd
salt.modules.win_wua
salt.modules.x509
salt.modules.xapi
salt.modules.xfs
salt.modules.xmpp
salt.modules.yumpkg
salt.modules.zcbuildout
salt.modules.zfs
salt.modules.zk_concurrency
salt.modules.znc
salt.modules.zpool
salt.modules.zypper
Full list of netapi modules
rest_cherrypy
rest_tornado
rest_wsgi
Full list of builtin output modules
salt.output.compact
salt.output.highstate
salt.output.json_out
salt.output.key
salt.output.nested
salt.output.newline_values_only
salt.output.no_out
salt.output.no_return
salt.output.overstatestage
salt.output.pprint_out
salt.output.progress
salt.output.raw
salt.output.txt
salt.output.virt_query
salt.output.yaml_out
Peer Communication
Peer Configuration
Peer Runner Communication
Using Peer Communication
Pillars
Full list of builtin pillar modules
salt.pillar.cmd_json
salt.pillar.cmd_yaml
salt.pillar.cmd_yamlex
salt.pillar.cobbler
salt.pillar.consul_pillar module
salt.pillar.django_orm
salt.pillar.ec2_pillar
salt.pillar.etcd_pillar
salt.pillar.file_tree
salt.pillar.foreman
salt.pillar.git_pillar
salt.pillar.hg_pillar
salt.pillar.hiera
salt.pillar.libvirt
salt.pillar.mongo
salt.pillar.mysql
salt.pillar.neutron module
salt.pillar.pepa
salt.pillar.pillar_ldap
salt.pillar.puppet
salt.pillar.reclass_adapter
salt.pillar.redismod
salt.pillar.s3
salt.pillar.sql_base module
salt.pillar.sqlite3 module
salt.pillar.svn_pillar
salt.pillar.varstack_pillar
salt.pillar.virtkey
Full list of builtin proxy modules
salt.proxy.esxi
salt.proxy.fx2
salt.proxy.junos
salt.proxy.rest_sample
salt.proxy.ssh_sample
Renderers
Multiple Renderers
Composing Renderers
Writing Renderers
Examples
Full List of Renderers
Returners
Using Returners
Writing a Returner
Event Returners
Full List of Returners
Full list of builtin roster modules
salt.roster.ansible
salt.roster.cache
salt.roster.cloud
salt.roster.clustershell
salt.roster.flat
salt.roster.scan
Salt Runners
Writing Salt Runners
Synchronous vs. Asynchronous
Examples
State Enforcement
Mod Aggregate State Runtime Modifications
Altering States
File State Backups
Understanding State Compiler Ordering
Extending External SLS Data
Failhard Global Option
Global State Arguments
Highstate data structure definitions
Include and Exclude
State System Layers
The Orchestrate Runner
Ordering States
State Providers
Requisites and Other Global State Arguments
Startup States
State Testing
The Top File
SLS Template Variable Reference
State Modules
State Management
Understanding the Salt State System Components
Full list of builtin state modules
salt.states.alias
salt.states.alternatives
salt.states.apache
salt.states.apache_module
salt.states.aptpkg
salt.states.archive
salt.states.artifactory
salt.states.at
salt.states.augeas
salt.states.aws_sqs
salt.states.beacon
salt.states.bigip
salt.states.blockdev
salt.states.boto_asg
salt.states.boto_cfn
salt.states.boto_cloudwatch_alarm
salt.states.boto_dynamodb
salt.states.boto_ec2
salt.states.boto_elasticache
salt.states.boto_elb
salt.states.boto_iam
salt.states.boto_iam_role
salt.states.boto_kms
salt.states.boto_lc
salt.states.boto_rds
salt.states.boto_route53
salt.states.boto_secgroup
salt.states.boto_sns
salt.states.boto_sqs
salt.states.boto_vpc
salt.states.bower
salt.states.cabal
salt.states.chef
salt.states.cloud
salt.states.cmd
salt.states.composer
salt.states.cron
salt.states.cyg
salt.states.ddns
salt.states.debconfmod
salt.states.dellchassis
salt.states.disk
salt.states.dockerio
salt.states.dockerng
salt.states.drac
salt.states.elasticsearch_index
salt.states.elasticsearch_index_template
salt.states.environ
salt.states.eselect
salt.states.etcd_mod
salt.states.esxi
salt.states.event
salt.states.file
salt.states.firewalld
salt.states.gem
salt.states.git
salt.states.glance
salt.states.glusterfs
salt.states.gnomedesktop
salt.states.grafana
salt.states.grains
salt.states.group
salt.states.hg
salt.states.hipchat
salt.states.host
salt.states.htpasswd
salt.states.http
salt.states.ifttt
salt.states.incron
salt.states.influxdb_database
salt.states.influxdb_user
salt.states.ini_manage
salt.states.ipmi
salt.states.ipset
salt.states.iptables
salt.states.jboss7
salt.states.keyboard
salt.states.keystone
salt.states.kmod
salt.states.layman
salt.states.libvirt
salt.states.linux_acl
salt.states.locale
salt.states.lvm
salt.states.lvs_server
salt.states.lvs_service
salt.states.lxc
salt.states.makeconf
salt.states.mdadm
salt.states.memcached
salt.states.modjk
salt.states.modjk_worker
salt.states.module
salt.states.mongodb_database
salt.states.mongodb_user
salt.states.monit
salt.states.mount
salt.states.mysql_database
salt.states.mysql_grants
salt.states.mysql_query
salt.states.mysql_user
salt.states.network
salt.states.nftables
salt.states.npm
salt.states.ntp
salt.states.openstack_config
salt.states.pagerduty
salt.states.pagerduty_escalation_policy
salt.states.pagerduty_schedule
salt.states.pagerduty_service
salt.states.pagerduty_user
salt.states.pecl
salt.states.pip_state
salt.states.pkg
salt.states.pkgbuild
salt.states.pkgng
salt.states.pkgrepo
salt.states.portage_config
salt.states.ports
salt.states.postgres_database
salt.states.postgres_extension
salt.states.postgres_group
salt.states.postgres_schema
salt.states.postgres_tablespace
salt.states.postgres_user
salt.states.powerpath
salt.states.process
salt.states.pushover
salt.states.pyenv
salt.states.pyrax_queues
salt.states.quota
salt.states.rabbitmq_cluster
salt.states.rabbitmq_plugin
salt.states.rabbitmq_policy
salt.states.rabbitmq_user
salt.states.rabbitmq_vhost
salt.states.rbenv
salt.states.rdp
salt.states.redismod
salt.states.reg
salt.states.rvm
salt.states.saltmod
salt.states.schedule
salt.states.selinux
salt.states.serverdensity_device
salt.states.service
salt.states.slack
salt.states.smtp
salt.states.splunk_search
salt.states.ssh_auth
salt.states.ssh_known_hosts
salt.states.stateconf
salt.states.status
salt.states.stormpath_account
salt.states.supervisord
salt.states.svn
salt.states.sysctl
salt.states.syslog_ng
salt.states.sysrc
salt.states.test
salt.states.timezone
salt.states.tls
salt.states.tomcat
salt.states.trafficserver
salt.states.tuned
salt.states.uptime
salt.states.user
salt.states.vbox_guest
salt.states.victorops
salt.states.virtualenv
salt.states.win_dacl
salt.states.win_dns_client
salt.states.win_firewall
salt.states.win_network
salt.states.win_path
salt.states.win_powercfg
salt.states.win_servermanager
salt.states.win_system
salt.states.win_update
salt.states.winrepo
salt.states.x509
salt.states.xmpp
salt.states.zcbuildout
salt.states.zk_concurrency
Execution Modules
Modules Are Easy to Write!
Zip Archives as Modules
Cross Calling Execution Modules
Preloaded Execution Module Data
Printout Configuration
Virtual Modules
__virtual__
Function
__virtualname__
Documentation
Log Output
Aliasing Functions
Private Functions
Useful Decorators for Modules
Master Tops
Full list of builtin master tops modules
salt.tops.cobbler
salt.tops.ext_nodes
salt.tops.mongo
salt.tops.reclass_adapter
Full list of builtin wheel modules
salt.wheel.config
salt.wheel.error
salt.wheel.file_roots
salt.wheel.key
salt.wheel.minions
salt.wheel.pillar_roots
Full list of builtin beacon modules
salt.beacons.btmp
salt.beacons.diskusage
salt.beacons.inotify
salt.beacons.journald
salt.beacons.load
salt.beacons.network_info
salt.beacons.ps module
salt.beacons.service
salt.beacons.sh
salt.beacons.twilio_txt_msg
salt.beacons.wtmp
Full list of builtin engine modules
salt.engines.logstash
salt.engines.sqs_events
salt.engines.test
Full list of builtin sdb modules
salt.sdb.couchdb
salt.sdb.etcd_db
salt.sdb.keyring_db
salt.sdb.memcached
salt.sdb.sqlite3
Full list of builtin serializers
salt.serializers.json
salt.serializers.msgpack
salt.serializers.yaml
salt.serializers.yamlex
Full list of builtin queues
salt.queues.sqlite_queue module
Glossary
2015.8.12
2016.3.4
Develop
Introduction to Salt
Installation
Tutorials
Targeting Minions
Storing Static Data in the Pillar
Reactor System
The Salt Mine
External Authentication System
Access Control System
Job Management
Managing the Job Cache
Storing Job Results in an External System
Storing Data in Other Databases
Salt Event System
Beacons
Salt Engines
Running Custom Master Processes
High Availability Features in Salt
Salt Syndic
Salt Proxy Minion
Salt Package Manager
Salt Transport
Windows Software Repository
Windows-specific Behaviour
Salt Cloud
netapi
modules
Salt Virt
Understanding YAML
Master Tops System
Salt SSH
Salt Rosters
Reference
Salt Best Practices
Hardening Salt
Troubleshooting
Developing Salt
Release notes
Salt Community Projects
Security disclosure policy
Frequently Asked Questions
Glossary