Add attributes a-c (#75561)

* removed redundant notes
pull/75603/head
Brian Coca 3 years ago committed by GitHub
parent bbf5bbd8e4
commit 051a257092
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -29,14 +29,31 @@ options:
- The groups to add the hostname to. - The groups to add the hostname to.
type: list type: list
aliases: [ group, groupname ] aliases: [ group, groupname ]
extends_documentation_fragment:
- action_common_attributes
attributes:
action:
support: full
async:
support: none
become:
support: none
bypass_host_loop:
support: full
check_mode:
support: full
connection:
support: none
delegation:
support: none
proprietary:
support: full
windows:
support: full
notes: 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 C(loop) construct. If you need to dynamically add all hosts targeted by a playbook for
later use, the C(group_by) module is potentially a better choice.
- The alias C(host) of the parameter C(name) is only available on Ansible 2.4 and newer. - The alias C(host) of the parameter C(name) is only available on Ansible 2.4 and newer.
- Since Ansible 2.4, the C(inventory_dir) variable is now set to C(None) instead of the 'global inventory source', - Since Ansible 2.4, the C(inventory_dir) variable is now set to C(None) instead of the 'global inventory source',
because you can now have multiple sources. An example was added that shows how to partially restore the previous behaviour. because you can now have multiple sources. An example was added that shows how to partially restore the previous behaviour.
- Windows targets are supported by this module.
- Though this module does not change the remote host, we do provide 'changed' status as it can be useful for those trying to track inventory changes. - Though this module does not change the remote host, we do provide 'changed' status as it can be useful for those trying to track inventory changes.
- The hosts added will not bypass the ``--limit`` from the command line, so both of those need to be in agreement to make them available as play targets. - The hosts added will not bypass the ``--limit`` from the command line, so both of those need to be in agreement to make them available as play targets.
They are still available from hostvars and for delegation as a normal part of the inventory. They are still available from hostvars and for delegation as a normal part of the inventory.

@ -170,6 +170,13 @@ requirements:
- python3-apt (python 3) - python3-apt (python 3)
- aptitude (before 2.4) - aptitude (before 2.4)
author: "Matthew Williams (@mgwilliams)" author: "Matthew Williams (@mgwilliams)"
extends_documentation_fragment:
- action_common_attributes
attributes:
check_mode:
support: full
diff_mode:
support: full
notes: notes:
- Three of the upgrade modes (C(full), C(safe) and its alias C(yes)) required C(aptitude) up to 2.3, since 2.4 C(apt-get) is used as a fall-back. - Three of the upgrade modes (C(full), C(safe) and its alias C(yes)) required C(aptitude) up to 2.3, since 2.4 C(apt-get) is used as a fall-back.
- In most cases, packages installed with apt will start newly installed services by default. Most distributions have mechanisms to avoid this. - In most cases, packages installed with apt will start newly installed services by default. Most distributions have mechanisms to avoid this.

@ -19,6 +19,11 @@ version_added: "1.0"
short_description: Add or remove an apt key short_description: Add or remove an apt key
description: description:
- Add or remove an I(apt) key, optionally downloading it. - Add or remove an I(apt) key, optionally downloading it.
extends_documentation_fragment:
- action_common_attributes
attributes:
check_mode:
support: full
notes: notes:
- The apt-key command has been deprecated and suggests to 'manage keyring files in trusted.gpg.d instead'. See the Debian wiki for details. - The apt-key command has been deprecated and suggests to 'manage keyring files in trusted.gpg.d instead'. See the Debian wiki for details.
This module is kept for backwards compatiblity for systems that still use apt-key as the main way to manage apt repository keys. This module is kept for backwards compatiblity for systems that still use apt-key as the main way to manage apt repository keys.
@ -27,7 +32,6 @@ notes:
To generate a full-fingerprint imported key: C(apt-key adv --list-public-keys --with-fingerprint --with-colons)." To generate a full-fingerprint imported key: C(apt-key adv --list-public-keys --with-fingerprint --with-colons)."
- If you specify both the key id and the URL with C(state=present), the task can verify or add the key as needed. - If you specify both the key id and the URL with C(state=present), the task can verify or add the key as needed.
- Adding a new key requires an apt cache update (e.g. using the M(ansible.builtin.apt) module's update_cache option). - Adding a new key requires an apt cache update (e.g. using the M(ansible.builtin.apt) module's update_cache option).
- Supports C(check_mode).
requirements: requirements:
- gpg - gpg
options: options:

@ -17,10 +17,14 @@ module: apt_repository
short_description: Add and remove APT repositories short_description: Add and remove APT repositories
description: description:
- Add or remove an APT repositories in Ubuntu and Debian. - Add or remove an APT repositories in Ubuntu and Debian.
extends_documentation_fragment:
- action_common_attributes
attributes:
check_mode:
support: full
notes: notes:
- This module works on Debian, Ubuntu and their derivatives. - This module works on Debian, Ubuntu and their derivatives.
- This module supports Debian Squeeze (version 6) as well as its successors. - This module supports Debian Squeeze (version 6) as well as its successors.
- Supports C(check_mode).
options: options:
repo: repo:
description: description:

@ -74,6 +74,16 @@ options:
- The command is passed securely so shell features like expansion and pipes won't work. - The command is passed securely so shell features like expansion and pipes won't work.
type: str type: str
version_added: '2.0' version_added: '2.0'
attributes:
action:
support: full
async:
support: none
safe_file_operations:
support: full
vault:
support: full
version_added: '2.2'
seealso: seealso:
- module: ansible.builtin.copy - module: ansible.builtin.copy
- module: ansible.builtin.template - module: ansible.builtin.template
@ -81,6 +91,7 @@ seealso:
author: author:
- Stephen Fromm (@sfromm) - Stephen Fromm (@sfromm)
extends_documentation_fragment: extends_documentation_fragment:
- action_common_attributes
- decrypt - decrypt
- files - files
''' '''

@ -40,8 +40,21 @@ options:
type: bool type: bool
default: no default: no
version_added: "2.8" version_added: "2.8"
notes: extends_documentation_fragment:
- This module is also supported for Windows targets. - action_common_attributes
attributes:
action:
support: full
async:
support: none
connection:
support: none
delegation:
support: none
proprietary:
support: full
windows:
support: full
seealso: seealso:
- module: ansible.builtin.debug - module: ansible.builtin.debug
- module: ansible.builtin.fail - module: ansible.builtin.fail

@ -29,8 +29,15 @@ options:
type: str type: str
choices: [ cleanup, status ] choices: [ cleanup, status ]
default: status default: status
notes: extends_documentation_fragment:
- This module is also supported for Windows targets. - action_common_attributes
attributes:
action:
support: full
async:
support: none
windows:
support: full
seealso: seealso:
- ref: playbooks_async - ref: playbooks_async
description: Detailed information on how to use asynchronous actions and polling. description: Detailed information on how to use asynchronous actions and polling.

@ -86,14 +86,21 @@ options:
default: END default: END
version_added: '2.5' version_added: '2.5'
notes: notes:
- This module supports check mode.
- When using 'with_*' loops be aware that if you do not set a unique mark the block will be overwritten on each iteration. - When using 'with_*' loops be aware that if you do not set a unique mark the block will be overwritten on each iteration.
- As of Ansible 2.3, the I(dest) option has been changed to I(path) as default, but I(dest) still works as well. - As of Ansible 2.3, the I(dest) option has been changed to I(path) as default, but I(dest) still works as well.
- Option I(follow) has been removed in Ansible 2.5, because this module modifies the contents of the file so I(follow=no) doesn't make sense. - Option I(follow) has been removed in Ansible 2.5, because this module modifies the contents of the file so I(follow=no) doesn't make sense.
- When more then one block should be handled in one file you must change the I(marker) per task. - When more then one block should be handled in one file you must change the I(marker) per task.
extends_documentation_fragment: extends_documentation_fragment:
- action_common_attributes
- files - files
- validate - validate
attributes:
check_mode:
support: full
diff_mode:
support: full
safe_file_operations:
support: full
''' '''
EXAMPLES = r''' EXAMPLES = r'''

@ -141,6 +141,8 @@ attributes:
support: full support: full
diff_mode: diff_mode:
support: full support: full
safe_file_operations:
support: full
vault: vault:
support: full support: full
version_added: '2.2' version_added: '2.2'

@ -132,15 +132,18 @@ options:
type: str type: str
version_added: "2.1" version_added: "2.1"
requirements: requirements:
- cron (or cronie on CentOS) - cron (any 'vixie cron' conformant variant, like cronie)
author: author:
- Dane Summers (@dsummersl) - Dane Summers (@dsummersl)
- Mike Grozak (@rhaido) - Mike Grozak (@rhaido)
- Patrick Callahan (@dirtyharrycallahan) - Patrick Callahan (@dirtyharrycallahan)
- Evan Kaufman (@EvanK) - Evan Kaufman (@EvanK)
- Luca Berruti (@lberruti) - Luca Berruti (@lberruti)
notes: extends_documentation_fragment:
- Supports C(check_mode). - action_common_attributes
attributes:
check_mode:
support: full
''' '''
EXAMPLES = r''' EXAMPLES = r'''

Loading…
Cancel
Save