Proper author info for all remaining modules

pull/18777/head
Greg DeKoenigsberg 10 years ago committed by Matt Clay
parent 18ca7aee07
commit eb881d7d5d

@ -81,7 +81,9 @@ notes:
M(command) module is much more secure as it's not affected by the user's
environment.
- " C(creates), C(removes), and C(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."
author: Michael DeHaan
author:
- Ansible Core Team
- Michael DeHaan
'''
EXAMPLES = '''

@ -34,7 +34,9 @@ notes:
playbooks will follow the trend of using M(command) unless M(shell) is
explicitly required. When running ad-hoc commands, use your best
judgement.
author: Michael DeHaan
author:
- Ansible Core Team
- Michael DeHaan
'''
EXAMPLES = '''

@ -32,7 +32,9 @@ options:
version_added: "1.5"
notes:
- It is usually preferable to write Ansible modules than pushing scripts. Convert your script to an Ansible module for bonus points!
author: Michael DeHaan
author:
- Ansible Core Team
- Michael DeHaan
"""
EXAMPLES = '''

@ -57,7 +57,9 @@ notes:
"{{ var | quote }}" instead of just "{{ var }}" to make sure they don't include evil things like semicolons.
requirements: [ ]
author: Michael DeHaan
author:
- Ansible Core Team
- Michael DeHaan
'''
EXAMPLES = '''

@ -89,7 +89,7 @@ notes:
the credentials from C(~/.my.cnf), and finally fall back to using the MySQL
default login of C(root) with no password.
requirements: [ ConfigParser ]
author: Mark Theunissen
author: "Mark Theunissen (@marktheunissen)"
'''
EXAMPLES = '''

@ -121,7 +121,7 @@ notes:
the file."
requirements: [ "MySQLdb" ]
author: Mark Theunissen
author: "Mark Theunissen (@marktheunissen)"
'''
EXAMPLES = """

@ -30,6 +30,7 @@ short_description: Manage MySQL global variables
description:
- Query / Set MySQL variables
version_added: 1.3
author: "Balazs Pocze (@banyek)"
options:
variable:
description:

@ -95,7 +95,7 @@ notes:
- This module uses I(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 C(postgresql), C(libpq-dev), and C(python-psycopg2) packages on the remote host before using this module.
requirements: [ psycopg2 ]
author: Lorin Hochstein
author: "Lorin Hochstein (@lorin)"
'''
EXAMPLES = '''

@ -136,7 +136,7 @@ notes:
another user also, R can still access database objects via these privileges.
- When revoking privileges, C(RESTRICT) is assumed (see PostgreSQL docs).
requirements: [psycopg2]
author: Bernhard Weitzhofer
author: "Bernhard Weitzhofer (@b6d)"
"""
EXAMPLES = """

@ -137,7 +137,7 @@ notes:
to all users. You may not specify password or role_attr_flags when the
PUBLIC user is specified.
requirements: [ psycopg2 ]
author: Lorin Hochstein
author: "Lorin Hochstein (@lorin)"
'''
EXAMPLES = '''

@ -79,7 +79,7 @@ options:
description:
- DEPRECATED. The acl to set or remove. This must always be quoted in the form of '<etype>:<qualifier>:<perms>'. The qualifier may be empty for some types, but the type and perms are always requried. '-' can be used as placeholder when you do not care about permissions. This is now superseded by entity, type and permissions fields.
author: Brian Coca
author: "Brian Coca (@bcoca)"
notes:
- The "acl" module requires that acls are enabled on the target filesystem and that the setfacl and getfacl binaries are installed.
'''

@ -79,7 +79,7 @@ options:
U(http://docs.python.org/2/library/re.html).
required: false
default: null
author: Stephen Fromm
author: "Stephen Fromm (@sfromm)"
extends_documentation_fragment: files
'''

@ -86,7 +86,9 @@ options:
required: false
version_added: "1.5"
extends_documentation_fragment: files
author: Michael DeHaan
author:
- "Ansible Core Team"
- "Michael DeHaan"
notes:
- The "copy" module recursively copy facility does not scale to lots (>hundreds) of files.
For alternative, see synchronize module, which is a wrapper around rsync.

@ -50,7 +50,9 @@ options:
will use the basename of the source file, similar to the copy module.
Obviously this is only handy if the filenames are unique.
requirements: []
author: Michael DeHaan
author:
- "Ansible Core Team"
- "Michael DeHaan"
'''
EXAMPLES = '''

@ -41,7 +41,9 @@ description:
notes:
- See also M(copy), M(template), M(assemble)
requirements: [ ]
author: Michael DeHaan
author:
- "Ansible Core Team"
- "Michael DeHaan"
options:
path:
description:

@ -73,7 +73,7 @@ notes:
Either use M(template) to create a base INI file with a C([default]) section, or use
M(lineinfile) to add the missing line.
requirements: [ ConfigParser ]
author: Jan-Piet Mens
author: "Jan-Piet Mens (@jpmens)"
'''
EXAMPLES = '''

@ -27,7 +27,9 @@ import tempfile
DOCUMENTATION = """
---
module: lineinfile
author: Daniel Hokka Zakrisson, Ahti Kitsik
author:
- "Daniel Hokka Zakrissoni (@dhozac)"
- "Ahti Kitsik (@ahtik)"
extends_documentation_fragment: files
short_description: Ensure a particular line is in a file, or replace an
existing line using a back-referenced regular expression.

@ -25,7 +25,7 @@ import tempfile
DOCUMENTATION = """
---
module: replace
author: Evan Kaufman
author: "Evan Kaufman (@EvanK)"
extends_documentation_fragment: files
short_description: Replace all instances of a particular string in a
file using a back-referenced regular expression.

@ -47,7 +47,7 @@ options:
default: yes
aliases: []
version_added: "1.8"
author: Bruce Pennypacker
author: "Bruce Pennypacker (@bpennypacker)"
'''
EXAMPLES = '''

@ -161,9 +161,9 @@ notes:
- Expect that dest=~/x will be ~<remote_user>/x even if using sudo.
- To exclude files and directories from being synchronized, you may add
C(.rsync-filter) files to the source directory.
author: Timothy Appnel
author: "Timothy Appnel (@tima)"
'''
EXAMPLES = '''

@ -50,7 +50,9 @@ options:
notes:
- "Since Ansible version 0.9, templates are loaded with C(trim_blocks=True)."
requirements: []
author: Michael DeHaan
author:
- Ansible Core Team
- Michael DeHaan
extends_documentation_fragment: files
'''

@ -58,7 +58,7 @@ options:
choices: [ "yes", "no" ]
default: "no"
version_added: "2.0"
author: Dylan Martin
author: "Dylan Martin (@pileofrogs)"
todo:
- detect changed/unchanged for .zip files
- handle common unarchive args, like preserve owner/timestamp etc...

@ -58,7 +58,7 @@ options:
- if yes, dereferences symlinks and sets/gets attributes on symlink target,
otherwise acts on symlink itself.
author: Brian Coca
author: "Brian Coca (@bcoca)"
'''
EXAMPLES = '''

@ -22,7 +22,9 @@ options:
notes:
- This module bypasses the play host loop and only runs once for all the hosts in the play, if you need it
to iterate use a with\_ directive.
author: Seth Vidal
author:
- "Ansible Core Team"
- "Seth Vidal"
'''
EXAMPLES = '''

@ -12,7 +12,7 @@ options:
description:
- The variables whose values will be used as groups
required: true
author: Jeroen Hoekx
author: "Jeroen Hoekx (@jhoekx)"
notes:
- Spaces in group names are converted to dashes '-'.
'''

@ -114,7 +114,7 @@ options:
required: false
# informational: requirements for nodes
requirements: [ urllib2, urlparse ]
author: Jan-Piet Mens
author: "Jan-Piet Mens (@jpmens)"
'''
EXAMPLES='''

@ -37,7 +37,9 @@ options:
notes:
- "See also: M(fetch)"
requirements: []
author: Michael DeHaan
author:
- "Ansible Core Team"
- "Michael DeHaan"
'''
EXAMPLES = '''

@ -143,7 +143,7 @@ options:
# informational: requirements for nodes
requirements: [ urlparse, httplib2 ]
author: Romeo Theriault
author: "Romeo Theriault (@romeotheriault)"
'''
EXAMPLES = '''

@ -85,7 +85,7 @@ notes:
- Also note that I(virtualenv) must be installed on the remote host if the
C(virtualenv) parameter is specified.
requirements: [ "virtualenv" ]
author: Matt Wright
author: "Matt Wright (@mattupstate)"
'''
EXAMPLES = '''

@ -78,7 +78,9 @@ options:
- Allow adding build flags for gem compilation
required: false
version_added: "2.0"
author: Johan Wiren
author:
- "Ansible Core Team"
- "Johan Wiren"
'''
EXAMPLES = '''

@ -100,7 +100,7 @@ options:
notes:
- Please note that virtualenv (U(http://www.virtualenv.org/)) must be installed on the remote host if the virtualenv parameter is specified and the virtualenv needs to be initialized.
requirements: [ "virtualenv", "pip" ]
author: Matt Wright
author: "Matt Wright (@mattupstate)"
'''
EXAMPLES = '''

@ -94,7 +94,7 @@ options:
required: false
version_added: "1.6"
requirements: [ python-apt, aptitude ]
author: Matthew Williams
author: "Matthew Williams (@mgwilliams)"
notes:
- Three of the upgrade modes (C(full), C(safe) and its alias C(yes)) require C(aptitude), otherwise
C(apt-get) suffices.

@ -22,7 +22,7 @@
DOCUMENTATION = '''
---
module: apt_key
author: Jayson Vantuyl & others
author: "Jayson Vantuyl & others (@jvantuyl)"
version_added: "1.0"
short_description: Add or remove an apt key
description:

@ -63,7 +63,7 @@ options:
required: false
default: 'yes'
choices: ['yes', 'no']
author: Alexander Saltanov
author: "Alexander Saltanov (@sashka)"
version_added: "0.7"
requirements: [ python-apt ]
'''

@ -44,7 +44,7 @@ options:
required: false
default: no
choices: [ "yes", "no" ]
author: Evgenii Terechkov
author: "Evgenii Terechkov (@evgkrsk)"
notes: []
'''

@ -7,7 +7,7 @@ short_description: Manage Red Hat Network registration and subscriptions using t
description:
- Manage registration and subscription to the Red Hat Network entitlement platform.
version_added: "1.2"
author: James Laska
author: "James Laska (@jlaska)"
notes:
- In order to register a system, subscription-manager requires either a username and password, or an activationkey.
requirements:

@ -24,7 +24,7 @@ short_description: Adds or removes Red Hat software channels
description:
- Adds or removes Red Hat software channels
version_added: "1.1"
author: Vincent Van der Kussen
author: "Vincent Van der Kussen (@vincentvdk)"
notes:
- this module fetches the system id from RHN.
requirements:

@ -22,7 +22,7 @@
DOCUMENTATION = '''
---
module: rpm_key
author: Hector Acosta <hector.acosta@gazzang.com>
author: "Hector Acosta (@hacosta) <hector.acosta@gazzang.com>"
short_description: Adds or removes a gpg key from the rpm db
description:
- Adds or removes (rpm --import) a gpg key to your rpm database.

@ -121,7 +121,9 @@ options:
notes: []
# informational: requirements for nodes
requirements: [ yum ]
author: Seth Vidal
author:
- "Ansible Core Team"
- "Seth Vidal"
'''
EXAMPLES = '''

@ -21,7 +21,9 @@
DOCUMENTATION = '''
---
module: git
author: Michael DeHaan
author:
- "Ansible Core Team"
- "Michael DeHaan"
version_added: "0.0.1"
short_description: Deploy software (or files) from git checkouts
description:

@ -32,7 +32,7 @@ short_description: Manages Mercurial (hg) repositories.
description:
- Manages Mercurial (hg) repositories. Supports SSH, HTTP/S and local address.
version_added: "1.0"
author: Yeukhon Wong
author: "Yeukhon Wong (@yeukhon)"
options:
repo:
description:

@ -25,7 +25,7 @@ short_description: Deploys a subversion repository.
description:
- Deploy given repository URL / revision to dest. If dest exists, update to the specified revision, otherwise perform a checkout.
version_added: "0.7"
author: Dane Summers, njharman@gmail.com
author: "Dane Summers (@dsummersl) <njharman@gmail.com>"
notes:
- Requires I(svn) to be installed on the client.
requirements: []

@ -81,7 +81,7 @@ options:
version_added: "1.9"
description:
- "Adds or removes authorized keys for particular user accounts"
author: Brad Olson
author: "Brad Olson (@bradobro)"
'''
EXAMPLES = '''

@ -118,7 +118,7 @@ options:
choices: [ "reboot", "yearly", "annually", "monthly", "weekly", "daily", "hourly" ]
requirements:
- cron
author: Dane Summers
author: "Dane Summers (@dsummersl)"
updates: [ 'Mike Grozak', 'Patrick Callahan' ]
"""

@ -21,7 +21,7 @@
DOCUMENTATION = '''
---
module: group
author: Stephen Fromm
author: "Stephen Fromm (@sfromm)"
version_added: "0.0.2"
short_description: Add or remove groups
requirements: [ groupadd, groupdel, groupmod ]

@ -21,7 +21,7 @@
DOCUMENTATION = '''
---
module: hostname
author: Hiroaki Nakamura
author: "Hiroaki Nakamura (@hnakamur)"
version_added: "1.4"
short_description: Manage hostname
requirements: [ hostname ]

@ -79,7 +79,9 @@ options:
notes: []
requirements: []
author: Seth Vidal
author:
- Ansible Core Team
- Seth Vidal
'''
EXAMPLES = '''
# Mount DVD read-only

@ -29,7 +29,9 @@ description:
contact. It does not make sense in playbooks, but it is useful from
C(/usr/bin/ansible)
options: {}
author: Michael DeHaan
author:
- "Ansible Core Team"
- "Michael DeHaan"
'''
EXAMPLES = '''

@ -45,7 +45,7 @@ options:
notes:
- Not tested on any debian based system
requirements: [ ]
author: Stephen Fromm
author: "Stephen Fromm (@sfromm)"
'''
EXAMPLES = '''

@ -45,7 +45,7 @@ options:
notes:
- Not tested on any debian based system
requirements: [ libselinux-python ]
author: Derek Carter <goozbach@friocorte.com>
author: "Derek Carter (@goozbach) <goozbach@friocorte.com>"
'''
EXAMPLES = '''

@ -21,7 +21,9 @@
DOCUMENTATION = '''
---
module: service
author: Michael DeHaan
author:
- "Ansible Core Team"
- "Michael DeHaan"
version_added: "0.1"
short_description: Manage services.
description:

@ -57,7 +57,9 @@ notes:
- If the target host is Windows, you will not currently have the ability to use
C(fact_path) or C(filter) as this is provided by a simpler implementation of the module.
Different facts are returned for Windows hosts.
author: Michael DeHaan
author:
- "Ansible Core Team"
- "Michael DeHaan"
'''
EXAMPLES = """

@ -71,7 +71,7 @@ options:
default: False
notes: []
requirements: []
author: David "DaviXX" CHANIAL <david.chanial@gmail.com>
author: "David CHANIAL (@davixx) <david.chanial@gmail.com>"
'''
EXAMPLES = '''

@ -21,7 +21,7 @@
DOCUMENTATION = '''
---
module: user
author: Stephen Fromm
author: "Stephen Fromm (@sfromm)"
version_added: "0.2"
short_description: Manage user accounts
requirements: [ useradd, userdel, usermod ]

@ -66,7 +66,7 @@ notes:
requirements:
- "python >= 2.6"
- "python-keyczar"
author: James Cammarata
author: "James Cammarata (@jimi-c)"
'''
EXAMPLES = '''

@ -45,7 +45,9 @@ options:
notes:
- See the advanced playbooks chapter for more about using fireball mode.
requirements: [ "zmq", "keyczar" ]
author: Michael DeHaan
author:
- "Ansible Core Team"
- "Michael DeHaan"
'''
EXAMPLES = '''

@ -31,7 +31,9 @@ options:
- "A string expression of the same form that can be passed to the 'when' statement"
- "Alternatively, a list of string expressions"
required: true
author: Michael DeHaan
author:
- "Ansible Core Team"
- "Michael DeHaan"
'''
EXAMPLES = '''

@ -43,7 +43,9 @@ options:
notes:
- See also U(http://docs.ansible.com/playbooks_async.html)
requirements: []
author: Michael DeHaan
author:
- "Ansible Core Team"
- "Michael DeHaan"
'''
import datetime

@ -38,7 +38,9 @@ options:
var:
description:
- A variable name to debug. Mutually exclusive with the 'msg' option.
author: Dag Wieers, Michael DeHaan
author:
- "Dag Wieers (@dagwieers)"
- "Michael DeHaan"
'''
EXAMPLES = '''

@ -34,7 +34,7 @@ options:
required: false
default: "'Failed as requested from task'"
author: Dag Wieers
author: "Dag Wieers (@dagwieers)"
'''
EXAMPLES = '''

@ -10,7 +10,7 @@
DOCUMENTATION = '''
---
author: Benno Joy
author: "Benno Joy (@bennojoy)"
module: include_vars
short_description: Load variables from files, dynamically within a task.
description:

@ -25,7 +25,7 @@ options:
- Optional text to use for the prompt message.
required: false
default: null
author: Tim Bielawa
author: "Tim Bielawa (@tbielawa)"
'''
EXAMPLES = '''

@ -20,7 +20,7 @@
DOCUMENTATION = '''
---
author: Dag Wieers
author: "Dag Wieers (@dagwieers)"
module: set_fact
short_description: Set host facts from a task
description:

@ -101,7 +101,10 @@ options:
notes:
- The ability to use search_regex with a port connection was added in 1.7.
requirements: []
author: Jeroen Hoekx, John Jarvis, Andrii Radyk
author:
- "Jeroen Hoekx (@jhoekx)"
- "John Jarvis (@jarv)"
- "Andrii Radyk (@AnderEnder)"
'''
EXAMPLES = '''

@ -20,6 +20,7 @@ DOCUMENTATION = '''
---
module: apache2_module
version_added: 1.6
author: "Christian Berendt (@berendt)"
short_description: enables/disables a module of the Apache2 webserver
description:
- Enables or disables a specified module of the Apache2 webserver.

@ -92,7 +92,7 @@ notes:
- To be able to use the migrate command, you must have south installed and added as an app in your settings
- To be able to use the collectstatic command, you must have enabled staticfiles in your settings
requirements: [ "virtualenv", "django" ]
author: Scott Anderson
author: "Scott Anderson (@tastychutney)"
'''
EXAMPLES = """

@ -66,7 +66,7 @@ notes:
- "On Debian, Ubuntu, or Fedora: install I(python-passlib)."
- "On RHEL or CentOS: Enable EPEL, then install I(python-passlib)."
requires: [ passlib>=1.6 ]
author: Lorin Hochstein
author: "Lorin Hochstein (@lorin)"
"""
EXAMPLES = """

@ -75,7 +75,9 @@ notes:
- When C(state) = I(present), the module will call C(supervisorctl reread) then C(supervisorctl add) if the program/group does not exist.
- When C(state) = I(restarted), the module will call C(supervisorctl update) then call C(supervisorctl restart).
requirements: [ "supervisorctl" ]
author: Matt Wright, Aaron Wang <inetfuture@gmail.com>
author:
- "Matt Wright (@mattupstate)"
- "Aaron Wang (@inetfuture) <inetfuture@gmail.com>"
'''
EXAMPLES = '''

@ -68,7 +68,9 @@ options:
- no
default: null
aliases: []
author: Paul Durivage / Trond Hindenes
author:
- "Paul Durivage (@angstwad)"
- "Trond Hindenes (@trondhindenes)"
'''
EXAMPLES = '''

@ -41,7 +41,7 @@ options:
required: false
default: yes
aliases: []
author: Paul Durivage
author: "Paul Durivage (@angstwad)"
'''
EXAMPLES = '''

@ -50,7 +50,7 @@ options:
- absent
default: present
aliases: []
author: Chris Hoffman
author: "Chris Hoffman (@chrishoffman)"
'''
EXAMPLES = '''

@ -45,7 +45,7 @@ options:
description:
- Path to a file created by installing the MSI to prevent from
attempting to reinstall the package on every run
author: Matt Martz
author: "Matt Martz (@sivel)"
'''
EXAMPLES = '''

@ -35,7 +35,7 @@ options:
required: false
default: 'pong'
aliases: []
author: Chris Church
author: "Chris Church (@cchurch)"
'''
EXAMPLES = '''

@ -55,7 +55,7 @@ options:
- restarted
default: null
aliases: []
author: Chris Hoffman
author: "Chris Hoffman (@chrishoffman)"
'''
EXAMPLES = '''

@ -38,7 +38,7 @@ options:
required: false
default: yes
aliases: []
author: Chris Church
author: "Chris Church (@cchurch)"
'''
EXAMPLES = '''

@ -127,7 +127,9 @@ options:
- query
default: present
aliases: []
author: Paul Durivage / Chris Church
author:
- "Paul Durivage (@angstwad)"
- "Chris Church (@cchurch)"
'''
EXAMPLES = '''

Loading…
Cancel
Save