mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-04 23:44:00 -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
|
@ -18,52 +18,55 @@ version_added: "2.7"
|
|||
short_description: Add XML fragment to an XML parent
|
||||
description:
|
||||
- Adds XML fragments formatted as strings to existing XML on remote servers.
|
||||
- For non-Windows targets, use the M(xml) module instead.
|
||||
options:
|
||||
path:
|
||||
description:
|
||||
- The path of remote servers XML.
|
||||
type: str
|
||||
required: true
|
||||
aliases: [ dest, file ]
|
||||
fragment:
|
||||
description:
|
||||
- The string representation of the XML fragment to be added.
|
||||
type: str
|
||||
required: true
|
||||
aliases: [ xmlstring ]
|
||||
xpath:
|
||||
description:
|
||||
- The node of the remote server XML where the fragment will go.
|
||||
type: str
|
||||
required: true
|
||||
backup:
|
||||
description:
|
||||
- Whether to backup the remote server's XML before applying the change.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: no
|
||||
type:
|
||||
description:
|
||||
- The type of XML you are working with.
|
||||
type: str
|
||||
required: yes
|
||||
default: element
|
||||
choices:
|
||||
- element
|
||||
- attribute
|
||||
- text
|
||||
choices: [ attribute, element, text ]
|
||||
attribute:
|
||||
description:
|
||||
- The attribute name if the type is 'attribute'. Required if C(type=attribute).
|
||||
|
||||
- The attribute name if the type is 'attribute'.
|
||||
- Required if C(type=attribute).
|
||||
type: str
|
||||
author:
|
||||
- Richard Levenberg (@richardcs)
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
# Apply our filter to Tomcat web.xml
|
||||
- win_xml:
|
||||
- name: Apply our filter to Tomcat web.xml
|
||||
win_xml:
|
||||
path: C:\apache-tomcat\webapps\myapp\WEB-INF\web.xml
|
||||
fragment: '<filter><filter-name>MyFilter</filter-name><filter-class>com.example.MyFilter</filter-class></filter>'
|
||||
xpath: '/*'
|
||||
|
||||
# Apply sslEnabledProtocols to Tomcat's server.xml
|
||||
- win_xml:
|
||||
- name: Apply sslEnabledProtocols to Tomcat's server.xml
|
||||
win_xml:
|
||||
path: C:\Tomcat\conf\server.xml
|
||||
xpath: '//Server/Service[@name="Catalina"]/Connector[@port="9443"]'
|
||||
attribute: 'sslEnabledProtocols'
|
||||
|
@ -73,17 +76,17 @@ EXAMPLES = r'''
|
|||
|
||||
RETURN = r'''
|
||||
msg:
|
||||
description: what was done
|
||||
description: What was done.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "xml added"
|
||||
err:
|
||||
description: xml comparison exceptions
|
||||
description: XML comparison exceptions.
|
||||
returned: always, for type element and -vvv or more
|
||||
type: list
|
||||
sample: attribute mismatch for actual=string
|
||||
backup:
|
||||
description: name of the backup file, if created
|
||||
description: Name of the backup file, if created.
|
||||
returned: changed
|
||||
type: str
|
||||
sample: C:\config.xml.19700101-000000
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue