mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 14:40:19 -07:00
Windows: Add missing parameter types and doc fixes (#50232)
* Windows: Add missing parameter types and doc fixes This PR includes: - Adding missing parameter types - Various documentation fixes * Update lib/ansible/modules/windows/win_copy.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_credential.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_domain_computer.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_domain_user.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_environment.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_psexec.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_uri.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_wait_for.py Co-Authored-By: dagwieers <dag@wieers.com> * Ensure docstrings are raw strings
This commit is contained in:
parent
f80ce60cf9
commit
d863027159
92 changed files with 982 additions and 716 deletions
|
@ -8,7 +8,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: win_power_plan
|
||||
short_description: Changes the power plan of a Windows system
|
||||
|
@ -22,14 +22,16 @@ requirements:
|
|||
options:
|
||||
name:
|
||||
description:
|
||||
- String value that indicates the desired power plan. The power plan must already be
|
||||
present on the system. Commonly there will be options for C(balanced) and C(high performance).
|
||||
- String value that indicates the desired power plan.
|
||||
- The power plan must already be present on the system.
|
||||
- Commonly there will be options for C(balanced) and C(high performance).
|
||||
type: str
|
||||
required: yes
|
||||
author:
|
||||
- Noah Sparks (@nwsparks)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r'''
|
||||
- name: Change power plan to high performance
|
||||
win_power_plan:
|
||||
name: high performance
|
||||
|
@ -37,17 +39,17 @@ EXAMPLES = '''
|
|||
|
||||
RETURN = r'''
|
||||
power_plan_name:
|
||||
description: Value of the intended power plan
|
||||
description: Value of the intended power plan.
|
||||
returned: always
|
||||
type: str
|
||||
sample: balanced
|
||||
power_plan_enabled:
|
||||
description: State of the intended power plan
|
||||
description: State of the intended power plan.
|
||||
returned: success
|
||||
type: bool
|
||||
sample: True
|
||||
sample: true
|
||||
all_available_plans:
|
||||
description: The name and enabled state of all power plans
|
||||
description: The name and enabled state of all power plans.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: |
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue