windows: Various small documentation fixes (#23138)

pull/23520/head
Dag Wieers 8 years ago committed by Matt Davis
parent 5ab97b30cd
commit b58cf0d23a

@ -38,7 +38,7 @@ description:
options: options:
free_form: free_form:
description: description:
- the win_command module takes a free form command to run. There is no parameter actually named 'free form'. - the C(win_command) module takes a free form command to run. There is no parameter actually named 'free form'.
See the examples! See the examples!
required: true required: true
creates: creates:

@ -34,7 +34,7 @@ short_description: NSSM - the Non-Sucking Service Manager
description: description:
- nssm is a service helper which doesn't suck. See U(https://nssm.cc/) for more information. - nssm is a service helper which doesn't suck. See U(https://nssm.cc/) for more information.
requirements: requirements:
- "nssm >= 2.24.0 # (install via win_chocolatey) win_chocolatey: name=nssm" - "nssm >= 2.24.0 # (install via M(win_chocolatey)) C(win_chocolatey: name=nssm)"
options: options:
name: name:
description: description:

@ -76,26 +76,26 @@ EXAMPLES = r'''
format: en-AU format: en-AU
copy_settings: True copy_settings: True
# Set the unicode language to English Great Britain # Set the unicode language to English Great Britain, reboot if required
- win_region: - win_region:
unicode_language: en-GB unicode_language: en-GB
register: result register: result
- action: win_reboot - win_reboot:
when: result.restart_required when: result.restart_required
# Set the location to United States # Set the location to United States
- win_region: - win_region:
location: 244 location: 244
# Set format, location and unicode to English Australia and copy settings # Set format, location and unicode to English Australia and copy settings, reboot if required
- win_region: - win_region:
location: 12 location: 12
format: en-AU format: en-AU
unicode_language: en-AU unicode_language: en-AU
register: result register: result
- action: win_reboot - win_reboot:
when: result.restart_required when: result.restart_required
''' '''

@ -36,7 +36,7 @@ description:
options: options:
free_form: free_form:
description: description:
- the win_shell module takes a free form command to run. There is no parameter actually named 'free form'. - The C(win_shell) module takes a free form command to run. There is no parameter actually named 'free form'.
See the examples! See the examples!
required: true required: true
creates: creates:
@ -57,8 +57,9 @@ notes:
better to use the M(win_command) module instead. Best practices when writing better to use the M(win_command) module instead. Best practices when writing
playbooks will follow the trend of using M(win_command) unless C(win_shell) is playbooks will follow the trend of using M(win_command) unless C(win_shell) is
explicitly required. When running ad-hoc commands, use your best judgement. explicitly required. When running ad-hoc commands, use your best judgement.
- WinRM will not return from a command execution until all child processes created have exited. Thus, it is not possible to use win_shell to spawn - WinRM will not return from a command execution until all child processes created have exited.
long-running child or background processes. Consider creating a Windows service for managing background processes. Thus, it is not possible to use C(win_shell) to spawn long-running child or background processes.
Consider creating a Windows service for managing background processes.
author: author:
- Matt Davis - Matt Davis
''' '''

@ -63,15 +63,15 @@ options:
- searched - searched
log_path: log_path:
description: description:
- If set, win_updates will append update progress to the specified file. The directory must already exist. - If set, C(win_updates) will append update progress to the specified file. The directory must already exist.
required: false required: false
author: "Matt Davis (@mattdavispdx)" author: "Matt Davis (@mattdavispdx)"
notes: notes:
- win_updates must be run by a user with membership in the local Administrators group - C(win_updates) must be run by a user with membership in the local Administrators group
- win_updates will use the default update service configured for the machine (Windows Update, Microsoft Update, WSUS, etc) - C(win_updates) will use the default update service configured for the machine (Windows Update, Microsoft Update, WSUS, etc)
- win_updates does not manage reboots, but will signal when a reboot is required with the reboot_required return value. - C(win_updates) does not manage reboots, but will signal when a reboot is required with the reboot_required return value.
- win_updates can take a significant amount of time to complete (hours, in some cases). Performance depends on many factors, including OS version, number of - C(win_updates) can take a significant amount of time to complete (hours, in some cases).
updates, system load, and update server load. Performance depends on many factors, including OS version, number of updates, system load, and update server load.
''' '''
EXAMPLES = r''' EXAMPLES = r'''

@ -33,11 +33,11 @@ version_added: "2.0"
short_description: Installs packages using Web Platform Installer command-line short_description: Installs packages using Web Platform Installer command-line
description: description:
- Installs packages using Web Platform Installer command-line - Installs packages using Web Platform Installer command-line
(http://www.iis.net/learn/install/web-platform-installer/web-platform-installer-v4-command-line-webpicmdexe-rtw-release). (U(http://www.iis.net/learn/install/web-platform-installer/web-platform-installer-v4-command-line-webpicmdexe-rtw-release)).
- Must be installed and present in PATH (see win_chocolatey module; 'webpicmd' is the package name, and you must install 'lessmsi' first too) - Must be installed and present in PATH (see M(win_chocolatey) module; 'webpicmd' is the package name, and you must install 'lessmsi' first too)
- Install IIS first (see win_feature module) - Install IIS first (see M(win_feature) module)
notes: notes:
- accepts EULAs and suppresses reboot - you will need to check manage reboots yourself (see win_reboot module) - accepts EULAs and suppresses reboot - you will need to check manage reboots yourself (see M(win_reboot) module)
options: options:
name: name:
description: description:

Loading…
Cancel
Save