Navigation
modules
next
|
« SaltStack.org
|
Documentation home
Full Table of Contents
ΒΆ
Introduction to Salt
Distributed remote execution
Simplicity
Parallel execution
Building on proven technology
Python client interface
Fast, flexible, scalable
Open
Installation
Dependencies
Optional Dependencies
Platform-specific installation instructions
Arch Linux
Debian & Ubuntu
Fedora & CentOS / Enterprise Linux
FreeBSD
Gentoo
Windows
Configuring Salt
Running Salt
Manage Salt public keys
Targeting
Matching the
minion
id
Globbing
Regular Expressions
Lists
Grains
Grains in the Minion Config
Writing Grains
Node groups
Compound matchers
Batch Size
Remote execution tutorial
Order your minions around
target
function
arguments
How Do I Use Salt States?
It is All Just Data
Default Data - YAML
Adding Configs and Users
Moving Beyond a Single SLS
Extending Included SLS Data
Understanding the Render System
Getting to Know the Default - yaml_jinja
Introducing the Python Renderer
States tutorial, part 1
Setting up the Salt State Tree
Preparing the Top File
Create an
sls
module
Install the package
Next steps
States tutorial, part 2
Call multiple States
Expand the SLS module
Require other states
Next steps
States tutorial, part 3
Templating SLS modules
Using Grains in SLS modules
Calling Salt modules from templates
Advanced SLS module syntax
Include
declaration
Extend
declaration
Name
declaration
Names
declaration
Continue learning
Opening the Firewall up for Salt
iptables
pf.conf
Bootstrapping Salt on Linux EC2 with Cloud-Init
Used With Boto
Additional Notes
Pillar of Salt
Declaring the Master Pillar
Footnotes
Refreshing Pillar Data
Targeting with Pillar
Job Management
The Minion proc System
Functions in the saltutil Module
The jobs Runner
active
lookup_jid
list_jobs
Running the Salt Master as Unprivileged User
Troubleshooting
Running in the Foreground
What Ports do the Master and Minion Need Open?
Using salt-call
Too many open files
Salt Master Stops Responding
Salt and SELinux
Red Hat Enterprise Linux 5
Common YAML Gotchas
YAML Idiosyncrasies
Spaces vs Tabs
Indentation
Nested Dicts (key=value)
Integers are Parsed as Integers
YAML does not like "Double Short Decs"
Community
Mailing List
IRC
Follow on Github
The Red45 Blog
Example Salt States
Follow on ohloh
Developing Salt
Posting patches to the mailing list
Setting a Github pull request
Contributions Welcome!
Standalone Minion
Telling Salt Call to Run Masterless
Running States Masterless
Salt Based Projects
Salt Sandbox
Salt Event System
Listening for Events
Introduction to Extending Salt
Client API
Adding Loadable Plugins
Minion Execution Modules
Grains
States
Renderers
Returners
Runners
Modules
Easy Modules to write
Cross Calling Modules
Preloaded Modules Data
Grains Data
Module Configuration
Printout Configuration
Virtual Modules
Documentation
Adding Documentation to Salt Modules
How Functions are Read
Objects Loaded Into the Salt Minion
Objects NOT Loaded into the Salt Minion
Examples of Salt Modules
Full list of builtin modules
salt.modules.pkg
salt.modules.sys
salt.modules.aliases
get_target
has_target
list_aliases
rm_alias
set_target
salt.modules.apache
directives
fullversion
modules
servermods
signal
version
vhosts
salt.modules.apt
available_version
install
list_pkgs
list_upgrades
purge
refresh_db
remove
upgrade
upgrade_available
version
salt.modules.archive
gunzip
gzip
rar
tar
unrar
unzip
zip
salt.modules.brew
install
list_pkgs
list_upgrades
remove
upgrade_available
version
salt.modules.butterkvm
create
full_butter_data
libvirt_creds
local_images
salt.modules.cluster
distrib
salt.modules.cmdmod
exec_code
has_exec
retcode
run
run_all
run_stderr
run_stdout
shell_grain
which
which_bin
salt.modules.cp
cache_dir
cache_file
cache_files
cache_local_file
cache_master
get_dir
get_file
get_template
get_url
hash_file
is_cached
list_master
list_minion
list_states
recv
salt.modules.cron
list_tab
ls
raw_cron
rm
rm_env
rm_job
set_env
set_job
set_special
salt.modules.data
clear
dump
getval
getvals
load
update
salt.modules.debconfmod
get_selections
set
set_file
show
salt.modules.disk
inodeusage
usage
salt.modules.django
collectstatic
command
createsuperuser
loaddata
syncdb
salt.modules.ebuild
available_version
install
list_pkgs
purge
refresh_db
remove
update
upgrade
version
salt.modules.file
append
chgrp
chown
comment
contains
contains_glob
contains_regex
find
get_gid
get_group
get_mode
get_sum
get_uid
get_user
gid_to_group
group_to_gid
sed
set_mode
stats
touch
uid_to_user
uncomment
user_to_uid
salt.modules.freebsdjail
fstab
get_enabled
is_enabled
restart
show_config
start
status
stop
sysctl
salt.modules.freebsdkmod
available
check_available
load
lsmod
remove
salt.modules.freebsdpkg
available_version
install
list_pkgs
purge
refresh_db
rehash
remove
search
upgrade
version
salt.modules.freebsdservice
get_all
get_disabled
get_enabled
restart
start
status
stop
salt.modules.gem
install
list
sources_add
sources_list
sources_remove
uninstall
update
update_system
salt.modules.gentoo_service
disable
disabled
enable
enabled
get_all
get_disabled
get_enabled
restart
start
status
stop
salt.modules.git
archive
checkout
clone
describe
fetch
init
merge
pull
rebase
revision
salt.modules.grains
item
items
ls
salt.modules.groupadd
add
chgid
delete
getent
info
salt.modules.grub
conf
version
salt.modules.hg
archive
clone
describe
pull
revision
update
salt.modules.hosts
add_host
get_alias
get_ip
has_pair
list_hosts
rm_host
set_host
salt.modules.kmod
available
check_available
load
lsmod
remove
salt.modules.kvm_hyper
freecpu
freemem
get_conf
get_disks
halt
hyper_info
hyper_type
init
list_virts
pause
purge
resume
set_autostart
start
virt_info
salt.modules.launchctl
get_all
get_launchctl_data
restart
start
status
stop
salt.modules.linux_sysctl
assign
get
persist
show
salt.modules.mdadm
detail
list
salt.modules.moosefs
dirinfo
fileinfo
getgoal
mounts
salt.modules.mount
active
fstab
is_fuse_exec
mount
remount
rm_fstab
set_fstab
salt.modules.mysql
connect
db_check
db_create
db_exists
db_list
db_optimize
db_remove
db_repair
db_tables
free_slave
grant_add
grant_exists
grant_revoke
slave_lag
status
user_chpass
user_create
user_exists
user_grants
user_info
user_list
user_remove
version
salt.modules.network
dig
host_to_ip
hwaddr
interfaces
ip_to_host
ipaddr
isportopen
netmask
netstat
ping
traceroute
up
salt.modules.nginx
signal
version
salt.modules.osxdesktop
get_output_volume
lock
screensaver
set_output_volume
salt.modules.pacman
available_version
install
list_pkgs
list_upgrades
purge
refresh_db
remove
upgrade
upgrade_available
version
salt.modules.pillar
data
salt.modules.pip
freeze
install
list
uninstall
salt.modules.postgres
check_or_die
db_create
db_exists
db_list
db_remove
user_create
version
salt.modules.ps
boot_time
cached_physical_memory
cpu_percent
cpu_times
disk_io_counters
disk_partition_usage
disk_partitions
disk_usage
get_pid_list
network_io_counters
num_cpus
physical_memory_buffers
physical_memory_usage
top
total_physical_memory
virtual_memory_usage
salt.modules.publish
full_data
publish
runner
salt.modules.puppet
fact
facts
noop
run
salt.modules.pw_group
add
chgid
delete
getent
info
salt.modules.pw_user
add
chgid
chgroups
chhome
chshell
chuid
delete
getent
info
list_groups
salt.modules.rabbitmq_server
add_user
add_vhost
delete_user
delete_vhost
list_user_permissions
list_users
list_vhosts
set_permissions
salt.modules.reg
create_key
delete_key
read_key
set_key
salt.modules.rh_ip
build_bond
build_interface
down
exists
get_bond
get_interface
join
up
salt.modules.rh_service
disable
disabled
enable
enabled
get_all
get_disabled
get_enabled
restart
start
status
stop
salt.modules.rvm
do
gemset_copy
gemset_create
gemset_delete
gemset_empty
gemset_list
gemset_list_all
get
install
install_ruby
is_installed
list
reinstall_ruby
rubygems
set_default
wrapper
salt.modules.saltutil
find_job
kill_job
refresh_pillar
running
signal_job
sync_all
sync_grains
sync_modules
sync_renderers
sync_returners
sync_states
term_job
salt.modules.selinux
getenforce
getsebool
list_sebool
selinux_fs_path
setenforce
setsebool
setsebools
salt.modules.service
reload
restart
start
status
stop
salt.modules.shadow
info
set_inactdays
set_maxdays
set_mindays
set_password
set_warndays
salt.modules.solr
Apache Solr Salt Module
abort_import
backup
core_status
delta_import
full_import
import_status
is_replication_enabled
lucene_version
match_index_versions
optimize
ping
reload_core
reload_import_config
replication_details
set_is_polling
set_replication_enabled
signal
url_open
version
salt.modules.sqlite3
fetch
indexes
indices
modify
sqlite_version
tables
version
salt.modules.ssh
auth_keys
check_key
check_key_file
check_known_host
get_known_host
host_keys
recv_known_host
rm_auth_key
rm_known_host
set_auth_key
set_auth_key_from_file
set_known_host
salt.modules.state
high
highstate
low
show_highstate
show_lowstate
show_masterstate
show_sls
single
sls
template
template_str
top
salt.modules.status
all_status
cpuinfo
cpustats
custom
diskstats
diskusage
loadavg
meminfo
netdev
netstats
procs
uptime
vmstats
w
salt.modules.systemd
disable
disabled
enable
enabled
get_all
get_disabled
get_enabled
reload
restart
start
status
stop
salt.modules.test
collatz
conf_test
cross_test
echo
fib
get_opts
kwarg
outputter
ping
version
salt.modules.tomcat
fullversion
signal
version
salt.modules.upstart
disable
disabled
enable
enabled
get_all
get_disabled
get_enabled
restart
start
status
stop
salt.modules.useradd
add
callable
chfullname
chgid
chgroups
chhome
chhomephone
chother
chroomnumber
chshell
chuid
chworkphone
delete
getent
info
list_groups
salt.modules.virt
create
create_xml_path
create_xml_str
destroy
freecpu
freemem
full_info
get_disks
get_graphics
get_macs
get_nics
get_xml
is_hyper
is_kvm_hyper
is_xen_hyper
list_active_vms
list_inactive_vms
list_vms
migrate
migrate_non_shared
migrate_non_shared_inc
node_info
pause
purge
resume
seed_non_shared_migrate
set_autostart
shutdown
start
undefine
virt_type
vm_info
vm_state
salt.modules.virtualenv
create
salt.modules.win_disk
usage
salt.modules.win_file
append
chgrp
chown
comment
contains
find
get_gid
get_group
get_mode
get_sum
get_uid
get_user
gid_to_group
group_to_gid
sed
touch
uid_to_user
uncomment
user_to_uid
salt.modules.win_groupadd
add
delete
getent
info
salt.modules.win_network
dig
hwaddr
interfaces
ipaddr
isportopen
netmask
netstat
nslookup
ping
traceroute
up
salt.modules.win_pkg
available_version
install
list_pkgs
list_upgrades
purge
refresh_db
remove
upgrade
upgrade_available
version
salt.modules.win_service
disable
disabled
enable
enabled
get_all
get_disabled
get_enabled
getsid
restart
start
status
stop
salt.modules.win_shadow
info
set_password
salt.modules.win_useradd
add
addgroup
chgroups
chhome
chprofile
delete
getent
info
list_groups
removegroup
setpassword
salt.modules.yumpkg
available_version
clean_metadata
install
list_pkgs
list_upgrades
purge
refresh_db
remove
upgrade
upgrade_available
version
salt.modules.yumpkg5
available_version
install
list_pkgs
list_upgrades
namedtuple
purge
refresh_db
remove
upgrade
upgrade_available
version
salt.modules.zypper
available_version
install
list_pkgs
purge
refresh_db
remove
upgrade
version
Returners
Using Returners
Writing a Returner
Examples
Full list of builtin returners
salt.returners.local
returner
salt.returners.cassandra_return
returner
salt.returners.mongo_return
returner
salt.returners.redis_return
returner
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
Highstate data structure definitions
The Salt State Tree
Include declaration
Module reference
ID declaration
Extend declaration
State declaration
Requisite declaration
Requisite reference
Function declaration
Function arg declaration
Name declaration
Names declaration
Large example
State Enforcement
State management
Understanding the Salt State System Components
Salt SLS System
Renderer System
Ordering States
Requisite Statements
Multiple Requisites
The Require Requisite
The Watch Requisite
Watch and the Watcher Function
The Order Option
State Providers
Arbitrary Module Redirects
Requisites
Requisite and Requisite in types
Require
Watch
Use
The Top File
Environments
Other Ways of Targeting Minions
State Modules
States are - Easy to Write!
Using Custom State Modules
Cross Calling Modules
Return Data
Watcher Function
Mod_init Interface
Full list of builtin states
salt.states.alias
Configuration of email aliases.
absent
present
salt.states.cmd
Execution of arbitrary commands.
mod_watch
run
wait
salt.states.cron
Management of cron, the Unix command scheduler.
absent
present
salt.states.file
Operations on files, directories and symlinks.
absent
append
comment
directory
managed
nested
recurse
sed
symlink
touch
uncomment
urlparse
salt.states.gem
Installation of Ruby modules packaged as gems.
installed
removed
salt.states.git
Interaction with Git repositories.
latest
salt.states.group
Management of user groups.
absent
present
salt.states.host
Management of addresses and names in hosts file.
absent
present
salt.states.kmod
Loading and unloading of kernel modules.
absent
present
salt.states.mount
Mounting of filesystems.
mounted
salt.states.mysql_database
Management of MySQL databases (schemas).
absent
present
salt.states.mysql_grants
Management of MySQL grants (user permissions).
absent
present
salt.states.mysql_user
Management of MySQL users.
absent
present
salt.states.network
Configuration of network interfaces.
managed
salt.states.pip
Installation of Python packages using pip.
installed
removed
salt.states.pkg
Installation of packages using OS package managers such as yum or apt-get.
installed
latest
mod_init
purged
removed
salt.states.postgres_database
Management of PostgreSQL databases (schemas).
absent
present
salt.states.rvm
Management of Ruby installations and gemsets with RVM, the Ruby Version Manager.
gemset_present
installed
salt.states.selinux
Management of SELinux rules.
boolean
mode
salt.states.service
Starting or restarting of services and daemons.
dead
disabled
enabled
mod_watch
running
salt.states.ssh_auth
Control of entries in SSH authorized_key files.
absent
present
salt.states.ssh_known_hosts
Control of SSH known_hosts entries.
absent
present
salt.states.sysctl
Configuration of the Linux kernel using sysctrl.
present
salt.states.user
Management of user accounts.
absent
present
salt.states.virtualenv
Setup of Python virtualenv sandboxes.
manage
managed
Renderers
Multiple Renderers
Writing Renderers
Examples
Full list of builtin renderers
salt.renderers.json_jinja
render
salt.renderers.json_mako
render
salt.renderers.yaml_jinja
render
salt.renderers.yaml_mako
render
salt.renderers.py
render
Salt Runners
Writing Salt Runners
Examples
Peer Communication
Peer Configuration
Peer Runner Communication
Using Peer Communiction
Salt Syndic
Configuring the Syndic
Running the Syndic
Python client API
Using the LocalClient API
Compound Command Execution With the Salt API
Salt File Server
The cp Module
Environments
get_file
File Server Client API
FileClient Class
File Server Configuration
Environments
Directory Overlay
Local File Server
Dynamic Module Distribution
Sync Via States
Sync Via the saltutil Module
Configuration file examples
Example master configuration file
Example minion configuration file
Configuring the Salt Master
Primary Master Configuration
interface
publish_port
user
worker_threads
ret_port
root_dir
pki_dir
cachedir
keep_jobs
job_cache
sock_dir
Master Security Settings
open_mode
auto_accept
Master Module Management
runner_dirs
cython_enable
Master State System Settings
state_top
external_nodes
renderer
failhard
test
Master File Server Settings
file_roots
hash_type
file_buffer_size
Pillar Configuration
pillar_roots
ext_pillar
Syndic Server Settings
order_masters
syndic_master
Peer Publish Settings
peer
peer_run
Node Groups
Master Logging Settings
log_file
log_level
log_granular_levels
Configuring the Salt Minion
Minion Primary Configuration
master
master_port
user
pki_dir
id
sub_timeout
cachedir
cache_jobs
acceptance_wait_time
Minion Module Management
disable_modules
disable_returners
module_dirs
returner_dirs
states_dirs
render_dirs
cython_enable
State Management Settings
renderer
state_verbose
autoload_dynamic_modules
environment
Security Settings
open_mode
Thread Settings
Minion Logging Settings
log_file
log_level
log_granular_levels
Command Line Reference
Using the Salt Command
Defining the Target Minions
More Powerful Targets
Calling the Function
Compound Command Execution
salt
Synopsis
Description
Options
See also
salt-master
Synopsis
Description
Options
See also
salt-minion
Synopsis
Description
Options
See also
salt-key
Synopsis
Description
Options
salt-cp
Synopsis
Description
Options
See also
salt-call
Synopsis
Options
See also
salt-run
Synopsis
Description
Options
See also
salt-syndic
Synopsis
Description
Options
See also
Abstract on Salt Authentication and Encryption
Message Formatting
PubKey Handshake
Regular Communication
Source Files Implimenting Components
Conclusion
Release notes and upgrade instructions
Salt 0.10.0 Release Notes
Major Features
State Call Data Files
Turning Off the Job Cache
Test Updates
Many Fixes
Salt 0.9.9 Release Notes
Major Features
New Tests
Salt 0.9.8 Release Notes
Upgrade Considerations
Major Features
In Progress Development
Salt 0.9.7 Release Notes
Major Features
Salt 0.9.6 Release Notes
New Features
Salt 0.9.5 Release Notes
Community
Major Features
Packaging Updates
Refinement
Salt 0.9.4 Release Notes
Download!
New Features
Salt 0.9.3 Release Notes
Download!
New Features
Module and State Additions
Salt 0.9.2 Release Notes
Download!
New Features
Notable Bug Fixes
Salt 0.9.0 Release Notes
Download!
New Features
New Modules
Salt 0.8.9 Release Notes
Download!
New Features
New Modules
Salt 0.8.8 release notes
Salt 0.8.7 release notes
Salt 0.8.0 release notes
Salt-cp -
Cython minion modules -
Dynamic Returners -
Configurable Minion Modules -
Advanced Minion Threading:
Salt 0.7.0 release notes
Salt 0.6.0 release notes
Next topic
Introduction to Salt
Quick search
Enter search terms or a module, class or function name.
Navigation
modules
next
|
« SaltStack.org
|
Documentation home