Fixing various module related things.

reviewable/pr18780/r1
Michael DeHaan 12 years ago
parent f3e8ffce43
commit 2d096ea425

6
apt

@ -34,7 +34,7 @@ options:
default: null default: null
state: state:
description: description:
- Indicate the desired package state - Indicates the desired package state
required: false required: false
default: present default: present
choices: [ "installed", "latest", "remove", "absent", "present" ] choices: [ "installed", "latest", "remove", "absent", "present" ]
@ -46,7 +46,7 @@ options:
choices: [ "yes", "no" ] choices: [ "yes", "no" ]
purge: purge:
description: description:
- Will force purge of configuration files if state is set to C(absent). - Will force purging of configuration files if the module state is set to C(absent).
required: false required: false
default: "no" default: "no"
choices: [ "yes", "no" ] choices: [ "yes", "no" ]
@ -63,7 +63,7 @@ options:
choices: [ "yes", "no" ] choices: [ "yes", "no" ]
force: force:
description: description:
- If C(yes) force installs/removes. - If C(yes), force installs/removes.
required: false required: false
default: "no" default: "no"
choices: [ "yes", "no" ] choices: [ "yes", "no" ]

@ -43,9 +43,8 @@ options:
default: present default: present
choices: [ "present", "absent" ] choices: [ "present", "absent" ]
notes: notes:
- This module requires C(apt-add-repository) be available on destination server. To ensure this package is available use the C(apt) module and install the C(python-software-properties) package before using this module. - This module works on Debian and Ubuntu only and requires C(apt-add-repository) be available on destination server. To ensure this package is available use the C(apt) module and install the C(python-software-properties) package before using this module.
- This module works on Ubuntu and unstable Debian only, see U(https://github.com/ansible/ansible/pull/1082). - A bug in C(apt-add-repository) always adds C(deb) and C(deb-src) types for repositories (see the issue on Launchpad U(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.
- A bug in C(apt-add-repository) always adds C(deb) and C(deb-src) types for repositories (see the issue on Launchpad U(https://bugs.launchpad.net/ubuntu/+source/software-properties/+bug/987264)), if some repo don't have source (eg MongoDB repo from 10gen) the system fails while updating repositories.
author: Matt Wright author: Matt Wright
examples: examples:
- code: apt_repository repo=ppa://nginx/stable - code: apt_repository repo=ppa://nginx/stable

@ -50,7 +50,7 @@ options:
default: null default: null
backup: backup:
description: description:
- Create a backup file (if C(yes)) including the timestamp information so - Create a backup file (if C(yes)), including the timestamp information so
you can get the original file back if you somehow clobbered it you can get the original file back if you somehow clobbered it
incorrectly. incorrectly.
required: false required: false

@ -49,6 +49,8 @@ options:
examples: examples:
- code: 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" - code: 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"
description: "Example from Ansible Playbooks" description: "Example from Ansible Playbooks"
- code: "authorized_key user=charlie key=$FILE(/home/charlie/.ssh/id_rsa.pub)"
description: "Shorthand available in Ansible 0.8 and later"
author: Brad Olson author: Brad Olson
''' '''

@ -48,6 +48,12 @@ options:
- a filename, when it already exists, this step will B(not) be run. - a filename, when it already exists, this step will B(not) be run.
required: no required: no
default: null default: null
removes:
description:
- a filename, when it does not exist, this step will B(not) be run.
version_added: "0.8"
required: no
default: null
chdir: chdir:
description: description:
- cd into this directory before running the command - cd into this directory before running the command
@ -58,7 +64,7 @@ examples:
- code: command /sbin/shutdown -t now - code: command /sbin/shutdown -t now
description: "Example from Ansible Playbooks" description: "Example from Ansible Playbooks"
- code: command /usr/bin/make_database.sh arg1 arg2 creates=/path/to/database - code: command /usr/bin/make_database.sh arg1 arg2 creates=/path/to/database
description: "I(creates) and I(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." description: "I(creates), I(removes), and I(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."
notes: notes:
- If you want to run a command through the shell (say you are using C(<), - If you want to run a command through the shell (say you are using C(<),
C(>), C(|), etc), you actually want the M(shell) module instead. The C(>), C(|), etc), you actually want the M(shell) module instead. The

Loading…
Cancel
Save