salt/doc/ref/modules/all/index.rst

.. _all-salt.modules:

======================================
Full list of builtin execution modules
======================================

.. admonition:: Virtual modules

    .. toctree::

        salt.modules.pkg
        salt.modules.sys

.. currentmodule:: salt.modules

.. autosummary::
    :toctree:
    :template: autosummary.rst.tmpl

    aliases
    alternatives
    apache
    apt
    archive
    at
    augeas_cfg
    bluez
    brew
    bridge
    bsd_shadow
    cassandra
    cmd
    config
    cp
    cron
    daemontools
    darwin_sysctl
    data
    ddns
    debconfmod
    debian_service
    dig
    disk
    djangomod
    dnsmasq
    dnsutil
    dpkg
    ebuild
    eix
    eselect
    event
    extfs
    file
    freebsdjail
    freebsdkmod
    freebsdpkg
    freebsdservice
    freebsd_sysctl
    gem
    gentoolkitmod
    gentoo_service
    git
    glance
    grains
    groupadd
    grub_legacy
    guestfs
    hg
    hosts
    img
    iptables
    keyboard
    key
    keystone
    kmod
    launchctl
    layman
    ldapmod
    linux_acl
    linux_lvm
    linux_sysctl
    localemod
    locate
    logrotate
    makeconf
    match
    mdadm
    mine
    modjk
    mongodb
    monit
    moosefs
    mount
    munin
    mysql
    netbsdservice
    netbsd_sysctl
    network
    nfs3
    nginx
    nova
    npm
    nzbget
    openbsdpkg
    openbsdservice
    osxdesktop
    pacman
    pam
    parted
    pecl
    pillar
    pip
    pkgin
    pkgng
    pkg_resource
    pkgutil
    portage_config
    postgres
    poudriere
    ps
    publish
    puppet
    pw_group
    pw_user
    qemu_img
    qemu_nbd
    quota
    rabbitmq
    rbenv
    reg
    ret
    rh_ip
    rh_service
    rpm
    rvm
    s3
    saltutil
    selinux
    service
    shadow
    smartos_imgadm
    smartos_vmadm
    smf
    solaris_group
    solarispkg
    solaris_shadow
    solaris_user
    solr
    sqlite3
    ssh
    state
    status
    supervisord
    svn
    sysbench
    sysmod
    systemd
    system
    test
    timezone
    tls
    tomcat
    upstart
    useradd
    virt
    virtualenv
    win_disk
    win_file
    win_groupadd
    win_network
    win_pkg
    win_service
    win_shadow
    win_status
    win_system
    win_useradd
    xapi
    yumpkg5
    yumpkg
    zfs
    zpool
    zypper
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`.. _all-salt.modules:`

Normalized the "all" modules pages to use the qualified module term 2012-10-30 00:23:56 +00:00			`======================================`
			`Full list of builtin execution modules`
			`======================================`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00
Silence autosummary warnings about the virtual modules This change also explicitly shows which modules are virtual. 2012-03-19 11:59:20 +00:00			`.. admonition:: Virtual modules`

			`.. toctree::`

			`salt.modules.pkg`
			`salt.modules.sys`

Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`.. currentmodule:: salt.modules`

			`.. autosummary::`
			`:toctree:`
Revert "Merge branch 'doc-autosummary-headings' into develop" This reverts commit 7997ed4842e4c14134d310939e7e591c2de7dda6, reversing changes made to 83c901a17448e8557e599e072cf4910905d00ec9. 2012-07-09 23:03:40 +00:00			`:template: autosummary.rst.tmpl`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00
Add aliases to doc index 2012-05-26 14:31:38 +00:00			`aliases`
Added missing new modules of varying types 2013-01-11 21:37:01 +00:00			`alternatives`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`apache`
			`apt`
Added a few missing modules to the module index 2011-11-27 17:41:22 +00:00			`archive`
Added new/missing modules/states to docs TOC & generated files 2012-10-04 20:43:44 +00:00			`at`
Add augeas module to documentation 2012-07-10 14:46:49 +00:00			`augeas_cfg`
Added missing modules/states/renderers docs to reference TOC 2012-07-30 07:45:34 +00:00			`bluez`
Add brew module to docs 2012-05-26 14:33:35 +00:00			`brew`
Added new module docs 2013-06-06 22:39:22 +00:00			`bridge`
Added bsd_shadow and portage_config execution/state module docs 2013-07-03 21:22:58 +00:00			`bsd_shadow`
Added missing modules/states/renderers docs to reference TOC 2012-07-30 07:45:34 +00:00			`cassandra`
`salt.modules.cmdmod` renamed to `salt.modules.cmd` while enforcing absolute imports. 2013-08-19 12:45:56 +00:00			`cmd`
Added new/missing modules/states to docs TOC & generated files 2012-10-04 20:43:44 +00:00			`config`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`cp`
			`cron`
