mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 22:00:22 -07:00
Mutually reference Windows and non-Windows modules (#25482)
* Mutually reference Windows and non-Windows modules To make it easier for Windows or non-Windows users to find the relevant module information, we are mutually referencing both variants in their documentation. We are also adding a special note if a module works on both Windows and non-Windows targets. * Mutually reference Windows and non-Windows modules To make it easier for Windows or non-Windows users to find the relevant module information, we are mutually referencing both variants in their documentation. We are also adding a special note if a module works on both Windows and non-Windows targets. * Replace 'look at' with 'use', as requested ci_complete
This commit is contained in:
parent
8765eadb30
commit
7d7051fc54
50 changed files with 137 additions and 20 deletions
|
@ -32,6 +32,7 @@ short_description: Add or remove groups
|
|||
requirements: [ groupadd, groupdel, groupmod ]
|
||||
description:
|
||||
- Manage presence of groups on a host.
|
||||
- For Windows targets, use the M(win_group) module instead.
|
||||
options:
|
||||
name:
|
||||
required: true
|
||||
|
@ -53,7 +54,8 @@ options:
|
|||
choices: [ "yes", "no" ]
|
||||
description:
|
||||
- If I(yes), indicates that the group created is a system group.
|
||||
|
||||
notes:
|
||||
- For Windows targets, use the M(win_group) module instead.
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
|
@ -35,6 +35,9 @@ description:
|
|||
contact. It does not make sense in playbooks, but it is useful from
|
||||
C(/usr/bin/ansible) to verify the ability to login and that a usable python is configured.
|
||||
- This is NOT ICMP ping, this is just a trivial test module.
|
||||
- For Windows targets, use the M(ping) module instead.
|
||||
notes:
|
||||
- For Windows targets, use the M(ping) module instead.
|
||||
options: {}
|
||||
author:
|
||||
- "Ansible Core Team"
|
||||
|
|
|
@ -34,6 +34,7 @@ short_description: Manage services.
|
|||
description:
|
||||
- Controls services on remote hosts. Supported init systems include BSD init,
|
||||
OpenRC, SysV, Solaris SMF, systemd, upstart.
|
||||
- For Windows targets, use the M(win_service) module instead.
|
||||
options:
|
||||
name:
|
||||
required: true
|
||||
|
@ -87,6 +88,8 @@ options:
|
|||
- Normally it uses the value of the 'ansible_service_mgr' fact and falls back to the old 'service' module when none matching is found.
|
||||
default: 'auto'
|
||||
version_added: 2.2
|
||||
notes:
|
||||
- For Windows targets, use the M(win_service) module instead.
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
|
@ -69,6 +69,7 @@ description:
|
|||
executed directly by C(/usr/bin/ansible) to check what variables are
|
||||
available to a host. Ansible provides many I(facts) about the system,
|
||||
automatically.
|
||||
- This module is also supported for Windows targets.
|
||||
notes:
|
||||
- More ansible facts will be added with successive releases. If I(facter) or
|
||||
I(ohai) are installed, variables from these programs will also be snapshotted
|
||||
|
@ -85,6 +86,7 @@ notes:
|
|||
their output must be formattable in JSON (Ansible will take care of this). Test the
|
||||
output of your scripts.
|
||||
This option was added in Ansible 2.1.
|
||||
- This module is also supported for Windows targets.
|
||||
author:
|
||||
- "Ansible Core Team"
|
||||
- "Michael DeHaan"
|
||||
|
|
|
@ -33,8 +33,10 @@ notes:
|
|||
- There are specific requirements per platform on user management utilities. However
|
||||
they generally come pre-installed with the system and Ansible will require they
|
||||
are present at runtime. If they are not, a descriptive error message will be shown.
|
||||
- For Windows targets, use the M(win_user) module instead.
|
||||
description:
|
||||
- Manage user accounts and user attributes.
|
||||
- For Windows targets, use the M(win_user) module instead.
|
||||
options:
|
||||
name:
|
||||
required: true
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue