You are viewing docs from a branch that is no longer active. You might want to view docs for the 2015.8.x release instead.

Reference¶

Full list of builtin auth modules
- salt.auth.auto
- salt.auth.keystone
- salt.auth.ldap
- salt.auth.pam
- salt.auth.pki
- salt.auth.stormpath_mod
Command Line Reference
- Using the Salt Command
- salt-call
  - salt-call
- salt
  - salt
- salt-cloud
  - salt-cloud
- salt-cp
  - salt-cp
- salt-key
  - salt-key
- salt-master
  - salt-master
- salt-minion
  - salt-minion
- salt-run
  - salt-run
- salt-ssh
  - salt-ssh
- salt-syndic
  - salt-syndic
- salt-api
  - salt-api
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
  - AliYun ECS Cloud Module
- salt.cloud.clouds.botocore_aws
  - The AWS Cloud Module
- salt.cloud.clouds.cloudstack
  - CloudStack Cloud Module
- salt.cloud.clouds.digital_ocean
  - DigitalOcean Cloud Module
- salt.cloud.clouds.ec2
  - The EC2 Cloud Module
- salt.cloud.clouds.gce
  - Google Compute Engine Module
- salt.cloud.clouds.gogrid
  - GoGrid Cloud Module
- salt.cloud.clouds.joyent
  - Joyent Cloud Module
- salt.cloud.clouds.libcloud_aws
  - The AWS Cloud Module
- salt.cloud.clouds.linode
  - Linode Cloud Module using Apache Libcloud OR linode-python bindings
- salt.cloud.clouds.lxc
  - Install Salt on an LXC Container
- salt.cloud.clouds.msazure
  - Azure Cloud Module
- salt.cloud.clouds.nova
  - OpenStack Nova Cloud Module
- salt.cloud.clouds.opennebula
  - OpenNebula Cloud Module
- salt.cloud.clouds.openstack
  - OpenStack Cloud Module
- salt.cloud.clouds.parallels
  - Parallels Cloud Module
- salt.cloud.clouds.proxmox
  - Proxmox Cloud Module
- salt.cloud.clouds.rackspace
  - Rackspace Cloud Module
- salt.cloud.clouds.saltify
  - Saltify Module
- salt.cloud.clouds.softlayer
  - SoftLayer Cloud Module
- salt.cloud.clouds.softlayer_hw
  - SoftLayer HW Cloud Module
- salt.cloud.clouds.vsphere
  - vSphere Cloud Module
Configuration file examples
- Example master configuration file
- Example minion configuration file
Configuring Salt
- Master Configuration
- Minion Configuration
- Running Salt
- Key Identity
  - Master Key Fingerprint
  - Minion Key Fingerprint
- Key Management
- Sending Commands
- What's Next?
Configuring the Salt Master
- Primary Master Configuration
- Salt-SSH Configuration
  - roster_file
  - ssh_minion_opts
- Master Security Settings
- Master Module Management
  - runner_dirs
  - cython_enable
- Master State System Settings
- Master File Server Settings
- Pillar Configuration
- Syndic Server Settings
- Peer Publish Settings
  - peer
  - peer_run
- Master Logging Settings
- Node Groups
- Range Cluster Settings
  - range_server
- Include Configuration
  - default_include
  - include
- Windows Software Repo Settings
Configuring the Salt Minion
- Minion Primary Configuration
- Minion Module Management
- State Management Settings
- File Directory Settings
- Security Settings
- Thread Settings
- Minion Logging Settings
- Include Configuration
  - default_include
  - include
- Frozen Build Update Settings
  - update_url
  - update_restart_services
Running the Salt Master/Minion as an Unprivileged User
Logging
- Available Configuration Settings
External Logging Handlers
- Logstash Logging Handler
  - UDP Logging Handler
  - ZeroMQ Logging Handler
    - Log Level
    - HWM
- Sentry Logging Handler
  - Threaded Transports
Salt File Server
- File Server Backends
- Dynamic Module Distribution
  - Sync Via States
  - Sync Via the saltutil Module
- File Server Configuration
- The cp Module
- File Server Client API
  - FileClient Class
