From a873e1a467dcebbaa14ea83d75cedd76d06dd202 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Wed, 10 Oct 2012 19:48:40 -0400 Subject: [PATCH] Don't check in any module RST files as these are generated too. --- docsite/rst/modules/_list.rst | 48 --------- docsite/rst/modules/apt.rst | 92 ------------------ docsite/rst/modules/apt_repository.rst | 51 ---------- docsite/rst/modules/assemble.rst | 56 ----------- docsite/rst/modules/async_status.rst | 44 --------- docsite/rst/modules/authorized_key.rst | 52 ---------- docsite/rst/modules/command.rst | 64 ------------ docsite/rst/modules/copy.rst | 58 ----------- docsite/rst/modules/easy_install.rst | 51 ---------- docsite/rst/modules/facter.rst | 17 ---- docsite/rst/modules/fail.rst | 44 --------- docsite/rst/modules/fetch.rst | 42 -------- docsite/rst/modules/file.rst | 119 ----------------------- docsite/rst/modules/fireball.rst | 61 ------------ docsite/rst/modules/get_url.rst | 61 ------------ docsite/rst/modules/git.rst | 63 ------------ docsite/rst/modules/group.rst | 56 ----------- docsite/rst/modules/ini_file.rst | 83 ---------------- docsite/rst/modules/lineinfile.rst | 74 -------------- docsite/rst/modules/mount.rst | 77 --------------- docsite/rst/modules/mysql_db.rst | 83 ---------------- docsite/rst/modules/mysql_user.rst | 96 ------------------ docsite/rst/modules/nagios.rst | 95 ------------------ docsite/rst/modules/ohai.rst | 17 ---- docsite/rst/modules/pause.rst | 57 ----------- docsite/rst/modules/ping.rst | 16 --- docsite/rst/modules/pip.rst | 80 --------------- docsite/rst/modules/postgresql_db.rst | 76 --------------- docsite/rst/modules/postgresql_user.rst | 108 --------------------- docsite/rst/modules/raw.rst | 16 --- docsite/rst/modules/seboolean.rst | 54 ----------- docsite/rst/modules/selinux.rst | 57 ----------- docsite/rst/modules/service.rst | 68 ------------- docsite/rst/modules/setup.rst | 21 ---- docsite/rst/modules/shell.rst | 54 ----------- docsite/rst/modules/slurp.rst | 44 --------- docsite/rst/modules/subversion.rst | 54 ----------- docsite/rst/modules/supervisorctl.rst | 42 -------- docsite/rst/modules/template.rst | 60 ------------ docsite/rst/modules/user.rst | 123 ------------------------ docsite/rst/modules/virt.rst | 57 ----------- docsite/rst/modules/wait_for.rst | 63 ------------ docsite/rst/modules/yum.rst | 54 ----------- 43 files changed, 2608 deletions(-) delete mode 100644 docsite/rst/modules/_list.rst delete mode 100644 docsite/rst/modules/apt.rst delete mode 100644 docsite/rst/modules/apt_repository.rst delete mode 100644 docsite/rst/modules/assemble.rst delete mode 100644 docsite/rst/modules/async_status.rst delete mode 100644 docsite/rst/modules/authorized_key.rst delete mode 100644 docsite/rst/modules/command.rst delete mode 100644 docsite/rst/modules/copy.rst delete mode 100644 docsite/rst/modules/easy_install.rst delete mode 100644 docsite/rst/modules/facter.rst delete mode 100644 docsite/rst/modules/fail.rst delete mode 100644 docsite/rst/modules/fetch.rst delete mode 100644 docsite/rst/modules/file.rst delete mode 100644 docsite/rst/modules/fireball.rst delete mode 100644 docsite/rst/modules/get_url.rst delete mode 100644 docsite/rst/modules/git.rst delete mode 100644 docsite/rst/modules/group.rst delete mode 100644 docsite/rst/modules/ini_file.rst delete mode 100644 docsite/rst/modules/lineinfile.rst delete mode 100644 docsite/rst/modules/mount.rst delete mode 100644 docsite/rst/modules/mysql_db.rst delete mode 100644 docsite/rst/modules/mysql_user.rst delete mode 100644 docsite/rst/modules/nagios.rst delete mode 100644 docsite/rst/modules/ohai.rst delete mode 100644 docsite/rst/modules/pause.rst delete mode 100644 docsite/rst/modules/ping.rst delete mode 100644 docsite/rst/modules/pip.rst delete mode 100644 docsite/rst/modules/postgresql_db.rst delete mode 100644 docsite/rst/modules/postgresql_user.rst delete mode 100644 docsite/rst/modules/raw.rst delete mode 100644 docsite/rst/modules/seboolean.rst delete mode 100644 docsite/rst/modules/selinux.rst delete mode 100644 docsite/rst/modules/service.rst delete mode 100644 docsite/rst/modules/setup.rst delete mode 100644 docsite/rst/modules/shell.rst delete mode 100644 docsite/rst/modules/slurp.rst delete mode 100644 docsite/rst/modules/subversion.rst delete mode 100644 docsite/rst/modules/supervisorctl.rst delete mode 100644 docsite/rst/modules/template.rst delete mode 100644 docsite/rst/modules/user.rst delete mode 100644 docsite/rst/modules/virt.rst delete mode 100644 docsite/rst/modules/wait_for.rst delete mode 100644 docsite/rst/modules/yum.rst diff --git a/docsite/rst/modules/_list.rst b/docsite/rst/modules/_list.rst deleted file mode 100644 index 32a305d745..0000000000 --- a/docsite/rst/modules/_list.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. Generated by module_formatter -.. include:: modules/apt.rst -.. include:: modules/apt_repository.rst -.. include:: modules/assemble.rst -.. include:: modules/async_status.rst -.. include:: modules/authorized_key.rst -.. include:: modules/command.rst -.. include:: modules/copy.rst -.. include:: modules/cron.rst -.. include:: modules/debug.rst -.. include:: modules/easy_install.rst -.. include:: modules/facter.rst -.. include:: modules/fail.rst -.. include:: modules/fetch.rst -.. include:: modules/file.rst -.. include:: modules/fireball.rst -.. include:: modules/get_url.rst -.. include:: modules/git.rst -.. include:: modules/group.rst -.. include:: modules/hpilo_boot.rst -.. include:: modules/hpilo_facts.rst -.. include:: modules/ini_file.rst -.. include:: modules/lineinfile.rst -.. include:: modules/mount.rst -.. include:: modules/mysql_db.rst -.. include:: modules/mysql_user.rst -.. include:: modules/nagios.rst -.. include:: modules/ohai.rst -.. include:: modules/pause.rst -.. include:: modules/ping.rst -.. include:: modules/pip.rst -.. include:: modules/postgresql_db.rst -.. include:: modules/postgresql_user.rst -.. include:: modules/raw.rst -.. include:: modules/seboolean.rst -.. include:: modules/selinux.rst -.. include:: modules/service.rst -.. include:: modules/setup.rst -.. include:: modules/shell.rst -.. include:: modules/slurp.rst -.. include:: modules/subversion.rst -.. include:: modules/supervisorctl.rst -.. include:: modules/template.rst -.. include:: modules/user.rst -.. include:: modules/virt.rst -.. include:: modules/vsphere_facts.rst -.. include:: modules/wait_for.rst -.. include:: modules/yum.rst diff --git a/docsite/rst/modules/apt.rst b/docsite/rst/modules/apt.rst deleted file mode 100644 index 241849d0aa..0000000000 --- a/docsite/rst/modules/apt.rst +++ /dev/null @@ -1,92 +0,0 @@ -.. _apt: - -apt -`````````````````````````````` - -.. versionadded:: 0.0.2 - -Manages apt-packages (such as for Debian/Ubuntu). - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
parameterrequireddefaultchoicescomments
purgenono
  • yes
  • no
Will force purging of configuration files if the module state is set to absent.
statenopresent
  • installed
  • latest
  • remove
  • absent
  • present
Indicates the desired package state
forcenono
  • yes
  • no
If yes, force installs/removes.
pkgyes
    		A package name or package specifier with version, like foo or foo=1.0
    update_cachenono
    • yes
    • no
    		Run the equivalent of apt-get update before the operation. Can be run as part of the package installation or as a seperate step
    default_releaseno
      		Corresponds to the -t option for apt and sets pin priorities
      install_recommendsnono
      • yes
      • no
      		Corresponds to the --no-install-recommends option for apt, default behavior works as apt's default behavior, no does not install recommended packages. Suggested packages are never installed.
      - -.. raw:: html - -

      Update repositories cache and install foo package

      -    apt pkg=foo update-cache=yes
-

      -

      Remove foo package

      -    apt pkg=foo state=removed
-

      -

      Install the the package foo

      -    apt pkg=foo state=installed
-

      -

      Install the version '1.00' of package foo

      -    apt pkg=foo=1.00 state=installed
-

      -

      Update the repository cache and update package ngnix to latest version using default release squeeze-backport

      -    apt pkg=nginx state=latest default-release=squeeze-backports update-cache=yes
-

      -

      Install latest version of openjdk-6-jdk ignoring install-recomands

      -    apt pkg=openjdk-6-jdk state=latest install-recommends=no
