mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 20:01:25 -07:00
d863027159
* 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
61 lines
1.7 KiB
Python
61 lines
1.7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2017, Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: win_power_plan
|
|
short_description: Changes the power plan of a Windows system
|
|
description:
|
|
- This module will change the power plan of a Windows system to the defined string.
|
|
- Windows defaults to C(balanced) which will cause CPU throttling. In some cases it can be preferable
|
|
to change the mode to C(high performance) to increase CPU performance.
|
|
version_added: "2.4"
|
|
requirements:
|
|
- Windows Server 2008R2 (6.1)/Windows 7 or higher
|
|
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).
|
|
type: str
|
|
required: yes
|
|
author:
|
|
- Noah Sparks (@nwsparks)
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Change power plan to high performance
|
|
win_power_plan:
|
|
name: high performance
|
|
'''
|
|
|
|
RETURN = r'''
|
|
power_plan_name:
|
|
description: Value of the intended power plan.
|
|
returned: always
|
|
type: str
|
|
sample: balanced
|
|
power_plan_enabled:
|
|
description: State of the intended power plan.
|
|
returned: success
|
|
type: bool
|
|
sample: true
|
|
all_available_plans:
|
|
description: The name and enabled state of all power plans.
|
|
returned: always
|
|
type: dict
|
|
sample: |
|
|
{
|
|
"High performance": false,
|
|
"Balanced": true,
|
|
"Power saver": false
|
|
}
|
|
'''
|