Full list of builtin fileserver modules
- salt.fileserver.gitfs
- salt.fileserver.hgfs
- salt.fileserver.minionfs
- salt.fileserver.roots
- salt.fileserver.s3fs
- salt.fileserver.svnfs
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.at
- salt.modules.augeas_cfg
- salt.modules.aws_sqs
- salt.modules.blockdev
- salt.modules.bluez
- salt.modules.boto_asg
- salt.modules.boto_cloudwatch
- salt.modules.boto_elasticache
- salt.modules.boto_elb
- salt.modules.boto_iam
- salt.modules.boto_route53
- salt.modules.boto_secgroup
- salt.modules.boto_sqs
- salt.modules.brew
- salt.modules.bridge
- salt.modules.bsd_shadow
- salt.modules.cassandra
- salt.modules.chef
- salt.modules.chocolatey
- salt.modules.cloud
- salt.modules.cmdmod
- salt.modules.composer
- salt.modules.config
- salt.modules.cp
- salt.modules.cron
- salt.modules.daemontools
- salt.modules.darwin_sysctl
- salt.modules.data
- salt.modules.ddns
- salt.modules.deb_apache
- salt.modules.debconfmod
- salt.modules.debian_ip
- salt.modules.debian_service
- salt.modules.defaults
- salt.modules.dig
- salt.modules.disk
- salt.modules.djangomod
- salt.modules.dnsmasq
- salt.modules.dnsutil
- salt.modules.dockerio
  - Management of Dockers
- salt.modules.dpkg
- salt.modules.ebuild
- salt.modules.eix
- salt.modules.environ
- salt.modules.eselect
- salt.modules.etcd_mod
- salt.modules.event
- salt.modules.extfs
- salt.modules.file
- 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.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.hosts
- salt.modules.htpasswd
- salt.modules.img
- salt.modules.incron
- salt.modules.influx
- salt.modules.ini_manage
- salt.modules.introspect
- salt.modules.ipset
- salt.modules.iptables
- salt.modules.junos
- 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
  - Module for Management of Memcached Keys
- salt.modules.mine
- salt.modules.mod_random
- salt.modules.modjk
- salt.modules.mongodb
- salt.modules.monit
- salt.modules.moosefs
- salt.modules.mount
- salt.modules.munin
- salt.modules.mysql
- salt.modules.nagios
- salt.modules.netbsd_sysctl
- salt.modules.netbsdservice
- salt.modules.network
- salt.modules.nfs3
- salt.modules.nftables
- salt.modules.nginx
- salt.modules.nova
- salt.modules.npm
- salt.modules.omapi
- salt.modules.openbsdpkg
- salt.modules.openbsdservice
- salt.modules.openstack_config
- salt.modules.oracle
- salt.modules.osxdesktop
- salt.modules.pacman
- salt.modules.pagerduty
- salt.modules.pam
- salt.modules.parted
- salt.modules.pecl
- salt.modules.pillar
- salt.modules.pip
  - Windows Support
    - State File Support
    - Upgrading Salt using 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.pw_group
- salt.modules.pw_user
- salt.modules.pyenv
- salt.modules.qemu_img
  - Qemu-img Command Wrapper
- salt.modules.qemu_nbd
  - Qemu Command Wrapper
- salt.modules.quota
- salt.modules.rabbitmq
- salt.modules.raet_publish
- salt.modules.rbenv
- salt.modules.rdp
- salt.modules.redis
- salt.modules.reg
- salt.modules.rest_package
- salt.modules.rest_sample
- salt.modules.rest_service
- salt.modules.ret
- salt.modules.rh_ip
- salt.modules.rh_service
- salt.modules.riak
  - Riak Salt Module
- salt.modules.rpm
- salt.modules.rsync
- salt.modules.rvm
- salt.modules.s3
- salt.modules.saltcloudmod
- salt.modules.saltutil
- salt.modules.schedule
- salt.modules.seed
- salt.modules.selinux
- salt.modules.sensors
- salt.modules.serverdensity_device
  - Wrapper around Server Density API
- salt.modules.service
- salt.modules.shadow
- salt.modules.smartos_imgadm
- salt.modules.smartos_vmadm
- salt.modules.smf
- salt.modules.smtp
- salt.modules.softwareupdate
- salt.modules.solaris_group
- salt.modules.solaris_shadow
- salt.modules.solaris_user
- salt.modules.solarispkg
- salt.modules.solr
  - Apache Solr Salt Module
- salt.modules.sqlite3
- salt.modules.ssh
- salt.modules.state
- salt.modules.status
- salt.modules.supervisord
- salt.modules.svn
- salt.modules.swift
- salt.modules.sysbench
- salt.modules.sysmod
- salt.modules.system
- salt.modules.systemd
- salt.modules.test
- salt.modules.timezone
- salt.modules.tls
- salt.modules.tomcat
- salt.modules.twilio_notify
- salt.modules.upstart
- salt.modules.useradd
- salt.modules.uwsgi
- salt.modules.varnish
- salt.modules.virt
- salt.modules.virtualenv
- salt.modules.win_autoruns
- 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_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.xapi
- salt.modules.xmpp
- salt.modules.yumpkg
- salt.modules.zcbuildout
  - Management of zc.buildout
    - General notes
- salt.modules.zfs
- 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.grains
  - Special outputter for grains
- salt.output.highstate
  - Outputter for displaying results of state runs
- salt.output.json_out
  - Display return data in JSON format
- salt.output.key
  - Display salt-key output
- salt.output.nested
  - Recursively display nested data
- salt.output.newline_values_only
  - Display values only, separated by newlines
    - Example 1
      - Input
      - Output
    - Example 2
      - Input
      - Output
- salt.output.no_out
  - Display no output
- salt.output.no_return
  - Display output for minions that did not return
- salt.output.overstatestage
  - Display clean output of an overstate stage
- salt.output.pprint_out
  - Python pretty-print (pprint)
- salt.output.raw
  - Display raw output data structure
- salt.output.txt
  - Simple text outputter
- salt.output.virt_query
  - virt.query outputter
- salt.output.yaml_out
  - Display return data in YAML format
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
  - Configuring the Cobbler ext_pillar
  - Module Documentation
- salt.pillar.django_orm
  - Configuring the django_orm ext_pillar
  - Module Documentation
- salt.pillar.etcd_pillar
- salt.pillar.foreman
  - Configuring the Foreman ext_pillar
  - Module Documentation
- salt.pillar.git_pillar
- salt.pillar.hiera
- salt.pillar.libvirt
- salt.pillar.mongo
- salt.pillar.mysql
- salt.pillar.pillar_ldap
- salt.pillar.puppet
- salt.pillar.reclass_adapter
- salt.pillar.redismod
- salt.pillar.s3
- salt.pillar.svn_pillar
- salt.pillar.virtkey
Renderers
- Multiple Renderers
- Composing Renderers
- Writing Renderers
- Examples
- Full List of Renderers
  - Full list of builtin renderer modules
Returners
- Using Returners
- Writing a Returner
- Full List of Returners
  - Full list of builtin returner modules
Full list of builtin roster modules
- salt.roster.flat
- salt.roster.scan
Salt Runners
- Writing Salt Runners
- Examples
State Enforcement
- Mod Aggregate State Runtime Modifications
  - How it Works
  - How to Use it
    - In config files
    - In states
  - Adding mod_aggregate to a State Module
- Altering States
- File State Backups
  - Backed-up Files
  - Interacting with Backups
- Understanding State Compiler Ordering
  - Compiler Basics
    - High Data and Low Data
  - Ordering Layers
- Extending External SLS Data
  - The Extend Declaration
  - Extend is a Top Level Declaration
  - The Requisite "in" Statement
  - Rules to Extend By
- Failhard Global Option
  - State Level Failhard
  - Global Failhard
- Global State Arguments
- Highstate data structure definitions
  - The Salt State Tree
  - Large example
- Include and Exclude
  - Include
  - Relative Include
  - Exclude
- State System Layers
  - Function Call
  - Low Chunk
  - Low State
  - High Data
  - SLS
  - HighState
  - OverState
- The Orchestrate Runner
- Ordering States
  - State Auto Ordering
  - Requisite Statements
    - Multiple Requisites
    - Requisite Documentation
  - The Order Option
- OverState System
- State Providers
  - Setting a Provider in the Minion Config File
  - Arbitrary Module Redirects
- Requisites and Other Global State Arguments
  - Requisites
    - Direct Requisite and Requisite_in types
  - Altering States
- Startup States
  - Examples:
- State Testing
  - Default Test
- The Top File
  - Environments
  - Other Ways of Targeting Minions
  - How Top Files Are Compiled
- SLS Template Variable Reference
  - Salt
  - Opts
  - Pillar
  - Grains
  - env
  - sls