-

      -
      - diff --git a/docsite/rst/modules/apt_repository.rst b/docsite/rst/modules/apt_repository.rst deleted file mode 100644 index c615ee2cb9..0000000000 --- a/docsite/rst/modules/apt_repository.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. _apt_repository: - -apt_repository -`````````````````````````````` - -.. versionadded:: 0.7 - -Manages apt repositores (such as for Debian/Ubuntu). - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - -
      parameterrequireddefaultchoicescomments
      repoyes
        		The repository name/value
        statenopresent
        • present
        • absent
        		The repository state
        - -.. raw:: html - -

        Add nginx stable repository from PPA

        -    apt_repository repo=ppa://nginx/stable
-

        -

        Add specified repository into sources.

        -    apt_repository repo='deb http://archive.canonical.com/ubuntu hardy partner'
-

        -
        - -.. raw:: html - -

        Notes

        -

        This module works on Debian and Ubuntu only and requires apt-add-repository be available on destination server. To ensure this package is available use the apt module and install the python-software-properties package before using this module.

        -

        A bug in apt-add-repository always adds deb and deb-src types for repositories (see the issue on Launchpad https://bugs.launchpad.net/ubuntu/+source/software-properties/+bug/987264), if a repo doesn't have source information (eg MongoDB repo from 10gen) the system will fail while updating repositories.

        - \ No newline at end of file diff --git a/docsite/rst/modules/assemble.rst b/docsite/rst/modules/assemble.rst deleted file mode 100644 index d0d9f19541..0000000000 --- a/docsite/rst/modules/assemble.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. _assemble: - -assemble -`````````````````````````````` - -.. versionadded:: 0.5 - -Assembles a configuration file from fragments. Often a particular program will take a single configuration file and does not support a ``conf.d`` style structure where it is easy to build up the configuration from multiple sources. Assemble will take a directory of files that have already been transferred to the system, and concatenate them together to produce a destination file. Files are assembled in string sorting order. Puppet calls this idea *fragments*. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        parameterrequireddefaultchoicescomments
        destyes
          		A file to create using the concatenation of all of the source files.
          srcyes
            		An already existing directory full of source files.
            backupnono
            • yes
            • no
            		Create a backup file (if yes), including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
            othersno
              		all arguments accepted by the file module also work here
              - -.. raw:: html - -

              Example from Ansible Playbooks

              -    assemble src=/etc/someapp/fragments dest=/etc/someapp/someapp.conf
-

              -
              - diff --git a/docsite/rst/modules/async_status.rst b/docsite/rst/modules/async_status.rst deleted file mode 100644 index add0add229..0000000000 --- a/docsite/rst/modules/async_status.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. _async_status: - -async_status -`````````````````````````````` - -.. versionadded:: 0.5 - -This module gets the status of an asynchronous task. See: http://ansible.cc/docs/playbooks2.html#asynchronous-actions-and-polling - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - -
              parameterrequireddefaultchoicescomments
              jidyes
                		Job or task identifier
                modenostatus
                • status
                • cleanup
                		if status, obtain the status; if cleanup, clean up the async job cache located in ~/.ansible_async/ for the specified job jid.
                - -.. raw:: html - -
                - -.. raw:: html - -

                Notes

                -

                See http://ansible.cc/docs/playbooks2.html#asynchronous-actions-and-polling

                - \ No newline at end of file diff --git a/docsite/rst/modules/authorized_key.rst b/docsite/rst/modules/authorized_key.rst deleted file mode 100644 index fd60999cfe..0000000000 --- a/docsite/rst/modules/authorized_key.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. _authorized_key: - -authorized_key -`````````````````````````````` - -.. versionadded:: 0.5 - -Adds or removes an SSH authorized key for a user from a remote host. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                parameterrequireddefaultchoicescomments
                statenopresent
                • present
                • absent
                		whether the given key should or should not be in the file
                useryes
                  		Name of the user who should have access to the remote host
                  keyyes
                    		the SSH public key, as a string
                    - -.. raw:: html - -

                    Example from Ansible Playbooks

                    -    authorized_key user=charlie key="ssh-dss ASDF1234L+8BTwaRYr/rycsBF1D8e5pTxEsXHQs4iq+mZdyWqlW++L6pMiam1A8yweP+rKtgjK2httVS6GigVsuWWfOd7/sdWippefq74nppVUELHPKkaIOjJNN1zUHFoL/YMwAAAEBALnAsQN10TNGsRDe5arBsW8cTOjqLyYBcIqgPYTZW8zENErFxt7ij3fW3Jh/sCpnmy8rkS7FyK8ULX0PEy/2yDx8/5rXgMIICbRH/XaBy9Ud5bRBFVkEDu/r+rXP33wFPHjWjwvHAtfci1NRBAudQI/98DbcGQw5HmE89CjgZRo5ktkC5yu/8agEPocVjdHyZr7PaHfxZGUDGKtGRL2QzRYukCmWo1cZbMBHcI5FzImvTHS9/8B3SATjXMPgbfBuEeBwuBK5EjL+CtHY5bWs9kmYjmeo0KfUMH8hY4MAXDoKhQ7DhBPIrcjS5jPtoGxIREZjba67r6/P2XKXaCZH6Fc= charlie@example.org 2011-01-17"
-

                    -

                    Shorthand available in Ansible 0.8 and later

                    -    authorized_key user=charlie key=$FILE(/home/charlie/.ssh/id_rsa.pub)
-

                    -
                    - diff --git a/docsite/rst/modules/command.rst b/docsite/rst/modules/command.rst deleted file mode 100644 index 95502a39a9..0000000000 --- a/docsite/rst/modules/command.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. _command: - -command -`````````````````````````````` - - -The command module takes the command name followed by a list of space-delimited arguments. -The given command will be executed on all selected nodes. It will not be processed through the shell, so variables like ``$HOME`` and operations like ``"<"``, ``">"``, ``"|"``, and ``"&"`` will not work. As such, all paths to commands must be fully qualified - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    parameterrequireddefaultchoicescomments
                    createsno
                      		a filename, when it already exists, this step will not be run.
                      free_formyes
                        		the command module takes a free form command to run
                        chdirno
                          		cd into this directory before running the command (added in Ansible 0.6)
                          removesno
                            		a filename, when it does not exist, this step will not be run. (added in Ansible 0.8)
                            - -.. raw:: html - -

                            Example from Ansible Playbooks

                            -    command /sbin/shutdown -t now
-

                            -

                            creates, removes, and chdir can be specified after the command. For instance, if you only want to run a command if a certain file does not exist, use this.

                            -    command /usr/bin/make_database.sh arg1 arg2 creates=/path/to/database
-

                            -
                            - -.. raw:: html - -

                            Notes

                            -

                            If you want to run a command through the shell (say you are using <, >, |, etc), you actually want the shell module instead. The command module is much more secure as it's not affected by the user's environment.

                            - \ No newline at end of file diff --git a/docsite/rst/modules/copy.rst b/docsite/rst/modules/copy.rst deleted file mode 100644 index ae23b8f6e5..0000000000 --- a/docsite/rst/modules/copy.rst +++ /dev/null @@ -1,58 +0,0 @@ -.. _copy: - -copy -`````````````````````````````` - - -The ``copy`` module copies a file on the local box to remote locations. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                            parameterrequireddefaultchoicescomments
                            destyes
                              		Remote absolute path where the file should be copied to.
                              srcyes
                                		Local path to a file to copy to the remote server; can be absolute or relative.
                                backupnono
                                • yes
                                • no
                                		Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. (added in Ansible 0.7)
                                othersno
                                  		all arguments accepted by the file module also work here
                                  - -.. raw:: html - -

                                  Example from Ansible Playbooks

                                  -    copy src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644
-

                                  -

                                  Copy a new ntp.conf file into place, backing up the original if it differs from the copied version

                                  -    copy src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes
-

                                  -
                                  - diff --git a/docsite/rst/modules/easy_install.rst b/docsite/rst/modules/easy_install.rst deleted file mode 100644 index 40b73fa0ad..0000000000 --- a/docsite/rst/modules/easy_install.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. _easy_install: - -easy_install -`````````````````````````````` - -.. versionadded:: 0.7 - -Installs Python libraries, optionally in a *virtualenv* - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - -
                                  parameterrequireddefaultchoicescomments
                                  virtualenvno
                                    		an optional virtualenv directory path to install into. If the virtualenv does not exist, it is created automatically
                                    nameyes
                                      		A Python library name
                                      - -.. raw:: html - -

                                      Examples from Ansible Playbooks

                                      -    easy_install name=pip
-

                                      -

                                      Install Flask (http://flask.pocoo.org/) into the specified virtualenv

                                      -    easy_install name=flask virtualenv=/webapps/myapp/venv
-

                                      -
                                      - -.. raw:: html - -

                                      Notes

                                      -

                                      Please note that the easy_install module can only install Python libraries. Thus this module is not able to remove libraries. It is generally recommended to use the pip module which you can first install using easy_install.

                                      -

                                      Also note that virtualenv must be installed on the remote host if the virtualenv parameter is specified.

                                      - \ No newline at end of file diff --git a/docsite/rst/modules/facter.rst b/docsite/rst/modules/facter.rst deleted file mode 100644 index 992d14bf40..0000000000 --- a/docsite/rst/modules/facter.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _facter: - -facter -`````````````````````````````` - -.. versionadded:: 0.2 - -Runs the *facter* discovery program (https://github.com/puppetlabs/facter) on the remote system, returning JSON data that can be useful for inventory purposes. - - -.. raw:: html - -

                                      Example command-line invocation

                                      -    ansible  www.example.net -m facter
-

                                      -
                                      - diff --git a/docsite/rst/modules/fail.rst b/docsite/rst/modules/fail.rst deleted file mode 100644 index bf255a2f52..0000000000 --- a/docsite/rst/modules/fail.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. _fail: - -fail -`````````````````````````````` - -.. versionadded:: 0.8 - -This module fails the progress with a custom message. It can be useful for bailing out when a certain condition is met using only_if. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - -
                                      parameterrequireddefaultchoicescomments
                                      msgno'Failed because only_if condition is true'
                                        		The customized message used for failing execution. If ommited, fail will simple bail out with a generic message.
                                        rcno1
                                          		The return code of the failure. This is currently not used by Ansible, but might be used in the future.
                                          - -.. raw:: html - -

                                          Example playbook using fail and only_if together

                                          -    action: fail msg="The system may not be provisioned according to the CMDB status." rc=100
-only_if: "'$cmdb_status' != 'to-be-staged'"
-
-

                                          -
                                          - diff --git a/docsite/rst/modules/fetch.rst b/docsite/rst/modules/fetch.rst deleted file mode 100644 index 76b79dac58..0000000000 --- a/docsite/rst/modules/fetch.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. _fetch: - -fetch -`````````````````````````````` - -.. versionadded:: 0.2 - -This module works like ``copy``, but in reverse. It is used for fetching files from remote machines and storing them locally in a file tree, organized by hostname. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - -
                                          parameterrequireddefaultchoicescomments
                                          destyes
                                            		A directory to save the file into. For example, if the dest directory is /backup a src file named /etc/profile on host host.example.com, would be saved into /backup/host.example.com/etc/profile
                                            srcyes
                                              		The file on the remote system to fetch. This must be a file, not a directory. Recursive fetching may be supported in a later release.
                                              - -.. raw:: html - -

                                              Example from Ansible Playbooks

                                              -    fetch src=/var/log/messages dest=/home/logtree
-

                                              -
                                              - diff --git a/docsite/rst/modules/file.rst b/docsite/rst/modules/file.rst deleted file mode 100644 index 5792f8dde7..0000000000 --- a/docsite/rst/modules/file.rst +++ /dev/null @@ -1,119 +0,0 @@ -.. _file: - -file -`````````````````````````````` - - -Sets attributes of files, symlinks, and directories, or removes files/symlinks/directories. Many other modules support the same options as the file module - including ``copy``, ``template``, and ``assmeble``. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                              parameterrequireddefaultchoicescomments
                                              srcno
                                                		path of the file to link to (applies only to state=link).
                                                groupno
                                                  		name of the group that should own the file/directory, as would be fed to chown
                                                  destyes
                                                    		defines the file being managed, unless when used with state=link, and then sets the destination to create a symbolic link to using src
                                                    selevelnos0
                                                      		level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the range. _default feature works as for seuser.
                                                      seuserno
                                                        		user part of SELinux file context. Will default to system policy, if applicable. If set to _default, it will use the user portion of the the policy if available
                                                        statenofile
                                                        • file
                                                        • link
                                                        • directory
                                                        • absent
                                                        		If directory, all immediate subdirectories will be created if they do not exist. If file, the file will NOT be created if it does not exist, see the copy or template module if you want that behavior. If link, the symbolic link will be created or changed. If absent, directories will be recursively deleted, and files or symlinks will be unlinked.
                                                        seroleno
                                                          		role part of SELinux file context, _default feature works as for seuser.
                                                          modeno
                                                            		mode the file or directory should be, such as 0644 as would be fed to
                                                            contextno
                                                            • default
                                                            		accepts only default as value. This will restore a file's SELinux context in the policy. Does nothing if no default value is available.
                                                            ownerno
                                                              		name of the user that should own the file/directory, as would be fed to chown
                                                              forceno
                                                                		force is required when changing an existing file to a directory, or a link to a directory, and so on. Use this with caution.
                                                                setypeno
                                                                  		type part of SELinux file context, _default feature works as for seuser.
                                                                  - -.. raw:: html - -

                                                                  Example from Ansible Playbooks

                                                                  -    file path=/etc/foo.conf owner=foo group=foo mode=0644
-

                                                                  - 

                                                                  -    file src=/file/to/link/to dest=/path/to/symlink owner=foo group=foo state=link
-

                                                                  -
                                                                  - -.. raw:: html - -

                                                                  Notes

                                                                  -

                                                                  See also copy, template, assemble

                                                                  - \ No newline at end of file diff --git a/docsite/rst/modules/fireball.rst b/docsite/rst/modules/fireball.rst deleted file mode 100644 index cd6ab4f477..0000000000 --- a/docsite/rst/modules/fireball.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. _fireball: - -fireball -`````````````````````````````` - -.. versionadded:: 0.9 - -This modules launches an ephemeral *fireball* ZeroMQ message bus daemon on the remote node which Ansible can to communicate with nodes at high speed. -The daemon listens on a configurable port for a configurable amount of time. -Starting a new fireball as a given user terminates any existing user fireballs. -Fireball mode is AES encrypted - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - -
                                                                  parameterrequireddefaultchoicescomments
                                                                  minutesno30
                                                                    		The fireball listener daemon is started on nodes and will stay around for this number of minutes before turning itself off.
                                                                    portno5099
                                                                      		TCP port for ZeroMQ
                                                                      - -.. raw:: html - -

                                                                      This example playbook has two plays: the first launches fireball mode on all hosts via SSH, and the second actually starts using fireball node for subsequent management over the fireball interface

                                                                      -    - hosts: devservers
-      gather_facts: false
-      connection: ssh
-      sudo: yes
-      tasks:
-          - action: fireball 
-
-    - hosts: devservers
-      connection: fireball
-      tasks:
-          - action: command /usr/bin/anything
-
-

                                                                      -
                                                                      - -.. raw:: html - -

                                                                      Notes

                                                                      -

                                                                      See the advanced playbooks chapter for more about using fireball mode.

                                                                      - \ No newline at end of file diff --git a/docsite/rst/modules/get_url.rst b/docsite/rst/modules/get_url.rst deleted file mode 100644 index ca65fed9b0..0000000000 --- a/docsite/rst/modules/get_url.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. _get_url: - -get_url -`````````````````````````````` - -.. versionadded:: 0.6 - -Downloads files from HTTP, HTTPS, or FTP to the remote server. The remote server must have direct access to the remote resource. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                      parameterrequireddefaultchoicescomments
                                                                      urlyes
                                                                        		HTTP, HTTPS, or FTP URL
                                                                        destyes
                                                                          		absolute path of where to download the file to.If dest is a directory, the basename of the file on the remote server will be used. If a directory, thirsty=yes must also be set.
                                                                          thirstynono
                                                                          • yes
                                                                          • no
                                                                          		if yes, will download the file every time and replace the file if the contents change. if no, the file will only be downloaded if the destination does not exist. Generally should be yes only for small local files. prior to 0.6, acts if yes by default. (added in Ansible 0.7)
                                                                          othersno
                                                                            		all arguments accepted by the file module also work here
                                                                            - -.. raw:: html - -

                                                                            Example from Ansible Playbooks

                                                                            -    get_url url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440
-

                                                                            -
                                                                            - -.. raw:: html - -

                                                                            Notes

                                                                            -

                                                                            This module doesn't yet support configuration for proxies or passwords.

                                                                            - \ No newline at end of file diff --git a/docsite/rst/modules/git.rst b/docsite/rst/modules/git.rst deleted file mode 100644 index 26ec13910c..0000000000 --- a/docsite/rst/modules/git.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. _git: - -git -`````````````````````````````` - -.. versionadded:: 0.0.1 - -Manage git checkouts of repositories to deploy files or software. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                            parameterrequireddefaultchoicescomments
                                                                            repoyes
                                                                              		git, ssh, or http protocol address of the git repository.
                                                                              destyes
                                                                                		Absolute path of where the repository should be checked out to.
                                                                                versionnoHEAD
                                                                                  		What version of the repository to check out. This can be the git SHA, the literal string HEAD, branch name, or a tag name.
                                                                                  forcenoyes
                                                                                  • True
                                                                                  • False
                                                                                  		(New in 0.7) If yes, any modified files in the working repository will be discarded. Prior to 0.7, this was always 'yes' and could not be disabled.
                                                                                  remotenoorigin
                                                                                    		Name of the remote branch.
                                                                                    - -.. raw:: html - -

                                                                                    Example git checkout from Ansible Playbooks

                                                                                    -    git repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout version=release-0.22
-

                                                                                    -
                                                                                    - diff --git a/docsite/rst/modules/group.rst b/docsite/rst/modules/group.rst deleted file mode 100644 index fdb6c03897..0000000000 --- a/docsite/rst/modules/group.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. _group: - -group -`````````````````````````````` - -.. versionadded:: 0.0.2 - -Manage presence of groups on a host. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                    parameterrequireddefaultchoicescomments
                                                                                    statenopresent
                                                                                    • present
                                                                                    • absent
                                                                                    		Whether the group should be present or not on the remote host.
                                                                                    gidno
                                                                                      		Optional GID to set for the group.
                                                                                      nameyes
                                                                                        		Name of the group to manage.
                                                                                        systemnono
                                                                                        • True
                                                                                        • False
                                                                                        		If yes, indicates that the group created is a system group.
                                                                                        - -.. raw:: html - -

                                                                                        Example group command from Ansible Playbooks

                                                                                        -    group name=somegroup state=present
-

                                                                                        -
                                                                                        - diff --git a/docsite/rst/modules/ini_file.rst b/docsite/rst/modules/ini_file.rst deleted file mode 100644 index 4818e3cebc..0000000000 --- a/docsite/rst/modules/ini_file.rst +++ /dev/null @@ -1,83 +0,0 @@ -.. _ini_file: - -ini_file -`````````````````````````````` - -.. versionadded:: 0.9 - -Manage (add, remove, change) individual settings in an INI-style file without having to manage the file as a whole with, say, ``template`` or ``assemble``. Adds missing sections if they don't exist. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                        parameterrequireddefaultchoicescomments
                                                                                        optionno
                                                                                          		if set (required for changing a value), this is the name of the option.May be omitted if adding/removing a whole section.
                                                                                          othersno
                                                                                            		all arguments accepted by the file module also work here
                                                                                            destyes
                                                                                              		Path to the INI-style file; this file is created if required
                                                                                              sectionyes
                                                                                                		Section name in INI file. This is added if state=present automatically when a single value is being set.
                                                                                                backupno
                                                                                                • yes
                                                                                                • no
                                                                                                		Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
                                                                                                valueno
                                                                                                  		the string value to be associated with an option. May be omitted when removing an option.
                                                                                                  - -.. raw:: html - -

                                                                                                  Ensure fav=lemonade is in section [drinks] in said file

                                                                                                  -    ini_file dest=/etc/conf section=drinks option=fav value=lemonade mode=0600 backup=true
-

                                                                                                  - 

                                                                                                  -    ini_file dest=/etc/anotherconf
-         section=drinks
-         option=temperature
-         value=cold
-         backup=true
-
-

                                                                                                  -
                                                                                                  - -.. raw:: html - -

                                                                                                  Notes

                                                                                                  -

                                                                                                  While it is possible to add an option without specifying a value, this makes no sense.

                                                                                                  - \ No newline at end of file diff --git a/docsite/rst/modules/lineinfile.rst b/docsite/rst/modules/lineinfile.rst deleted file mode 100644 index 564a86bd8f..0000000000 --- a/docsite/rst/modules/lineinfile.rst +++ /dev/null @@ -1,74 +0,0 @@ -.. _lineinfile: - -lineinfile -`````````````````````````````` - -.. versionadded:: 0.7 - -This module will search a file for a line, and ensure that it is present or absent. -This is primarily useful when you want to change a single line in a file only. For other cases, see the ``copy`` or ``template`` modules. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                  parameterrequireddefaultchoicescomments
                                                                                                  insertafternoEOF
                                                                                                  • BOF
                                                                                                  • EOF
                                                                                                  		Used with state=present. If specified, the line will be inserted after the specified regular expression. Two special values are available; BOF for inserting the line at the beginning of the file, and EOF for inserting the line at the end of the file.
                                                                                                  statenopresent
                                                                                                  • present
                                                                                                  • absent
                                                                                                  		Whether the line should be there or not.
                                                                                                  destyes
                                                                                                    		The file to modify
                                                                                                    regexpyes
                                                                                                      		The regular expression to look for in the file. For state=present, the pattern to replace. For state=absent, the pattern of the line to remove.
                                                                                                      lineno
                                                                                                        		Required for state=present. The line to insert/replace into the file. Must match the value given to regexp.
                                                                                                        backupno
                                                                                                          		Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
                                                                                                          - -.. raw:: html - - 

                                                                                                          -    lineinfile dest=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled
-

                                                                                                          - 

                                                                                                          -    lineinfile dest=/etc/sudoers state=absent regexp="^%wheel"
-

                                                                                                          -
                                                                                                          - diff --git a/docsite/rst/modules/mount.rst b/docsite/rst/modules/mount.rst deleted file mode 100644 index f9b522557e..0000000000 --- a/docsite/rst/modules/mount.rst +++ /dev/null @@ -1,77 +0,0 @@ -.. _mount: - -mount -`````````````````````````````` - -.. versionadded:: 0.6 - -This module controls active and configured mount points in ``/etc/fstab``. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                          parameterrequireddefaultchoicescomments
                                                                                                          srcyes
                                                                                                            		device to be mounted on name.
                                                                                                            stateyes
                                                                                                            • present
                                                                                                            • absent
                                                                                                            • mounted
                                                                                                            • unmounted
                                                                                                            		If mounted or unmounted, the device will be actively mounted or unmounted as well as just configured in fstab. absent and present only deal with fstab.
                                                                                                            nameyes
                                                                                                              		path to the mount point, eg: /mnt/files
                                                                                                              dumpno
                                                                                                                		dump (see fstab(8))
                                                                                                                passnono
                                                                                                                  		passno (see fstab(8))
                                                                                                                  optsno
                                                                                                                    		mount options (see fstab(8))
                                                                                                                    fstypeyes
                                                                                                                      		file-system type
                                                                                                                      - -.. raw:: html - -

                                                                                                                      Mount DVD read-only

                                                                                                                      -    mount name=/mnt/dvd src=/dev/sr0 fstype=iso9660 opts=ro
-

                                                                                                                      -
                                                                                                                      - diff --git a/docsite/rst/modules/mysql_db.rst b/docsite/rst/modules/mysql_db.rst deleted file mode 100644 index 9f358bde82..0000000000 --- a/docsite/rst/modules/mysql_db.rst +++ /dev/null @@ -1,83 +0,0 @@ -.. _mysql_db: - -mysql_db -`````````````````````````````` - -.. versionadded:: 0.6 - -Add or remove MySQL databases from a remote host. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      parameterrequireddefaultchoicescomments
                                                                                                                      statenopresent
                                                                                                                      • present
                                                                                                                      • absent
                                                                                                                      		The database state
                                                                                                                      nameyes
                                                                                                                        		name of the database to add or remove
                                                                                                                        encodingno
                                                                                                                          		Encoding mode
                                                                                                                          collationno
                                                                                                                            		Collation mode
                                                                                                                            login_userno
                                                                                                                              		The username used to authenticate with
                                                                                                                              login_hostnolocalhost
                                                                                                                                		Host running the database
                                                                                                                                login_passwordno
                                                                                                                                  		The password used to authenticate with
                                                                                                                                  - -.. raw:: html - -

                                                                                                                                  Create a new database with name 'bobdata'

                                                                                                                                  -    mysql_db db=bobdata state=present
-

                                                                                                                                  -
                                                                                                                                  - -.. raw:: html - -

                                                                                                                                  Notes

                                                                                                                                  -

                                                                                                                                  Requires the MySQLdb Python package on the remote host. For Ubuntu, this is as easy as apt-get install python-mysqldb.

                                                                                                                                  -

                                                                                                                                  Both login_password and login_username are required when you are passing credentials. If none are present, the module will attempt to read the credentials from ~/.my.cnf, and finally fall back to using the MySQL default login of 'root' with no password.

                                                                                                                                  - \ No newline at end of file diff --git a/docsite/rst/modules/mysql_user.rst b/docsite/rst/modules/mysql_user.rst deleted file mode 100644 index 78a8054dd0..0000000000 --- a/docsite/rst/modules/mysql_user.rst +++ /dev/null @@ -1,96 +0,0 @@ -.. _mysql_user: - -mysql_user -`````````````````````````````` - -.. versionadded:: 0.6 - -Adds or removes a user from a MySQL database. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  parameterrequireddefaultchoicescomments
                                                                                                                                  nameyes
                                                                                                                                    		name of the user (role) to add or remove
                                                                                                                                    login_userno
                                                                                                                                      		The username used to authenticate with
                                                                                                                                      login_hostnolocalhost
                                                                                                                                        		Host running the database
                                                                                                                                        hostnolocalhost
                                                                                                                                          		the 'host' part of the MySQL username
                                                                                                                                          statenopresent
                                                                                                                                          • present
                                                                                                                                          • absent
                                                                                                                                          		The database state
                                                                                                                                          login_passwordno
                                                                                                                                            		The password used to authenticate with
                                                                                                                                            passwordno
                                                                                                                                              		set the user's password
                                                                                                                                              privno
                                                                                                                                                		MySQL privileges string in the format: db.table:priv1,priv2
                                                                                                                                                - -.. raw:: html - -

                                                                                                                                                Create database user with name 'bob' and password '12345' with all database privileges

                                                                                                                                                -    mysql_user name=bob password=12345 priv=*.*:ALL state=present
-

                                                                                                                                                -

                                                                                                                                                Ensure no user named 'sally' exists, also passing in the auth credentials.

                                                                                                                                                -    mysql_user login_user=root login_password=123456 name=sally state=absent
-

                                                                                                                                                -

                                                                                                                                                Example privileges string format

                                                                                                                                                -    mydb.*:INSERT,UPDATE/anotherdb.*:SELECT/yetanotherdb.*:ALL
-

                                                                                                                                                -
                                                                                                                                                - -.. raw:: html - -

                                                                                                                                                Notes

                                                                                                                                                -

                                                                                                                                                Requires the MySQLdb Python package on the remote host. For Ubuntu, this is as easy as apt-get install python-mysqldb.

                                                                                                                                                -

                                                                                                                                                Both login_password and login_username are required when you are passing credentials. If none are present, the module will attempt to read the credentials from ~/.my.cnf, and finally fall back to using the MySQL default login of 'root' with no password.

                                                                                                                                                - \ No newline at end of file diff --git a/docsite/rst/modules/nagios.rst b/docsite/rst/modules/nagios.rst deleted file mode 100644 index 017be0e174..0000000000 --- a/docsite/rst/modules/nagios.rst +++ /dev/null @@ -1,95 +0,0 @@ -.. _nagios: - -nagios -`````````````````````````````` - -.. versionadded:: 0.7 - -The ``nagios`` module has two basic functions: scheduling downtime and toggling alerts for services or hosts. -All actions require the ``host`` parameter to be given explicitly. In playbooks you can use the ``$inventory_hostname`` variable to refer to the host the playbook is currently running on. -You can specify multiple services at once by separating them with commas, .e.g., ``services=httpd,nfs,puppet``. -When specifying what service to handle there is a special service value, *host*, which will handle alerts/downtime for the *host itself*, e.g., ``service=host``. This keyword may not be given with other services at the same time. *Setting alerts/downtime for a host does not affect alerts/downtime for any of the services running on it.* -When using the ``nagios`` module you will need to specify your nagios server using the ``delegate_to`` parameter. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                parameterrequireddefaultchoicescomments
                                                                                                                                                actionyes
                                                                                                                                                • downtime
                                                                                                                                                • enable_alerts
                                                                                                                                                • disable_alerts
                                                                                                                                                • silence
                                                                                                                                                • unsilence
                                                                                                                                                		Action to take.
                                                                                                                                                hostyes
                                                                                                                                                  		Host to operate on in Nagios.
                                                                                                                                                  authornoAnsible
                                                                                                                                                    		Author to leave downtime comments as. - Only useable with the downtime action.
                                                                                                                                                    servicesyes
                                                                                                                                                      		What to manage downtime/alerts for. Separate multiple services with commas.service is an alias for services.Required option when using the downtime, enable_alerts, and disable_alerts actions.
                                                                                                                                                      minutesno30
                                                                                                                                                        		Minutes to schedule downtime for.Only useable with the downtime action.
                                                                                                                                                        cmdfilenoauto-detected
                                                                                                                                                          		Path to the nagios command file (FIFO pipe).Only required if auto-detection fails.
                                                                                                                                                          - -.. raw:: html - -

                                                                                                                                                          set 30 minutes of apache downtime

                                                                                                                                                          -    nagios action=downtime minutes=30 service=httpd host=$inventory_hostname
-

                                                                                                                                                          -

                                                                                                                                                          schedule an hour of HOST downtime

                                                                                                                                                          -    nagios action=downtime minutes=60 service=host host=$inventory_hostname
-

                                                                                                                                                          -

                                                                                                                                                          schedule downtime for a few services

                                                                                                                                                          -    nagios action=downtime services=frob,foobar,qeuz host=$inventory_hostname
-

                                                                                                                                                          -

                                                                                                                                                          enable SMART disk alerts

                                                                                                                                                          -    nagios action=enable_alerts service=smart host=$inventory_hostname
-

                                                                                                                                                          -

                                                                                                                                                          two services at once: disable httpd and nfs alerts

                                                                                                                                                          -    nagios action=disable_alerts service=httpd,nfs host=$inventory_hostname
-

                                                                                                                                                          -

                                                                                                                                                          disable HOST alerts

                                                                                                                                                          -    nagios action=disable_alerts service=host host=$inventory_hostname
-

                                                                                                                                                          -

                                                                                                                                                          silence ALL alerts

                                                                                                                                                          -    nagios action=silence host=$inventory_hostname
-

                                                                                                                                                          -

                                                                                                                                                          unsilence all alerts

                                                                                                                                                          -    nagios action=unsilence host=$inventory_hostname
-

                                                                                                                                                          -
                                                                                                                                                          - diff --git a/docsite/rst/modules/ohai.rst b/docsite/rst/modules/ohai.rst deleted file mode 100644 index f2e53dd6c0..0000000000 --- a/docsite/rst/modules/ohai.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _ohai: - -ohai -`````````````````````````````` - -.. versionadded:: 0.6 - -Similar to the ``facter`` module, this runs the *ohai* discovery program (http://wiki.opscode.com/display/chef/Ohai) on the remote host and returns JSON inventory data. *Ohai* data is a bit more verbose and nested than *facter*. - - -.. raw:: html - -

                                                                                                                                                          Retrieve ohai data from all Web servers and store in one-file per host

                                                                                                                                                          -    ansible webservers -m ohai --tree=/tmp/ohaidata
-

                                                                                                                                                          -
                                                                                                                                                          - diff --git a/docsite/rst/modules/pause.rst b/docsite/rst/modules/pause.rst deleted file mode 100644 index 8e1f84f494..0000000000 --- a/docsite/rst/modules/pause.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. _pause: - -pause -`````````````````````````````` - -.. versionadded:: 0.8 - -Pauses playbook execution for a set amount of time, or until a prompt is acknowledged. All parameters are optional. The default behavior is to pause with a prompt. -You can use ``ctrl+c`` if you wish to advance a pause earlier than it is set to expire or if you need to abort a playbook run entirely. To continue early: press ``ctrl+c`` and then ``c``. To abort a playbook: press ``ctrl+c`` and then ``a``. -The pause module integrates into async/parallelized playbooks without any special considerations (see also: Rolling Updates). When using pauses with the ``serial`` playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          parameterrequireddefaultchoicescomments
                                                                                                                                                          secondsno
                                                                                                                                                            		Number of minutes to pause for.
                                                                                                                                                            minutesno
                                                                                                                                                              		Number of minutes to pause for.
                                                                                                                                                              promptno
                                                                                                                                                                		Optional text to use for the prompt message.
                                                                                                                                                                - -.. raw:: html - -

                                                                                                                                                                Pause for 5 minutes to build app cache.

                                                                                                                                                                -    pause minutes=5
-

                                                                                                                                                                -

                                                                                                                                                                Pause until you can verify updates to an application were successful.

                                                                                                                                                                -    pause
-

                                                                                                                                                                -

                                                                                                                                                                A helpful reminder of what to look out for post-update.

                                                                                                                                                                -    pause prompt=Make sure org.foo.FooOverload exception is not present
-

                                                                                                                                                                -
                                                                                                                                                                - diff --git a/docsite/rst/modules/ping.rst b/docsite/rst/modules/ping.rst deleted file mode 100644 index a852f86d3c..0000000000 --- a/docsite/rst/modules/ping.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _ping: - -ping -`````````````````````````````` - - -A trivial test module, this module always returns 'pong' on successful contact. It does not make sense in playbooks, but is useful from ``/usr/bin/ansible`` - - -.. raw:: html - -

                                                                                                                                                                Test 'webservers' status

                                                                                                                                                                -    ansible webservers -m ping
-

                                                                                                                                                                -
                                                                                                                                                                - diff --git a/docsite/rst/modules/pip.rst b/docsite/rst/modules/pip.rst deleted file mode 100644 index c07b68e5bd..0000000000 --- a/docsite/rst/modules/pip.rst +++ /dev/null @@ -1,80 +0,0 @@ -.. _pip: - -pip -`````````````````````````````` - -.. versionadded:: 0.7 - -Manage Python library dependencies. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                parameterrequireddefaultchoicescomments
                                                                                                                                                                virtualenvno
                                                                                                                                                                  		An optional path to a virtualenv directory to install into
                                                                                                                                                                  statenopresent
                                                                                                                                                                  • present
                                                                                                                                                                  • absent
                                                                                                                                                                  • latest
                                                                                                                                                                  		The state of module
                                                                                                                                                                  versionno
                                                                                                                                                                    		The version number to install of the Python library specified in the 'name' parameter
                                                                                                                                                                    requirementsno
                                                                                                                                                                      		The path to a pip requirements file
                                                                                                                                                                      nameyes
                                                                                                                                                                        		The name of a Python library to install
                                                                                                                                                                        - -.. raw:: html - -

                                                                                                                                                                        Install flask python package.

                                                                                                                                                                        -    pip name=flask
-

                                                                                                                                                                        -

                                                                                                                                                                        Install flask python package on version 0.8.

                                                                                                                                                                        -    pip name=flask version=0.8
-

                                                                                                                                                                        -

                                                                                                                                                                        Install Flask (http://flask.pocoo.org/) into the specified virtualenv

                                                                                                                                                                        -    pip name=flask virtualenv=/srv/webapps/my_app/venv
-

                                                                                                                                                                        -

                                                                                                                                                                        Install specified python requirements.

                                                                                                                                                                        -    pip requirements=/srv/webapps/my_app/src/requirements.txt
-

                                                                                                                                                                        -

                                                                                                                                                                        Install specified python requirements in indicated virtualenv.

                                                                                                                                                                        -    pip requirements=/srv/webapps/my_app/src/requirements.txt virtualenv=/srv/webapps/my_app/venv
-

                                                                                                                                                                        -
                                                                                                                                                                        - -.. raw:: html - -

                                                                                                                                                                        Notes

                                                                                                                                                                        -

                                                                                                                                                                        Please note that http://www.virtualenv.org/, virtualenv must be installed on the remote host if the virtualenv parameter is specified.

                                                                                                                                                                        - \ No newline at end of file diff --git a/docsite/rst/modules/postgresql_db.rst b/docsite/rst/modules/postgresql_db.rst deleted file mode 100644 index b87d2d754d..0000000000 --- a/docsite/rst/modules/postgresql_db.rst +++ /dev/null @@ -1,76 +0,0 @@ -.. _postgresql_db: - -postgresql_db -`````````````````````````````` - -.. versionadded:: 0.6 - -Add or remove PostgreSQL databases from a remote host. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        parameterrequireddefaultchoicescomments
                                                                                                                                                                        statenopresent
                                                                                                                                                                        • present
                                                                                                                                                                        • absent
                                                                                                                                                                        		The database state
                                                                                                                                                                        nameyes
                                                                                                                                                                          		name of the database to add or remove
                                                                                                                                                                          login_passwordno
                                                                                                                                                                            		The password used to authenticate with
                                                                                                                                                                            ownerno
                                                                                                                                                                              		Name of the role to set as owner of the database
                                                                                                                                                                              login_userno
                                                                                                                                                                                		The username used to authenticate with
                                                                                                                                                                                login_hostnolocalhost
                                                                                                                                                                                  		Host running the database
                                                                                                                                                                                  - -.. raw:: html - -

                                                                                                                                                                                  Create a new database with name 'acme'

                                                                                                                                                                                  -    postgresql_db db=acme
-

                                                                                                                                                                                  -
                                                                                                                                                                                  - -.. raw:: html - -

                                                                                                                                                                                  Notes

                                                                                                                                                                                  -

                                                                                                                                                                                  The default authentication assumes that you are either logging in as or sudo'ing to the postgres account on the host.

                                                                                                                                                                                  -

                                                                                                                                                                                  This module uses psycopg2, a Python PostgreSQL database adapter. You must ensure that psycopg2 is installed on the host before using this module. If the remote host is the PostgreSQL server (which is the default case), then PostgreSQL must also be installed on the remote host. For Ubuntu-based systems, install the postgresql, libpq-dev, and python-psycopg2 packages on the remote host before using this module.

                                                                                                                                                                                  - \ No newline at end of file diff --git a/docsite/rst/modules/postgresql_user.rst b/docsite/rst/modules/postgresql_user.rst deleted file mode 100644 index 5b554d8fb8..0000000000 --- a/docsite/rst/modules/postgresql_user.rst +++ /dev/null @@ -1,108 +0,0 @@ -.. _postgresql_user: - -postgresql_user -`````````````````````````````` - -.. versionadded:: 0.6 - -Add or remove PostgreSQL users (roles) from a remote host and, optionally, grant the users access to an existing database or tables. -The fundamental function of the module is to create, or delete, roles from a PostgreSQL cluster. Privilege assignment, or removal, is an optional step, which works on one database at a time. This allows for the module to be called several times in the same module to modify the permissions on different databases, or to grant permissions to already existing users. -A user cannot be removed untill all the privileges have been stripped from the user. In such situation, if the module tries to remove the user it will fail. To avoid this from happening the fail_on_user option signals the module to try to remove the user, but if not possible keep going; the module will report if changes happened and separately if the user was removed or not. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                  parameterrequireddefaultchoicescomments
                                                                                                                                                                                  nameyes
                                                                                                                                                                                    		name of the user (role) to add or remove
                                                                                                                                                                                    login_usernopostgres
                                                                                                                                                                                      		User (role) used to authenticate with PostgreSQL
                                                                                                                                                                                      login_hostnolocalhost
                                                                                                                                                                                        		Host running PostgreSQL.
                                                                                                                                                                                        dbno
                                                                                                                                                                                          		name of database where permissions will be granted
                                                                                                                                                                                          statenopresent
                                                                                                                                                                                          • present
                                                                                                                                                                                          • absent
                                                                                                                                                                                          		The database state
                                                                                                                                                                                          login_passwordno
                                                                                                                                                                                            		Password used to authenticate with PostgreSQL
                                                                                                                                                                                            passwordyes
                                                                                                                                                                                              		set the user's password
                                                                                                                                                                                              fail_on_usernoTrue
                                                                                                                                                                                              • yes
                                                                                                                                                                                              • no
                                                                                                                                                                                              		if yes, fail when user can't be removed. Otherwise just log and continue
                                                                                                                                                                                              privno
                                                                                                                                                                                                		PostgreSQL privileges string in the format: table:priv1,priv2
                                                                                                                                                                                                - -.. raw:: html - -

                                                                                                                                                                                                Create django user and grant access to database and products table

                                                                                                                                                                                                -    postgresql_user db=acme user=django password=ceec4eif7ya priv=CONNECT/products:ALL
-

                                                                                                                                                                                                -

                                                                                                                                                                                                Remove test user privileges from acme

                                                                                                                                                                                                -    postgresql_user db=acme user=test priv=ALL/products:ALL state=absent fail_on_user=no
-

                                                                                                                                                                                                -

                                                                                                                                                                                                Remove test user from test database and the cluster

                                                                                                                                                                                                -    postgresql_user db=test user=test priv=ALL state=absent
-

                                                                                                                                                                                                -

                                                                                                                                                                                                Example privileges string format

                                                                                                                                                                                                -    INSERT,UPDATE/table:SELECT/anothertable:ALL
-

                                                                                                                                                                                                -
                                                                                                                                                                                                - -.. raw:: html - -

                                                                                                                                                                                                Notes

                                                                                                                                                                                                -

                                                                                                                                                                                                The default authentication assumes that you are either logging in as or sudo'ing to the postgres account on the host.

                                                                                                                                                                                                -

                                                                                                                                                                                                This module uses psycopg2, a Python PostgreSQL database adapter. You must ensure that psycopg2 is installed on the host before using this module. If the remote host is the PostgreSQL server (which is the default case), then PostgreSQL must also be installed on the remote host. For Ubuntu-based systems, install the postgresql, libpq-dev, and python-psycopg2 packages on the remote host before using this module.

                                                                                                                                                                                                - \ No newline at end of file diff --git a/docsite/rst/modules/raw.rst b/docsite/rst/modules/raw.rst deleted file mode 100644 index 83a49ccf5b..0000000000 --- a/docsite/rst/modules/raw.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _raw: - -raw -`````````````````````````````` - - -Executes a low-down and dirty SSH command, not going through the module subsystem. This is useful and should only be done in two cases. The first case is installing python-simplejson on older (Python 2.4 and before) hosts that need it as a dependency to run modules, since nearly all core modules require it. Another is speaking to any devices such as routers that do not have any Python installed. In any other case, using the ``shell`` or ``command`` module is much more appropriate. Arguments given to ``raw`` are run directly through the configured remote shell and only output is returned. There is no error detection or change handler support for this module - - -.. raw:: html - -

                                                                                                                                                                                                Example from /usr/bin/ansible to bootstrap a legacy python 2.4 host

                                                                                                                                                                                                -    ansible newhost.example.com -m raw -a "yum -y install python-simplejson"
-

                                                                                                                                                                                                -
                                                                                                                                                                                                - diff --git a/docsite/rst/modules/seboolean.rst b/docsite/rst/modules/seboolean.rst deleted file mode 100644 index 1a51dfeea8..0000000000 --- a/docsite/rst/modules/seboolean.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. _seboolean: - -seboolean -`````````````````````````````` - -.. versionadded:: 0.7 - -Toggles SELinux booleans. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                parameterrequireddefaultchoicescomments
                                                                                                                                                                                                stateyes
                                                                                                                                                                                                • true
                                                                                                                                                                                                • false
                                                                                                                                                                                                		Desired boolean value
                                                                                                                                                                                                nameyes
                                                                                                                                                                                                  		Name of the boolean to configure
                                                                                                                                                                                                  persistentno
                                                                                                                                                                                                  • yes
                                                                                                                                                                                                  • no
                                                                                                                                                                                                  		Set to 'yes' if the boolean setting should survive a reboot
                                                                                                                                                                                                  - -.. raw:: html - -

                                                                                                                                                                                                  Set httpd_can_network_connect SELinux flag to true and persistent

                                                                                                                                                                                                  -    seboolean name=httpd_can_network_connect state=true persistent=yes
-

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -.. raw:: html - -

                                                                                                                                                                                                  Notes

                                                                                                                                                                                                  -

                                                                                                                                                                                                  Not tested on any debian based system

                                                                                                                                                                                                  - \ No newline at end of file diff --git a/docsite/rst/modules/selinux.rst b/docsite/rst/modules/selinux.rst deleted file mode 100644 index 9773a7cff7..0000000000 --- a/docsite/rst/modules/selinux.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. _selinux: - -selinux -`````````````````````````````` - -.. versionadded:: 0.7 - -Configures the SELinux mode and policy. A reboot may be required after usage. Ansible will not issue this reboot but will let you know when it is required. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  parameterrequireddefaultchoicescomments
                                                                                                                                                                                                  policyyes
                                                                                                                                                                                                    		name of the SELinux policy to use (example: 'targeted')
                                                                                                                                                                                                    stateyes
                                                                                                                                                                                                    • enforcing
                                                                                                                                                                                                    • permissive
                                                                                                                                                                                                    • disabled
                                                                                                                                                                                                    		The SELinux mode
                                                                                                                                                                                                    confno/etc/selinux/config
                                                                                                                                                                                                      		path to the SELinux configuration file, if non-standard
                                                                                                                                                                                                      - -.. raw:: html - - 

                                                                                                                                                                                                      -    selinux policy=targeted state=enforcing
-

                                                                                                                                                                                                      - 

                                                                                                                                                                                                      -    selinux policy=targeted state=disabled
-

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -.. raw:: html - -

                                                                                                                                                                                                      Notes

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Not tested on any debian based system

                                                                                                                                                                                                      - \ No newline at end of file diff --git a/docsite/rst/modules/service.rst b/docsite/rst/modules/service.rst deleted file mode 100644 index 898c735515..0000000000 --- a/docsite/rst/modules/service.rst +++ /dev/null @@ -1,68 +0,0 @@ -.. _service: - -service -`````````````````````````````` - -.. versionadded:: 0.1 - -Controls services on remote hosts. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      parameterrequireddefaultchoicescomments
                                                                                                                                                                                                      patternno
                                                                                                                                                                                                        		If the service does not respond to the status command, name a substring to look for as would be found in the output of the ps command as a stand-in for a status result. If the string is found, the service will be assumed to be running. (added in Ansible 0.7)
                                                                                                                                                                                                        stateno
                                                                                                                                                                                                        • running
                                                                                                                                                                                                        • started
                                                                                                                                                                                                        • stopped
                                                                                                                                                                                                        • restarted
                                                                                                                                                                                                        • reloaded
                                                                                                                                                                                                        		started, stopped, reloaded, restarted. Started/stopped are idempotent actions that will not run commands unless necessary. restarted will always bounce the service. reloaded will always reload.
                                                                                                                                                                                                        enabledno
                                                                                                                                                                                                        • yes
                                                                                                                                                                                                        • no
                                                                                                                                                                                                        		Whether the service should start on boot.
                                                                                                                                                                                                        nameyes
                                                                                                                                                                                                          		Name of the service.
                                                                                                                                                                                                          - -.. raw:: html - -

                                                                                                                                                                                                          Example action from Ansible Playbooks

                                                                                                                                                                                                          -    service name=httpd state=started
-

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Example action from Ansible Playbooks

                                                                                                                                                                                                          -    service name=httpd state=stopped
-

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Example action from Ansible Playbooks

                                                                                                                                                                                                          -    service name=httpd state=restarted
-

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Example action from Ansible Playbooks

                                                                                                                                                                                                          -    service name=httpd state=reloaded
-

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Example action from Ansible Playbooks

                                                                                                                                                                                                          -    service name=foo pattern=/usr/bin/foo state=started
-

                                                                                                                                                                                                          -
                                                                                                                                                                                                          - diff --git a/docsite/rst/modules/setup.rst b/docsite/rst/modules/setup.rst deleted file mode 100644 index 566b91261a..0000000000 --- a/docsite/rst/modules/setup.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _setup: - -setup -`````````````````````````````` - - -This module is automatically called by playbooks to gather useful variables about remote hosts that can be used in playbooks. It can also be executed directly by ``/usr/bin/ansible`` to check what variables are available to a host. Ansible provides many *facts* about the system, automatically. - - -.. raw:: html - -

                                                                                                                                                                                                          Obtain facts from all hosts and store them indexed by hostname at /tmp/facts.

                                                                                                                                                                                                          -    ansible all -m setup --tree /tmp/facts
-

                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -.. raw:: html - -

                                                                                                                                                                                                          Notes

                                                                                                                                                                                                          -

                                                                                                                                                                                                          More ansible facts will be added with successive releases. If facter or ohai are installed, variables from these programs will also be snapshotted into the JSON file for usage in templating. These variables are prefixed with facter_ and ohai_ so it's easy to tell their source. All variables are bubbled up to the caller. Using the ansible facts and choosing to not install facter and ohai means you can avoid Ruby-dependencies on your remote systems.

                                                                                                                                                                                                          - \ No newline at end of file diff --git a/docsite/rst/modules/shell.rst b/docsite/rst/modules/shell.rst deleted file mode 100644 index 9a3d6e69ba..0000000000 --- a/docsite/rst/modules/shell.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. _shell: - -shell -`````````````````````````````` - -.. versionadded:: 0.2 - -The shell module takes the command name followed by a list of arguments, space delimited. It is almost exactly like the ``command`` module but runs the command through a shell (``/bin/sh``) on the remote node. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                          parameterrequireddefaultchoicescomments
                                                                                                                                                                                                          createsno
                                                                                                                                                                                                            		a filename, when it already exists, this step will NOT be run
                                                                                                                                                                                                            chdirno
                                                                                                                                                                                                              		cd into this directory before running the command (0.6 and later)
                                                                                                                                                                                                              (free form)no
                                                                                                                                                                                                                		The command module takes a free form command to run
                                                                                                                                                                                                                - -.. raw:: html - -

                                                                                                                                                                                                                Execute the command in remote shell

                                                                                                                                                                                                                -    shell somescript.sh >> somelog.txt
-

                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -.. raw:: html - -

                                                                                                                                                                                                                Notes

                                                                                                                                                                                                                -

                                                                                                                                                                                                                If you want to execute a command securely and predicably, it may be better to use the command module instead. Best practices when writing playbooks will follow the trend of using command unless shell is explicitly required. When running ad-hoc commands, use your best judgement.

                                                                                                                                                                                                                - \ No newline at end of file diff --git a/docsite/rst/modules/slurp.rst b/docsite/rst/modules/slurp.rst deleted file mode 100644 index 1d6989accf..0000000000 --- a/docsite/rst/modules/slurp.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. _slurp: - -slurp -`````````````````````````````` - - -This module works like ``fetch``. It is used for fetching a base64- encoded blob containing the data in a remote file. - -.. raw:: html - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                parameterrequireddefaultchoicescomments
                                                                                                                                                                                                                srcyes
                                                                                                                                                                                                                  		The file on the remote system to fetch. This must be a file, not a directory.
                                                                                                                                                                                                                  - -.. raw:: html - -

                                                                                                                                                                                                                  Example using /usr/bin/ansible

                                                                                                                                                                                                                  -    ansible host -m slurp -a 'src=/tmp/xx'
-    host | success >> {
-       "content": "aGVsbG8gQW5zaWJsZSB3b3JsZAo=", 
-       "encoding": "base64"
-    }
-
-

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -.. raw:: html - -

                                                                                                                                                                                                                  Notes

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  See also: fetch

                                                                                                                                                                                                                  - \ No newline at end of file diff --git a/docsite/rst/modules/subversion.rst b/docsite/rst/modules/subversion.rst deleted file mode 100644 index 5ca2d086ec..0000000000 --- a/docsite/rst/modules/subversion.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. _subversion: - -subversion -`````````````````````````````` - -.. versionadded:: 0.7 - -This module is really simple, so for now this checks out from the given branch of a repo at a particular SHA or tag. Latest is not supported, you should not be doing that. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                  parameterrequireddefaultchoicescomments
                                                                                                                                                                                                                  repoyes
                                                                                                                                                                                                                    		The subversion URL to the repository.
                                                                                                                                                                                                                    destyes
                                                                                                                                                                                                                      		Absolute path where the repository should be deployed.
                                                                                                                                                                                                                      forcenoTrue
                                                                                                                                                                                                                      • yes
                                                                                                                                                                                                                      • no
                                                                                                                                                                                                                      		If yes, any modified files in the working repository will be discarded. If no, this module will fail if it encounters modified files.
                                                                                                                                                                                                                      - -.. raw:: html - -

                                                                                                                                                                                                                      Export subversion repository in a specified folder

                                                                                                                                                                                                                      -    subversion repo=svn+ssh://an.example.org/path/to/repo dest=/src/checkout
-

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - -.. raw:: html - -

                                                                                                                                                                                                                      Notes

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Requires subversion and grep on the client.

                                                                                                                                                                                                                      - \ No newline at end of file diff --git a/docsite/rst/modules/supervisorctl.rst b/docsite/rst/modules/supervisorctl.rst deleted file mode 100644 index b9b6691334..0000000000 --- a/docsite/rst/modules/supervisorctl.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. _supervisorctl: - -supervisorctl -`````````````````````````````` - -.. versionadded:: 0.7 - -Manage the state of a program or group of programs running via Supervisord - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                      parameterrequireddefaultchoicescomments
                                                                                                                                                                                                                      stateyes
                                                                                                                                                                                                                      • started
                                                                                                                                                                                                                      • stopped
                                                                                                                                                                                                                      • restarted
                                                                                                                                                                                                                      		The state of service
                                                                                                                                                                                                                      nameyes
                                                                                                                                                                                                                        		The name of the supervisord program/process to manage
                                                                                                                                                                                                                        - -.. raw:: html - -

                                                                                                                                                                                                                        Manage the state of program my_app to be in started state.

                                                                                                                                                                                                                        -    supervisorctl name=my_app state=started
-

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - diff --git a/docsite/rst/modules/template.rst b/docsite/rst/modules/template.rst deleted file mode 100644 index 383aabfe1b..0000000000 --- a/docsite/rst/modules/template.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. _template: - -template -`````````````````````````````` - - -Templates are processed by the Jinja2 templating language (http://jinja.pocoo.org/docs/) - documentation on the template formatting can be found in the Template Designer Documentation (http://jinja.pocoo.org/docs/templates/). - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                        parameterrequireddefaultchoicescomments
                                                                                                                                                                                                                        destyes
                                                                                                                                                                                                                          		Location to render the template to on the remote machine.
                                                                                                                                                                                                                          srcyes
                                                                                                                                                                                                                            		Path of a Jinja2 formatted template on the local server. This can be a relative or absolute path.
                                                                                                                                                                                                                            backupnono
                                                                                                                                                                                                                            • yes
                                                                                                                                                                                                                            • no
                                                                                                                                                                                                                            		Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
                                                                                                                                                                                                                            othersno
                                                                                                                                                                                                                              		all arguments accepted by the file module also work here
                                                                                                                                                                                                                              - -.. raw:: html - -

                                                                                                                                                                                                                              Example from Ansible Playbooks

                                                                                                                                                                                                                              -    template src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644
-

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - -.. raw:: html - -

                                                                                                                                                                                                                              Notes

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Since Ansible version 0.9, templates are loaded with trim_blocks=True.

                                                                                                                                                                                                                              - \ No newline at end of file diff --git a/docsite/rst/modules/user.rst b/docsite/rst/modules/user.rst deleted file mode 100644 index 710d703e47..0000000000 --- a/docsite/rst/modules/user.rst +++ /dev/null @@ -1,123 +0,0 @@ -.. _user: - -user -`````````````````````````````` - -.. versionadded:: 0.2 - -Manage user accounts and user attributes. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                              parameterrequireddefaultchoicescomments
                                                                                                                                                                                                                              commentno
                                                                                                                                                                                                                                		Optionally sets the description (aka GECOS) of user account.
                                                                                                                                                                                                                                shellno
                                                                                                                                                                                                                                  		Optionally set the user's shell.
                                                                                                                                                                                                                                  forcenono
                                                                                                                                                                                                                                  • True
                                                                                                                                                                                                                                  • False
                                                                                                                                                                                                                                  		When used with state=absent, behavior is as with userdel --force.
                                                                                                                                                                                                                                  nameyes
                                                                                                                                                                                                                                    		Name of the user to create, remove or modify.
                                                                                                                                                                                                                                    createhomenoyes
                                                                                                                                                                                                                                    • True
                                                                                                                                                                                                                                    • False
                                                                                                                                                                                                                                    		Unless set to no, a home directory will be made for the user when the account is created.
                                                                                                                                                                                                                                    systemnono
                                                                                                                                                                                                                                    • True
                                                                                                                                                                                                                                    • False
                                                                                                                                                                                                                                    		When creating an account, setting this to yes makes the user a system account. This setting cannot be changed on existing users.
                                                                                                                                                                                                                                    removenono
                                                                                                                                                                                                                                    • True
                                                                                                                                                                                                                                    • False
                                                                                                                                                                                                                                    		When used with state=absent, behavior is as with userdel --remove.
                                                                                                                                                                                                                                    statenopresent
                                                                                                                                                                                                                                    • present
                                                                                                                                                                                                                                    • absent
                                                                                                                                                                                                                                    		Whether the account should exist. When absent, removes the user account.
                                                                                                                                                                                                                                    groupsno
                                                                                                                                                                                                                                      		Puts the user in this comma-delimited list of groups.
                                                                                                                                                                                                                                      homeno
                                                                                                                                                                                                                                        		Optionally set the user's home directory.
                                                                                                                                                                                                                                        groupno
                                                                                                                                                                                                                                          		Optionally sets the user's primary group (takes a group name).
                                                                                                                                                                                                                                          passwordno
                                                                                                                                                                                                                                            		Optionally set the user's password to this crypted value. See the user example in the github examples directory for what this looks like in a playbook.
                                                                                                                                                                                                                                            appendno
                                                                                                                                                                                                                                              		If yes, will only add groups, not set them to just the list in groups.
                                                                                                                                                                                                                                              uidno
                                                                                                                                                                                                                                                		Optionally sets the UID of the user.
                                                                                                                                                                                                                                                - -.. raw:: html - -
                                                                                                                                                                                                                                                - diff --git a/docsite/rst/modules/virt.rst b/docsite/rst/modules/virt.rst deleted file mode 100644 index 8f2f643677..0000000000 --- a/docsite/rst/modules/virt.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. _virt: - -virt -`````````````````````````````` - -.. versionadded:: 0.2 - -Manages virtual machines supported by *libvirt*. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                parameterrequireddefaultchoicescomments
                                                                                                                                                                                                                                                statenono
                                                                                                                                                                                                                                                • running
                                                                                                                                                                                                                                                • shutdown
                                                                                                                                                                                                                                                • destroyed
                                                                                                                                                                                                                                                • undefined
                                                                                                                                                                                                                                                		Note that there may be some lag for state requests like shutdown since these refer only to VM states. After starting a guest, it may not be immediately accessible.
                                                                                                                                                                                                                                                commandno
                                                                                                                                                                                                                                                  		in addition to state management, various non-idempotent commands are available. See examples
                                                                                                                                                                                                                                                  nameyes
                                                                                                                                                                                                                                                    		name of the guest VM being managed
                                                                                                                                                                                                                                                    - -.. raw:: html - -

                                                                                                                                                                                                                                                    Example from Ansible Playbooks

                                                                                                                                                                                                                                                    -    virt guest=alpha state=running
-

                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                    Example guest management with /usr/bin/ansible

                                                                                                                                                                                                                                                    -    ansible host -m virt -a "guest=alpha command=status"
-

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - -.. raw:: html - -

                                                                                                                                                                                                                                                    Notes

                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                    Other non-idempotent commands are: status, pause, unpause, get_xml, autostart, freemem, list_vms, info, nodeinfo, virttype

                                                                                                                                                                                                                                                    - \ No newline at end of file diff --git a/docsite/rst/modules/wait_for.rst b/docsite/rst/modules/wait_for.rst deleted file mode 100644 index a66552608c..0000000000 --- a/docsite/rst/modules/wait_for.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. _wait_for: - -wait_for -`````````````````````````````` - -.. versionadded:: 0.7 - -This is useful for when services are not immediately available after their init scripts return - which is true of certain Java application servers. It is also useful when starting guests with the ``virt`` module and needing to pause until they are ready. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                    parameterrequireddefaultchoicescomments
                                                                                                                                                                                                                                                    delayno
                                                                                                                                                                                                                                                      		number of seconds to wait before starting to poll
                                                                                                                                                                                                                                                      hostno127.0.0.1
                                                                                                                                                                                                                                                        		hostname or IP address to wait for
                                                                                                                                                                                                                                                        portyes
                                                                                                                                                                                                                                                          		port number to poll
                                                                                                                                                                                                                                                          timeoutno300
                                                                                                                                                                                                                                                            		maximum number of seconds to wait for
                                                                                                                                                                                                                                                            statenostarted
                                                                                                                                                                                                                                                            • started
                                                                                                                                                                                                                                                            • stopped
                                                                                                                                                                                                                                                            		either started, or stopped depending on whether the module should poll for the port being open or closed.
                                                                                                                                                                                                                                                            - -.. raw:: html - -

                                                                                                                                                                                                                                                            Example from Ansible Playbooks

                                                                                                                                                                                                                                                            -    wait_for port=8000 delay=10
-

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - diff --git a/docsite/rst/modules/yum.rst b/docsite/rst/modules/yum.rst deleted file mode 100644 index ae63998ecf..0000000000 --- a/docsite/rst/modules/yum.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. _yum: - -yum -`````````````````````````````` - - -Will install, upgrade, remove, and list packages with the *yum* package manager. - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                            parameterrequireddefaultchoicescomments
                                                                                                                                                                                                                                                            statenopresent
                                                                                                                                                                                                                                                            • present
                                                                                                                                                                                                                                                            • latest
                                                                                                                                                                                                                                                            • absent
                                                                                                                                                                                                                                                            		whether to install (present, latest), or remove (absent) a package.
                                                                                                                                                                                                                                                            listno
                                                                                                                                                                                                                                                              		various non-idempotent commands for usage with /usr/bin/ansible and not playbooks. See examples.
                                                                                                                                                                                                                                                              nameyes
                                                                                                                                                                                                                                                                		package name, or package specifier with version, like name-1.0.
                                                                                                                                                                                                                                                                - -.. raw:: html - - 

                                                                                                                                                                                                                                                                -    yum name=httpd state=latest
-

                                                                                                                                                                                                                                                                - 

                                                                                                                                                                                                                                                                -    yum name=httpd state=removed
-

                                                                                                                                                                                                                                                                - 

                                                                                                                                                                                                                                                                -    yum name=httpd state=installed
-

                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                -