cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fixes win_dsc docs (#26122)

Browse source 
* hacking dsc docs

* remove code snippet

* again...

* more testing

* trying a short version

* moar text
This commit is contained in:
Trond Hindenes 2017-06-27 00:42:31 +02:00 committed by Jordan Borean
parent 9d932b64f0
commit 7cc38e1b32
1 changed files with 7 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
lib/ansible/modules/windows/win_dsc.py
View file

@ -30,24 +30,19 @@ DOCUMENTATION = r'''
module: win_dsc module: win_dsc
version_added: "2.4" version_added: "2.4"
short_description: Invokes a PowerShell DSC configuration short_description: Invokes a PowerShell DSC configuration
description: | description:
Invokes a PowerShell DSC Configuration. Requires PowerShell version 5 (February release or newer). - Invokes a PowerShell DSC Configuration. Requires PowerShell version 5 (February release or newer).
Most of the parameters for this module are dynamic and will vary depending on the DSC Resource. - Most of the parameters for this module are dynamic and will vary depending on the DSC Resource.
In order to find the required parameters for a given DSC resource, you can use the following on-liner:
'Get-DscResource <dsc_resource> | select -ExpandProperty properties'
Also note that credentials are handled as follows: If the resource accepts a credential type property called "cred",
the ansible parameters would be cred_username and cred_password.
These will be used to inject a credential object on the fly for the DSC resource.
options: options:
resource_name: resource_name:
description: description:
- The DSC Resource to use. Must be accessible to PowerShell using any of the default paths. - The DSC Resource to use. Must be accessible to PowerShell using any of the default paths.
required: true required: true
module_version: module_version:
description: | description:
Can be used to configure the exact version of the dsc resource to be invoked. - Can be used to configure the exact version of the dsc resource to be invoked.
Useful if the target node has multiple versions installed of the module containing the DSC resource. - Useful if the target node has multiple versions installed of the module containing the DSC resource.
If not specified, the module will follow standard Powershell convention and use the highest version available. - If not specified, the module will follow standard Powershell convention and use the highest version available.
default: latest default: latest
author: Trond Hindenes author: Trond Hindenes
''' '''