- State Modules
  - States are Easy to Write!
  - Using Custom State Modules
  - Cross Calling Modules
  - Return Data
  - Test State
  - Watcher Function
  - Mod_init Interface
  - Full State Module Example
    - Example state module
- State Management
- Understanding the Salt State System Components
  - Salt SLS System
  - Reloading Modules
Full list of builtin state modules
- salt.states.alias
  - Configuration of email aliases
- salt.states.alternatives
  - Configuration of the alternatives system
- salt.states.apache
- salt.states.apache_module
  - Manage Apache Modules
- salt.states.apt
  - Package management operations specific to APT- and DEB-based systems
- salt.states.archive
- salt.states.at
  - Configuration disposable regularly scheduled tasks for at.
- salt.states.augeas
  - Configuration management using Augeas
- salt.states.aws_sqs
  - Manage SQS Queues
- salt.states.blockdev
  - Management of Block Devices
- salt.states.boto_asg
  - Manage Autoscale Groups
- salt.states.boto_cloudwatch_alarm
  - Manage Cloudwatch alarms
- salt.states.boto_elasticache
  - Manage Elasticache
- salt.states.boto_elb
  - Manage ELBs
- salt.states.boto_iam_role
  - Manage IAM roles.
- salt.states.boto_lc
  - Manage Launch Configurations
- salt.states.boto_route53
  - Manage Route53 records
- salt.states.boto_secgroup
  - Manage Security Groups
- salt.states.boto_sqs
  - Manage SQS Queues
- salt.states.cloud
  - Using states instead of maps to deploy clouds
- salt.states.cmd
  - Execution of arbitrary commands
    - Should I use cmd.run or cmd.wait?
    - How do I create an environment from a pillar map?
- salt.states.composer
  - Installation of Composer Packages
- salt.states.cron
  - Management of cron, the Unix command scheduler
- salt.states.ddns
  - Dynamic DNS updates
- salt.states.debconfmod
  - Management of debconf selections
    - Available Functions
- salt.states.disk
- salt.states.dockerio
  - Manage Docker containers
    - Available Functions
- salt.states.environ
- salt.states.eselect
  - Management of Gentoo configuration using eselect
- salt.states.event
- salt.states.file
  - Operations on regular files, special files, directories, and symlinks
- salt.states.gem
  - Installation of Ruby modules packaged as gems
- salt.states.git
  - Interaction with Git repositories
- salt.states.glusterfs
- salt.states.gnomedesktop
  - Configuration of the GNOME desktop
- salt.states.grains
  - Manage grains on the minion
- salt.states.group
  - Management of user groups
- salt.states.hg
  - Interaction with Mercurial repositories
- salt.states.host
  - Management of addresses and names in hosts file
- salt.states.htpasswd
- salt.states.incron
  - Management of incron, the inotify cron
- salt.states.influxdb_database
  - Management of InfluxDB databases
- salt.states.influxdb_user
  - Management of InfluxDB users
- salt.states.ini_manage
  - Manage ini files
- salt.states.ipset
  - Management of ipsets
- salt.states.iptables
  - Management of iptables
- salt.states.keyboard
  - Management of keyboard layouts
- salt.states.keystone
  - Management of Keystone users
- salt.states.kmod
  - Loading and unloading of kernel modules
- salt.states.layman
  - Management of Gentoo Overlays using layman
- salt.states.libvirt
  - Manage libvirt certificates
- salt.states.locale
  - Management of languages/locales
- salt.states.lvm
  - Management of Linux logical volumes
- salt.states.lvs_server
  - Management of LVS (Linux Virtual Server) Real Server
- salt.states.lvs_service
  - Management of LVS (Linux Virtual Server) Service
- salt.states.lxc
  - lxc / Spin up and control LXC containers
- salt.states.makeconf
  - Management of Gentoo make.conf
- salt.states.mdadm
  - Managing software RAID with mdadm
- salt.states.memcached
  - States for Management of Memcached Keys
- salt.states.modjk
- salt.states.modjk_worker
  - Manage modjk workers
- salt.states.module
  - Execution of Salt modules from within states
- salt.states.mongodb_database
- salt.states.mongodb_user
  - Management of Mongodb users
- salt.states.mount
  - Mounting of filesystems
- salt.states.mysql_database
  - Management of MySQL databases (schemas)
- salt.states.mysql_grants
  - Management of MySQL grants (user permissions)
- salt.states.mysql_query
  - Execution of MySQL queries
- salt.states.mysql_user
  - Management of MySQL users
- salt.states.network
  - Configuration of network interfaces
- salt.states.nftables
  - Management of nftables
- salt.states.npm
  - Installation of NPM Packages
- salt.states.ntp
  - Management of NTP servers
- salt.states.openstack_config
- salt.states.pagerduty
  - Create an Event in PagerDuty
- salt.states.pecl
  - Installation of PHP Extensions Using pecl
- salt.states.pip_state
  - Installation of Python Packages Using pip
- salt.states.pkg
  - Installation of packages using OS package managers such as yum or apt-get
- salt.states.pkgng
  - Manage package remote repo using FreeBSD pkgng
- salt.states.pkgrepo
  - Management of APT/YUM package repos
- salt.states.portage_config
  - Management of Portage package configuration on Gentoo
- salt.states.ports
- salt.states.postgres_database
  - Management of PostgreSQL databases
- salt.states.postgres_extension
  - Management of PostgreSQL extensions (e.g.: postgis)
- salt.states.postgres_group
  - Management of PostgreSQL groups (roles)
- salt.states.postgres_user
  - Management of PostgreSQL users (roles)
- salt.states.powerpath
  - Powerpath configuration support
- salt.states.process
  - Process Management
- salt.states.pyenv
  - Managing python installations with pyenv
- salt.states.quota
  - Management of POSIX Quotas
- salt.states.rabbitmq_cluster
  - Manage RabbitMQ Clusters
- salt.states.rabbitmq_plugin
  - Manage RabbitMQ Plugins
- salt.states.rabbitmq_policy
  - Manage RabbitMQ Policies
- salt.states.rabbitmq_user
  - Manage RabbitMQ Users
- salt.states.rabbitmq_vhost
  - Manage RabbitMQ Virtual Hosts
- salt.states.rbenv
  - Managing Ruby installations with rbenv
- salt.states.rdp
- salt.states.redismod
  - Management of Redis server
- salt.states.reg
- salt.states.rvm
  - Managing Ruby installations and gemsets with Ruby Version Manager (RVM)
- salt.states.saltmod
  - Control the Salt command interface
- salt.states.schedule
  - Management of the Salt scheduler
- salt.states.selinux
  - Management of SELinux rules
- salt.states.serverdensity_device
  - Monitor Server with Server Density
- salt.states.service
  - Starting or restarting of services and daemons
- salt.states.smtp
  - Sending Messages via SMTP
- salt.states.ssh_auth
  - Control of entries in SSH authorized_key files
- salt.states.ssh_known_hosts
  - Control of SSH known_hosts entries
- salt.states.stateconf
  - Stateconf System
- salt.states.status
- salt.states.supervisord
  - Interaction with the Supervisor daemon
- salt.states.svn
  - Manage SVN repositories
- salt.states.sysctl
  - Configuration of the Linux kernel using sysctl
- salt.states.test
  - Test States
- salt.states.timezone
  - Management of timezones
- salt.states.tomcat
- salt.states.user
  - Management of user accounts
- salt.states.virtualenv
  - Setup of Python virtualenv sandboxes
- salt.states.win_dns_client
- salt.states.win_firewall
- salt.states.win_network
  - Configuration of network interfaces on Windows hosts
- salt.states.win_path
- salt.states.win_servermanager
- salt.states.win_system
  - Management of Windows system information
- salt.states.win_update
  - Management of the windows update agent
- salt.states.winrepo
- salt.states.xmpp
  - Sending Messages over XMPP
- salt.states.zcbuildout
  - Management of zc.buildout
    - Available Functions
- salt.states.zk_concurrency
  - Control concurrency of steps within state execution using zookeeper
Execution Modules
- Modules Are Easy to Write!
- Cross-Calling Modules
- Preloaded Execution Module Data
  - Grains Data
  - Module Configuration
- Printout Configuration
- Virtual Modules
- Documentation
  - Adding Documentation to Salt Modules
  - Add Execution Module Metadata
- Private Functions
  - Objects Loaded Into the Salt Minion
  - Objects NOT Loaded into the Salt Minion
- Useful Decorators for Modules
  - Depends Decorator
Master Tops
Full list of builtin master tops modules
- salt.tops.cobbler
  - Cobbler Tops
  - Module Documentation
- salt.tops.ext_nodes
  - External Nodes Classifier
- 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.pillar_roots