diff --git a/Makefile b/Makefile index b487d7d4d0..5ab48918f0 100644 --- a/Makefile +++ b/Makefile @@ -1,9 +1,10 @@ #!/usr/bin/make SITELIB = $(shell python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()") +FORMATTER=../ansible/hacking/module_formatter.py all: clean docs -docs: clean +docs: clean modules ./build-site.py viewdocs: clean @@ -24,3 +25,6 @@ clean: .PHONEY: docs clean +modules: $(FORMATTER) ../ansible/hacking/templates/rst.j2 + $(FORMATTER) -t rst --template-dir=../ansible/hacking/templates --module-dir=../ansible/library -o rst/modules/ + diff --git a/rst/modules.rst b/rst/modules.rst index 3deb1761ac..6b96a3a622 100644 --- a/rst/modules.rst +++ b/rst/modules.rst @@ -55,6 +55,7 @@ Let's see what's available in the Ansible module library, out of the box: .. include:: modules/get_url.rst .. include:: modules/git.rst .. include:: modules/group.rst +.. include:: modules/ini_file.rst .. include:: modules/lineinfile.rst .. include:: modules/mount.rst .. include:: modules/mysql_db.rst diff --git a/rst/modules/get_url.rst b/rst/modules/get_url.rst index 402f0edb6f..1425698378 100644 --- a/rst/modules/get_url.rst +++ b/rst/modules/get_url.rst @@ -1,29 +1,40 @@ .. _get_url: get_url -``````` +```````````````````````` -Downloads files from http, https, or ftp to the remote server. The remote server must have direct -access to the remote resource. +.. 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. + + +============== ========== ========== ============================================================ +parameter required default comments +============== ========== ========== ============================================================ +url yes None HTTP, HTTPS, or FTP URL +dest yes None 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. +thirsty 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. +others all arguments accepted by the ``file`` module also work here +============== ========== ========== ============================================================ + + + + +FIXME: examples! + + + +.. note:: + + + This module doesn't support proxies or passwords. + + Also see the ``template`` module. -+--------------------+----------+---------+----------------------------------------------------------------------------+ -| parameter | required | default | comments | -+====================+==========+=========+============================================================================+ -| url | yes | | http, https, or ftp URL | -+--------------------+----------+---------+----------------------------------------------------------------------------+ -| dest | yes | | 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. | -+--------------------+----------+---------+----------------------------------------------------------------------------+ -| thirsty | no | 'no' | (new in 0.7) 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. | -+--------------------+----------+---------+----------------------------------------------------------------------------+ -| OTHERS | no | | all arguments accepted by the file module also work here | -+--------------------+----------+---------+----------------------------------------------------------------------------+ Example action from Ansible :doc:`playbooks`:: - - action: get_url url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0444 + get_url url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440 +