1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-07 20:47:16 +00:00

Multiple doc fix 3 (#5238)

* multiple modules 2: fixed markups in doc

* multiple modules 3: fixed markups in doc

* fixed yaml

* Update plugins/modules/cloud/misc/proxmox_template.py

Co-authored-by: Felix Fontein <felix@fontein.de>

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2022-09-06 17:32:35 +12:00 committed by GitHub
parent 999fc475a2
commit 88c3865cdb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 64 additions and 67 deletions

View file

@ -33,7 +33,7 @@ options:
aliases: [ dest ]
section:
description:
- Section name in INI file. This is added if C(state=present) automatically when
- Section name in INI file. This is added if I(state=present) automatically when
a single value is being set.
- If left empty or set to C(null), the I(option) will be placed before the first I(section).
- Using C(null) is also required if the config format does not support sections.
@ -69,11 +69,11 @@ options:
state:
description:
- If set to C(absent) and I(exclusive) set to C(true) all matching I(option) lines are removed.
- If set to C(absent) and I(exclusive) set to C(false) the specified C(option=value) lines are removed,
- If set to C(absent) and I(exclusive) set to C(false) the specified I(option=value) lines are removed,
but the other I(option)s with the same name are not touched.
- If set to C(present) and I(exclusive) set to C(false) the specified C(option=values) lines are added,
- If set to C(present) and I(exclusive) set to C(false) the specified I(option=values) lines are added,
but the other I(option)s with the same name are not touched.
- If set to C(present) and I(exclusive) set to C(true) all given C(option=values) lines will be
- If set to C(present) and I(exclusive) set to C(true) all given I(option=values) lines will be
added and the other I(option)s with the same name are removed.
type: str
choices: [ absent, present ]

View file

@ -28,7 +28,7 @@ description:
mounts the ISO image to a temporary location, and copies files to a given
destination, if needed.
requirements:
- Either 7z (from I(7zip) or I(p7zip) package)
- Either 7z (from C(7zip) or C(p7zip) package)
- Or mount capabilities (root-access, or CAP_SYS_ADMIN capability on Linux)
options:
image:
@ -62,7 +62,7 @@ options:
type: path
notes:
- Only the file checksum (content) is taken into account when extracting files
from the ISO image. If C(force=false), only checks the presence of the file.
from the ISO image. If I(force=false), only checks the presence of the file.
- In Ansible 2.3 this module was using C(mount) and C(umount) commands only,
requiring root access. This is no longer needed with the introduction of 7zip
for extraction.

View file

@ -22,13 +22,13 @@ options:
description:
- Path to the file to operate on.
- This file must exist ahead of time.
- This parameter is required, unless C(xmlstring) is given.
- This parameter is required, unless I(xmlstring) is given.
type: path
aliases: [ dest, file ]
xmlstring:
description:
- A string containing XML on which to operate.
- This parameter is required, unless C(path) is given.
- This parameter is required, unless I(path) is given.
type: str
xpath:
description:
@ -49,7 +49,7 @@ options:
aliases: [ ensure ]
attribute:
description:
- The attribute to select when using parameter C(value).
- The attribute to select when using parameter I(value).
- This is a string, not prepended with C(@).
type: raw
value:
@ -61,31 +61,31 @@ options:
type: raw
add_children:
description:
- Add additional child-element(s) to a selected element for a given C(xpath).
- Add additional child-element(s) to a selected element for a given I(xpath).
- Child elements must be given in a list and each item may be either a string
(eg. C(children=ansible) to add an empty C(<ansible/>) child element),
or a hash where the key is an element name and the value is the element value.
- This parameter requires C(xpath) to be set.
- This parameter requires I(xpath) to be set.
type: list
elements: raw
set_children:
description:
- Set the child-element(s) of a selected element for a given C(xpath).
- Set the child-element(s) of a selected element for a given I(xpath).
- Removes any existing children.
- Child elements must be specified as in C(add_children).
- This parameter requires C(xpath) to be set.
- Child elements must be specified as in I(add_children).
- This parameter requires I(xpath) to be set.
type: list
elements: raw
count:
description:
- Search for a given C(xpath) and provide the count of any matches.
- This parameter requires C(xpath) to be set.
- Search for a given I(xpath) and provide the count of any matches.
- This parameter requires I(xpath) to be set.
type: bool
default: false
print_match:
description:
- Search for a given C(xpath) and print out any matches.
- This parameter requires C(xpath) to be set.
- Search for a given I(xpath) and print out any matches.
- This parameter requires I(xpath) to be set.
type: bool
default: false
pretty_print:
@ -95,13 +95,13 @@ options:
default: false
content:
description:
- Search for a given C(xpath) and get content.
- This parameter requires C(xpath) to be set.
- Search for a given I(xpath) and get content.
- This parameter requires I(xpath) to be set.
type: str
choices: [ attribute, text ]
input_type:
description:
- Type of input for C(add_children) and C(set_children).
- Type of input for I(add_children) and I(set_children).
type: str
choices: [ xml, yaml ]
default: yaml
@ -119,20 +119,20 @@ options:
default: false
insertbefore:
description:
- Add additional child-element(s) before the first selected element for a given C(xpath).
- Add additional child-element(s) before the first selected element for a given I(xpath).
- Child elements must be given in a list and each item may be either a string
(eg. C(children=ansible) to add an empty C(<ansible/>) child element),
or a hash where the key is an element name and the value is the element value.
- This parameter requires C(xpath) to be set.
- This parameter requires I(xpath) to be set.
type: bool
default: false
insertafter:
description:
- Add additional child-element(s) after the last selected element for a given C(xpath).
- Add additional child-element(s) after the last selected element for a given I(xpath).
- Child elements must be given in a list and each item may be either a string
(eg. C(children=ansible) to add an empty C(<ansible/>) child element),
or a hash where the key is an element name and the value is the element value.
- This parameter requires C(xpath) to be set.
- This parameter requires I(xpath) to be set.
type: bool
default: false
requirements:
@ -141,7 +141,7 @@ notes:
- Use the C(--check) and C(--diff) options when testing your expressions.
- The diff output is automatically pretty-printed, so may not reflect the actual file content, only the file structure.
- This module does not handle complicated xpath expressions, so limit xpath selectors to simple expressions.
- Beware that in case your XML elements are namespaced, you need to use the C(namespaces) parameter, see the examples.
- Beware that in case your XML elements are namespaced, you need to use the I(namespaces) parameter, see the examples.
- Namespaces prefix should be used for all children of an element where namespace is defined, unless another namespace is defined for them.
seealso:
- name: Xml module development community wiki