Added daemontools module docs 2012-10-30 00:28:35 +00:00			`daemontools`
Added docs for new execution & state modules 2013-04-30 20:06:16 +00:00			`darwin_sysctl`
Added new modules, states, returners docs 2012-01-16 05:43:40 +00:00			`data`
Audit module documentation (A to D) This commit formats shell examples using bash code-block directives, so that they get syntax highlighting. It also adds missing doc pages for the ddns module. 2013-08-15 00:53:09 +00:00			`ddns`
Rename the debconf salt module to fix conflicts >>> import debconf >>> debconf.__file__ '/usr/lib/python2.6/dist-packages/debconf.py' 2012-03-17 23:51:08 +00:00			`debconfmod`
Add debian_service to documentation 2012-07-23 22:49:17 +00:00			`debian_service`
Added new module docs 2013-06-06 22:39:22 +00:00			`dig`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`disk`
Added new/missing modules/states to docs TOC & generated files 2012-10-04 20:43:44 +00:00			`djangomod`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`dnsmasq`
			`dnsutil`
			`dpkg`
Added a few missing modules to the module index 2011-11-27 17:41:22 +00:00			`ebuild`
Added docs for eix modules 2013-01-02 22:30:43 +00:00			`eix`
Added new module docs 2013-06-06 22:39:22 +00:00			`eselect`
Added missing modules/states/renderers docs to reference TOC 2012-07-30 07:45:34 +00:00			`event`
Added docs for new modules 2012-12-02 23:09:43 +00:00			`extfs`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`file`
Add freebsdjail to module doc index 2012-05-26 14:35:53 +00:00			`freebsdjail`
Added new modules, states, returners docs 2012-01-16 05:43:40 +00:00			`freebsdkmod`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`freebsdpkg`
Add some new module docs and update release notes 2012-03-17 23:44:22 +00:00			`freebsdservice`
Added/updated docs on new/changed execution modules 2012-11-14 19:48:27 +00:00			`freebsd_sysctl`
Add rvm and gem modules to the all modules doc index 2012-03-17 22:21:40 +00:00			`gem`
Added docs for gentoolkitmod module 2013-01-02 22:34:26 +00:00			`gentoolkitmod`
Added new modules, states, returners docs 2012-01-16 05:43:40 +00:00			`gentoo_service`
Add some new module docs and update release notes 2012-03-17 23:44:22 +00:00			`git`
Added/updated docs on new/changed execution modules 2012-11-14 19:48:27 +00:00			`glance`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`grains`
			`groupadd`
Added docs for new modules 2012-12-02 23:09:43 +00:00			`grub_legacy`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`guestfs`
Add some new module docs and update release notes 2012-03-17 23:44:22 +00:00			`hg`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`hosts`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`img`
Added docs for new modules 2012-12-02 23:09:43 +00:00			`iptables`
			`keyboard`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`key`
Added/updated docs on new/changed execution modules 2012-11-14 19:48:27 +00:00			`keystone`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`kmod`
Add launchctl to docs 2012-05-26 14:42:40 +00:00			`launchctl`
Added docs for layman module 2013-01-02 22:31:53 +00:00			`layman`
Added/updated docs on new/changed execution modules 2012-11-14 19:48:27 +00:00			`ldapmod`
Added missing new modules of varying types 2013-01-11 21:37:01 +00:00			`linux_acl`
			`linux_lvm`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`linux_sysctl`
Update rst docs to reflect rename to salt/modules/localemod.py This updates the rst docs to match the change made in ef90d58. 2013-06-06 22:48:59 +00:00			`localemod`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`locate`
			`logrotate`
Added docs for makeconf module 2013-01-05 07:14:08 +00:00			`makeconf`
Added docs for new execution & state modules 2013-04-30 20:06:16 +00:00			`match`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`mdadm`
Added docs for new execution & state modules 2013-04-30 20:06:16 +00:00			`mine`
Add rst pages for new modjk state/module This commit tells sphinx to build doc pages for these new files, and adds them to the table of contents. 2013-08-13 16:02:44 +00:00			`modjk`
Added new/missing modules/states to docs TOC & generated files 2012-10-04 20:43:44 +00:00			`mongodb`
Added missing modules/states/renderers docs to reference TOC 2012-07-30 07:45:34 +00:00			`monit`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`moosefs`
			`mount`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`munin`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`mysql`
Added new module docs 2013-06-06 22:39:22 +00:00			`netbsdservice`
			`netbsd_sysctl`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`network`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`nfs3`
Add some new module docs and update release notes 2012-03-17 23:44:22 +00:00			`nginx`
Added/updated docs on new/changed execution modules 2012-11-14 19:48:27 +00:00			`nova`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`npm`
Added missing modules/states/renderers docs to reference TOC 2012-07-30 07:45:34 +00:00			`nzbget`
			`openbsdpkg`
			`openbsdservice`
Add osxdesktop to module doc index 2012-05-26 14:44:52 +00:00			`osxdesktop`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`pacman`
Added docs for new modules 2012-12-02 23:09:43 +00:00			`pam`
			`parted`
Added new/missing modules/states to docs TOC & generated files 2012-10-04 20:43:44 +00:00			`pecl`
Add some new module docs and update release notes 2012-03-17 23:44:22 +00:00			`pillar`
Added new modules, states, returners docs 2012-01-16 05:43:40 +00:00			`pip`
Added new module docs 2013-06-06 22:39:22 +00:00			`pkgin`
Added missing modules/states/renderers docs to reference TOC 2012-07-30 07:45:34 +00:00			`pkgng`
Added docs for new modules 2012-12-02 23:09:43 +00:00			`pkg_resource`
Added / updated module docs 2012-10-25 17:52:39 +00:00			`pkgutil`
Added bsd_shadow and portage_config execution/state module docs 2013-07-03 21:22:58 +00:00			`portage_config`
Add postgres doc to index 2012-05-26 14:47:50 +00:00			`postgres`
Added missing modules/states/renderers docs to reference TOC 2012-07-30 07:45:34 +00:00			`poudriere`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`ps`
			`publish`
			`puppet`
			`pw_group`
			`pw_user`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`qemu_img`
			`qemu_nbd`
			`quota`
Added / updated module docs 2012-10-25 17:52:39 +00:00			`rabbitmq`
Added new module docs 2013-06-06 22:39:22 +00:00			`rbenv`
Add reg to doc index 2012-05-26 14:56:06 +00:00			`reg`
Added/updated docs on new/changed execution modules 2012-11-14 19:48:27 +00:00			`ret`
Updated docs for rh_network module rename to rh_ip 2012-04-26 05:09:11 +00:00			`rh_ip`
Added new modules, states, returners docs 2012-01-16 05:43:40 +00:00			`rh_service`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`rpm`
Add rvm and gem modules to the all modules doc index 2012-03-17 22:21:40 +00:00			`rvm`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`s3`
Added new modules, states, returners docs 2012-01-16 05:43:40 +00:00			`saltutil`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`selinux`
			`service`
			`shadow`
Added new module docs 2013-06-06 22:39:22 +00:00			`smartos_imgadm`
			`smartos_vmadm`
Added new/missing modules/states to docs TOC & generated files 2012-10-04 20:43:44 +00:00			`smf`
Added / updated module docs 2012-10-25 17:52:39 +00:00			`solaris_group`
			`solarispkg`
			`solaris_shadow`
			`solaris_user`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`solr`
Add sqlite3 to module docs 2012-05-26 14:58:27 +00:00			`sqlite3`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`ssh`
			`state`
			`status`
Added new/missing modules/states to docs TOC & generated files 2012-10-04 20:43:44 +00:00			`supervisord`
Added/updated docs on new/changed execution modules 2012-11-14 19:48:27 +00:00			`svn`
Added missing new modules of varying types 2013-01-11 21:37:01 +00:00			`sysbench`
			`sysmod`
Added new modules, states, returners docs 2012-01-16 05:43:40 +00:00			`systemd`
Added a bunch of new execution modules to the docs 2013-03-29 18:05:10 +00:00			`system`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`test`
Added docs for new modules 2012-12-02 23:09:43 +00:00			`timezone`
Replaced ca module docs with tls 2012-10-30 00:27:47 +00:00			`tls`
Added a few missing modules to the module index 2011-11-27 17:41:22 +00:00			`tomcat`
Add upstart to the list of all modules 2012-03-17 22:12:36 +00:00			`upstart`
Replace manual & monolithic automodule with individual autosummary 2011-11-07 07:47:06 +00:00			`useradd`
			`virt`
By enforcing absolute imports, there's no need for module name aliases. 2013-08-19 12:23:46 +00:00			`virtualenv`
Added new modules, states, returners docs 2012-01-16 05:43:40 +00:00			`win_disk`
Adding new windows modules to the docs 2012-03-18 21:29:51 +00:00			`win_file`
Add win_groupadd to module index 2012-05-26 15:05:42 +00:00			`win_groupadd`
Adding new windows modules to the docs 2012-03-18 21:29:51 +00:00			`win_network`
Add win_pkg to the doc index 2012-05-26 15:10:18 +00:00			`win_pkg`
Added new modules, states, returners docs 2012-01-16 05:43:40 +00:00			`win_service`
Adding new windows modules to the docs 2012-03-18 21:29:51 +00:00			`win_shadow`
Added missing new modules of varying types 2013-01-11 21:37:01 +00:00			`win_status`
Added new module docs 2013-06-06 22:39:22 +00:00			`win_system`
Added new modules, states, returners docs 2012-01-16 05:43:40 +00:00			`win_useradd`
Added new module docs 2013-06-06 22:39:22 +00:00			`xapi`
Added new/missing modules/states to docs TOC & generated files 2012-10-04 20:43:44 +00:00			`yumpkg5`
Added/updated docs on new/changed execution modules 2012-11-14 19:48:27 +00:00			`yumpkg`
Added new module docs 2013-06-06 22:39:22 +00:00			`zfs`
Added new/missing modules/states to docs TOC & generated files 2012-10-04 20:43:44 +00:00			`zpool`
Add some new module docs and update release notes 2012-03-17 23:44:22 +00:00			`zypper`