ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Use semantic markup (modules t-z) (#6698)

Browse source 
* Use semantic markup.

* Fix escaping.
This commit is contained in:
Felix Fontein 2023-06-18 19:48:01 +02:00 committed by GitHub
parent 3b13c30112
commit ccdcf70d69
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
29 changed files with 186 additions and 189 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
plugins/modules/cobbler_system.py
View file

@ -30,7 +30,7 @@ options:
port:
description:
- Port number to be used for REST connection.
- The default value depends on parameter I(use_ssl).
- The default value depends on parameter O(use_ssl).
type: int
username:
description:

2
plugins/modules/mattermost.py
View file

@ -39,7 +39,7 @@ options:
description:
- Mattermost webhook api key. Log into your mattermost site, go to
Menu -> Integration -> Incoming Webhook -> Add Incoming Webhook.
This will give you full URL. I(api_key) is the last part.
This will give you full URL. O(api_key) is the last part.
http://mattermost.example.com/hooks/C(API_KEY)
required: true
text:

2
plugins/modules/maven_artifact.py
View file

@ -129,7 +129,7 @@ options:
keep_name:
description:
- If V(true), the downloaded artifact's name is preserved, i.e the version number remains part of it.
- This option only has effect when I(dest) is a directory and I(version) is set to V(latest) or O(version_by_spec)
- This option only has effect when O(dest) is a directory and O(version) is set to V(latest) or O(version_by_spec)
is defined.
type: bool
default: false

2
plugins/modules/read_csv.py
View file

@ -72,7 +72,7 @@ options:
- The default value depends on the dialect used.
type: bool
seealso:
- plugin: community.general.csvfile
- plugin: ansible.builtin.csvfile
plugin_type: lookup
description: Can be used to do selective lookups in CSV files from Jinja.
'''

4
plugins/modules/telegram.py
View file

@ -20,7 +20,7 @@ short_description: Send notifications via telegram
description:
- Send notifications via telegram bot, to a verified group or user.
- Also, the user may try to use any other telegram bot API method, if you specify I(api_method) argument.
- Also, the user may try to use any other telegram bot API method, if you specify O(api_method) argument.
notes:
- You will require a telegram account and create telegram bot to use this module.
extends_documentation_fragment:
@ -47,7 +47,7 @@ options:
type: dict
description:
- Any parameters for the method.
- For reference to default method, C(SendMessage), see U(https://core.telegram.org/bots/api#sendmessage).
- For reference to default method, V(SendMessage), see U(https://core.telegram.org/bots/api#sendmessage).
version_added: 2.0.0
'''

16
plugins/modules/terraform.py
View file

@ -55,7 +55,7 @@ options:
version_added: 3.0.0
workspace:
description:
- The terraform workspace to work with. This sets the C(TF_WORKSPACE) environmental variable
- The terraform workspace to work with. This sets the E(TF_WORKSPACE) environmental variable
that is used to override workspace selection. For more information about workspaces
have a look at U(https://developer.hashicorp.com/terraform/language/state/workspaces).
type: str
@ -83,7 +83,7 @@ options:
description:
- The path to a variables file for Terraform to fill into the TF
configurations. This can accept a list of paths to multiple variables files.
- Up until Ansible 2.9, this option was usable as I(variables_file).
- Up until Ansible 2.9, this option was usable as O(variables_file).
type: list
elements: path
aliases: [ 'variables_file' ]
@ -91,18 +91,18 @@ options:
description:
- A group of key-values pairs to override template variables or those in variables files.
By default, only string and number values are allowed, which are passed on unquoted.
- Support complex variable structures (lists, dictionaries, numbers, and booleans) to reflect terraform variable syntax when I(complex_vars=true).
- Support complex variable structures (lists, dictionaries, numbers, and booleans) to reflect terraform variable syntax when O(complex_vars=true).
- Ansible integers or floats are mapped to terraform numbers.
- Ansible strings are mapped to terraform strings.
- Ansible dictionaries are mapped to terraform objects.
- Ansible lists are mapped to terraform lists.
- Ansible booleans are mapped to terraform booleans.
- "B(Note) passwords passed as variables will be visible in the log output. Make sure to use I(no_log=true) in production!"
- "B(Note) passwords passed as variables will be visible in the log output. Make sure to use C(no_log=true) in production!"
type: dict
complex_vars:
description:
- Enable/disable capability to handle complex variable structures for C(terraform).
- If C(true) the I(variables) also accepts dictionaries, lists, and booleans to be passed to C(terraform).
- If V(true) the O(variables) also accepts dictionaries, lists, and booleans to be passed to C(terraform).
Strings that are passed are correctly quoted.
- When disabled, supports only simple variables (strings, integers, and floats), and passes them on unquoted.
type: bool
@ -135,7 +135,7 @@ options:
type: bool
overwrite_init:
description:
- Run init even if C(.terraform/terraform.tfstate) already exists in I(project_path).
- Run init even if C(.terraform/terraform.tfstate) already exists in O(project_path).
default: true
type: bool
version_added: '3.2.0'
@ -165,7 +165,7 @@ options:
check_destroy:
description:
- Apply only when no resources are destroyed. Note that this only prevents "destroy" actions,
but not "destroy and re-create" actions. This option is ignored when I(state=absent).
but not "destroy and re-create" actions. This option is ignored when O(state=absent).
type: bool
default: false
version_added: '3.3.0'
@ -251,7 +251,7 @@ EXAMPLES = """
RETURN = """
outputs:
type: complex
description: A dictionary of all the TF outputs by their assigned name. Use C(.outputs.MyOutputName.value) to access the value.
description: A dictionary of all the TF outputs by their assigned name. Use RV(ignore:outputs.MyOutputName.value) to access the value.
returned: on success
sample: '{"bukkit_arn": {"sensitive": false, "type": "string", "value": "arn:aws:s3:::tf-test-bukkit"}'
contains:

16
plugins/modules/udm_dns_record.py
View file

@ -21,7 +21,7 @@ description:
It uses the python API of the UCS to create a new object or edit it."
requirements:
- Univention
- ipaddress (for I(type=ptr_record))
- ipaddress (for O(type=ptr_record))
extends_documentation_fragment:
- community.general.attributes
attributes:
@ -48,21 +48,21 @@ options:
required: true
description:
- Corresponding DNS zone for this record, e.g. example.com.
- For PTR records this has to be the full reverse zone (for example C(1.1.192.in-addr.arpa)).
- For PTR records this has to be the full reverse zone (for example V(1.1.192.in-addr.arpa)).
type:
type: str
required: true
description:
- "Define the record type. C(host_record) is a A or AAAA record,
C(alias) is a CNAME, C(ptr_record) is a PTR record, C(srv_record)
is a SRV record and C(txt_record) is a TXT record."
- "The available choices are: C(host_record), C(alias), C(ptr_record), C(srv_record), C(txt_record)."
- "Define the record type. V(host_record) is a A or AAAA record,
V(alias) is a CNAME, V(ptr_record) is a PTR record, V(srv_record)
is a SRV record and V(txt_record) is a TXT record."
- "The available choices are: V(host_record), V(alias), V(ptr_record), V(srv_record), V(txt_record)."
data:
type: dict
default: {}
description:
- "Additional data for this record, e.g. ['a': '192.0.2.1'].
Required if I(state=present)."
- "Additional data for this record, for example V({'a': '192.0.2.1'})."
- Required if O(state=present).
'''

8
plugins/modules/udm_dns_zone.py
View file

@ -38,26 +38,26 @@ options:
required: true
description:
- Define if the zone is a forward or reverse DNS zone.
- "The available choices are: C(forward_zone), C(reverse_zone)."
- "The available choices are: V(forward_zone), V(reverse_zone)."
zone:
type: str
required: true
description:
- DNS zone name, e.g. C(example.com).
- DNS zone name, for example V(example.com).
aliases: [name]
nameserver:
type: list
elements: str
default: []
description:
- List of appropriate name servers. Required if I(state=present).
- List of appropriate name servers. Required if O(state=present).
interfaces:
type: list
elements: str
default: []
description:
- List of interface IP addresses, on which the server should
response this zone. Required if I(state=present).
response this zone. Required if O(state=present).
refresh:
type: int

7
plugins/modules/udm_share.py
View file

@ -42,18 +42,17 @@ options:
host:
required: false
description:
- Host FQDN (server which provides the share), e.g. C({{
ansible_fqdn }}). Required if I(state=present).
- Host FQDN (server which provides the share), for example V({{ ansible_fqdn }}). Required if O(state=present).
type: str
path:
required: false
description:
- Directory on the providing server, e.g. C(/home). Required if I(state=present).
- Directory on the providing server, for example V(/home). Required if O(state=present).
type: path
sambaName:
required: false
description:
- Windows name. Required if I(state=present).
- Windows name. Required if O(state=present).
type: str
aliases: [ samba_name ]
ou:

36
plugins/modules/udm_user.py
View file

@ -42,15 +42,15 @@ options:
type: str
firstname:
description:
- First name. Required if I(state=present).
- First name. Required if O(state=present).
type: str
lastname:
description:
- Last name. Required if I(state=present).
- Last name. Required if O(state=present).
type: str
password:
description:
- Password. Required if I(state=present).
- Password. Required if O(state=present).
type: str
birthday:
description:
@ -103,13 +103,13 @@ options:
description:
- "POSIX groups, the LDAP DNs of the groups will be found with the
LDAP filter for each group as $GROUP:
C((&(objectClass=posixGroup)(cn=$GROUP)))."
V((&(objectClass=posixGroup\\)(cn=$GROUP\\)\\))."
type: list
elements: str
home_share:
description:
- "Home NFS share. Must be a LDAP DN, e.g.
C(cn=home,cn=shares,ou=school,dc=example,dc=com)."
V(cn=home,cn=shares,ou=school,dc=example,dc=com)."
aliases: [ homeShare ]
type: str
home_share_path:
@ -126,7 +126,7 @@ options:
elements: str
homedrive:
description:
- Windows home drive, e.g. C("H:").
- Windows home drive, for example V("H:").
type: str
mail_alternative_address:
default: []
@ -189,7 +189,7 @@ options:
primary_group:
description:
- Primary group. This must be the group LDAP DN.
- If not specified, it defaults to C(cn=Domain Users,cn=groups,$LDAP_BASE_DN).
- If not specified, it defaults to V(cn=Domain Users,cn=groups,$LDAP_BASE_DN).
aliases: [ primaryGroup ]
type: str
profilepath:
@ -224,7 +224,7 @@ options:
default: []
sambahome:
description:
- Windows home path, e.g. C('\\$FQDN\$USERNAME').
- Windows home path, for example V('\\\\$FQDN\\$USERNAME').
type: str
scriptpath:
description:
@ -253,7 +253,7 @@ options:
type: str
title:
description:
- Title, e.g. C(Prof.).
- Title, for example V(Prof.).
type: str
unixhome:
description:
@ -262,33 +262,33 @@ options:
type: str
userexpiry:
description:
- Account expiry date, e.g. C(1999-12-31).
- Account expiry date, for example V(1999-12-31).
- If not specified, it defaults to the current day plus one year.
type: str
position:
default: ''
description:
- "Define the whole position of users object inside the LDAP tree,
e.g. C(cn=employee,cn=users,ou=school,dc=example,dc=com)."
for example V(cn=employee,cn=users,ou=school,dc=example,dc=com)."
type: str
update_password:
default: always
choices: [ always, on_create ]
description:
- "C(always) will update passwords if they differ.
C(on_create) will only set the password for newly created users."
- "V(always) will update passwords if they differ.
V(on_create) will only set the password for newly created users."
type: str
ou:
default: ''
description:
- "Organizational Unit inside the LDAP Base DN, e.g. C(school) for
- "Organizational Unit inside the LDAP Base DN, for example V(school) for
LDAP OU C(ou=school,dc=example,dc=com)."
type: str
subpath:
default: 'cn=users'
description:
- "LDAP subpath inside the organizational unit, e.g.
C(cn=teachers,cn=users) for LDAP container
- "LDAP subpath inside the organizational unit, for example
V(cn=teachers,cn=users) for LDAP container
C(cn=teachers,cn=users,dc=example,dc=com)."
type: str
'''
@ -302,7 +302,7 @@ EXAMPLES = '''
firstname: Foo
lastname: Bar
- name: Create a user with the DN C(uid=foo,cn=teachers,cn=users,ou=school,dc=school,dc=example,dc=com)
- name: Create a user with the DN uid=foo,cn=teachers,cn=users,ou=school,dc=school,dc=example,dc=com
community.general.udm_user:
name: foo
password: secure_password
@ -312,7 +312,7 @@ EXAMPLES = '''
subpath: 'cn=teachers,cn=users'
# or define the position
- name: Create a user with the DN C(uid=foo,cn=teachers,cn=users,ou=school,dc=school,dc=example,dc=com)
- name: Create a user with the DN uid=foo,cn=teachers,cn=users,ou=school,dc=school,dc=example,dc=com
community.general.udm_user:
name: foo
password: secure_password

8
plugins/modules/urpmi.py
View file

@ -16,7 +16,7 @@ DOCUMENTATION = '''
module: urpmi
short_description: Urpmi manager
description:
- Manages packages with I(urpmi) (such as for Mageia or Mandriva)
- Manages packages with C(urpmi) (such as for Mageia or Mandriva)
extends_documentation_fragment:
- community.general.attributes
attributes:
@ -45,19 +45,19 @@ options:
default: false
no_recommends:
description:
- Corresponds to the C(--no-recommends) option for I(urpmi).
- Corresponds to the C(--no-recommends) option for C(urpmi).
type: bool
default: true
force:
description:
- Assume "yes" is the answer to any question urpmi has to ask.
Corresponds to the C(--force) option for I(urpmi).
Corresponds to the C(--force) option for C(urpmi).
type: bool
default: true
root:
description:
- Specifies an alternative install root, relative to which all packages will be installed.
Corresponds to the C(--root) option for I(urpmi).
Corresponds to the C(--root) option for C(urpmi).
aliases: [ installroot ]
type: str
author:

8
plugins/modules/vertica_user.py
View file

@ -8,7 +8,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
DOCUMENTATION = r'''
---
module: vertica_user
short_description: Adds or removes Vertica database users and assigns roles
@ -44,7 +44,7 @@ options:
- The user's password encrypted by the MD5 algorithm.
- The password must be generated with the format C("md5" + md5[password + username]),
resulting in a total of 35 characters. An easy way to do this is by querying
the Vertica database with select 'md5'||md5('<user_password><user_name>').
the Vertica database with select V('md5'||md5('<user_password><user_name>'\)).
type: str
expired:
description:
@ -53,7 +53,7 @@ options:
ldap:
description:
- Set to true if users are authenticated via LDAP.
- The user will be created with password expired and set to I($ldap$).
- The user will be created with password expired and set to V($ldap$).
type: bool
roles:
description:
@ -62,7 +62,7 @@ options:
type: str
state:
description:
- Whether to create C(present), drop C(absent) or lock C(locked) a user.
- Whether to create (V(present)), drop (V(absent)), or lock (V(locked)) a user.
choices: ['present', 'absent', 'locked']
default: present
type: str

26
plugins/modules/vmadm.py
View file

@ -39,7 +39,7 @@ options:
choices: [ joyent, joyent-minimal, lx, kvm, bhyve ]
default: joyent
description:
- Type of virtual machine. The C(bhyve) option was added in community.general 0.2.0.
- Type of virtual machine. The V(bhyve) option was added in community.general 0.2.0.
type: str
boot:
required: false
@ -50,7 +50,7 @@ options:
required: false
description:
- Sets a limit on the amount of CPU time that can be used by a VM.
Use C(0) for no cap.
Use V(0) for no cap.
type: int
cpu_shares:
required: false
@ -95,7 +95,7 @@ options:
docker:
required: false
description:
- Docker images need this flag enabled along with the I(brand) set to C(lx).
- Docker images need this flag enabled along with the O(brand) set to C(lx).
type: bool
filesystems:
required: false
@ -147,8 +147,8 @@ options:
internal_metadata_namespace:
required: false
description:
- List of namespaces to be set as I(internal_metadata-only); these namespaces
will come from I(internal_metadata) rather than I(customer_metadata).
- List of namespaces to be set as C(internal_metadata-only); these namespaces
will come from O(internal_metadata) rather than O(customer_metadata).
type: str
kernel_version:
required: false
@ -164,7 +164,7 @@ options:
required: false
description:
- Resolvers in C(/etc/resolv.conf) will be updated when updating
the I(resolvers) property.
the O(resolvers) property.
type: bool
max_locked_memory:
required: false
@ -263,11 +263,11 @@ options:
choices: [ present, running, absent, deleted, stopped, created, restarted, rebooted ]
default: running
description:
- States for the VM to be in. Please note that C(present), C(stopped) and C(restarted)
operate on a VM that is currently provisioned. C(present) means that the VM will be
created if it was absent, and that it will be in a running state. C(absent) will
- States for the VM to be in. Please note that V(present), V(stopped) and V(restarted)
operate on a VM that is currently provisioned. V(present) means that the VM will be
created if it was absent, and that it will be in a running state. V(absent) will
shutdown the zone before removing it.
C(stopped) means the zone will be created if it doesn't exist already, before shutting
V(stopped) means the zone will be created if it does not exist already, before shutting
it down.
type: str
tmpfs:
@ -278,7 +278,7 @@ options:
uuid:
required: false
description:
- UUID of the VM. Can either be a full UUID or C(*) for all VMs.
- UUID of the VM. Can either be a full UUID or V(*) for all VMs.
type: str
vcpus:
required: false
@ -309,8 +309,8 @@ options:
vnc_port:
required: false
description:
- TCP port to listen of the VNC server. Or set C(0) for random,
or C(-1) to disable.
- TCP port to listen of the VNC server. Or set V(0) for random,
or V(-1) to disable.
type: int
zfs_data_compression:
required: false

6
plugins/modules/wdc_redfish_command.py
View file

@ -38,11 +38,11 @@ options:
elements: str
baseuri:
description:
- Base URI of OOB controller. Must include this or I(ioms).
- Base URI of OOB controller. Must include this or O(ioms).
type: str
ioms:
description:
- List of IOM FQDNs for the enclosure. Must include this or I(baseuri).
- List of IOM FQDNs for the enclosure. Must include this or O(baseuri).
type: list
elements: str
username:
@ -65,7 +65,7 @@ options:
resource_id:
required: false
description:
- ID of the component to modify, such as C(Enclosure), C(IOModuleAFRU), C(PowerSupplyBFRU), C(FanExternalFRU3), or C(FanInternalFRU).
- ID of the component to modify, such as V(Enclosure), V(IOModuleAFRU), V(PowerSupplyBFRU), V(FanExternalFRU3), or V(FanInternalFRU).
type: str
version_added: 5.4.0
update_image_uri:

4
plugins/modules/wdc_redfish_info.py
View file

@ -33,11 +33,11 @@ options:
elements: str
baseuri:
description:
- Base URI of OOB controller. Must include this or I(ioms).
- Base URI of OOB controller. Must include this or O(ioms).
type: str
ioms:
description:
- List of IOM FQDNs for the enclosure. Must include this or I(baseuri).
- List of IOM FQDNs for the enclosure. Must include this or O(baseuri).
type: list
elements: str
username:

4
plugins/modules/webfaction_app.py
View file

@ -27,8 +27,8 @@ author: Quentin Stafford-Fraser (@quentinsf)
notes:
- >
You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you don't specify I(localhost) as
your host, you may want to add C(serial: 1) to the plays.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as
your host, you may want to add C(serial=1) to the plays.
- See `the webfaction API <https://docs.webfaction.com/xmlrpc-api/>`_ for more info.
extends_documentation_fragment:

4
plugins/modules/webfaction_db.py
View file

@ -24,8 +24,8 @@ author: Quentin Stafford-Fraser (@quentinsf)
notes:
- >
You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you don't specify I(localhost) as
your host, you may want to add C(serial: 1) to the plays.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as
your host, you may want to add C(serial=1) to the plays.
- See `the webfaction API <https://docs.webfaction.com/xmlrpc-api/>`_ for more info.
extends_documentation_fragment:
- community.general.attributes

8
plugins/modules/webfaction_domain.py
View file

@ -19,12 +19,12 @@ description:
- Add or remove domains or subdomains on a Webfaction host. Further documentation at https://github.com/quentinsf/ansible-webfaction.
author: Quentin Stafford-Fraser (@quentinsf)
notes:
- If you are I(deleting) domains by using I(state=absent), then note that if you specify subdomains, just those particular subdomains will be deleted.
If you don't specify subdomains, the domain will be deleted.
- If you are I(deleting) domains by using O(state=absent), then note that if you specify subdomains, just those particular subdomains will be deleted.
If you do not specify subdomains, the domain will be deleted.
- >
You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you don't specify I(localhost) as
your host, you may want to add C(serial: 1) to the plays.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as
your host, you may want to add C(serial=1) to the plays.
- See `the webfaction API <https://docs.webfaction.com/xmlrpc-api/>`_ for more info.
extends_documentation_fragment:

4
plugins/modules/webfaction_mailbox.py
View file

@ -21,8 +21,8 @@ author: Quentin Stafford-Fraser (@quentinsf)
notes:
- >
You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you don't specify I(localhost) as
your host, you may want to add C(serial: 1) to the plays.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as
your host, you may want to add C(serial=1) to the plays.
- See `the webfaction API <https://docs.webfaction.com/xmlrpc-api/>`_ for more info.
extends_documentation_fragment:

6
plugins/modules/webfaction_site.py
View file

@ -19,13 +19,13 @@ description:
- Add or remove a website on a Webfaction host. Further documentation at https://github.com/quentinsf/ansible-webfaction.
author: Quentin Stafford-Fraser (@quentinsf)
notes:
- Sadly, you I(do) need to know your webfaction hostname for the C(host) parameter. But at least, unlike the API, you don't need to know the IP
- Sadly, you I(do) need to know your webfaction hostname for the C(host) parameter. But at least, unlike the API, you do not need to know the IP
address. You can use a DNS name.
- If a site of the same name exists in the account but on a different host, the operation will exit.
- >
You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you don't specify I(localhost) as
your host, you may want to add C(serial: 1) to the plays.
The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you do not specify C(localhost) as
your host, you may want to add C(serial=1) to the plays.
- See `the webfaction API <https://docs.webfaction.com/xmlrpc-api/>`_ for more info.
extends_documentation_fragment:

18
plugins/modules/xattr.py
View file

@ -27,7 +27,7 @@ options:
path:
description:
- The full path of the file/object to get the facts of.
- Before 2.3 this option was only usable as I(name).
- Before 2.3 this option was only usable as O(name).
type: path
required: true
aliases: [ name ]
@ -42,27 +42,27 @@ options:
type: str
value:
description:
- The value to set the named name/key to, it automatically sets the I(state) to C(present).
- The value to set the named name/key to, it automatically sets the O(state) to V(present).
type: str
state:
description:
- defines which state you want to do.
C(read) retrieves the current value for a I(key) (default)
C(present) sets I(path) to C(value), default if value is set
C(all) dumps all data
C(keys) retrieves all keys
C(absent) deletes the key
V(read) retrieves the current value for a O(key) (default)
V(present) sets O(path) to O(value), default if value is set
V(all) dumps all data
V(keys) retrieves all keys
V(absent) deletes the key
type: str
choices: [ absent, all, keys, present, read ]
default: read
follow:
description:
- If C(true), dereferences symlinks and sets/gets attributes on symlink target,
- If V(true), dereferences symlinks and sets/gets attributes on symlink target,
otherwise acts on symlink itself.
type: bool
default: true
notes:
- As of Ansible 2.3, the I(name) option has been changed to I(path) as default, but I(name) still works as well.
- As of Ansible 2.3, the O(name) option has been changed to O(path) as default, but O(name) still works as well.
author:
- Brian Coca (@bcoca)
'''

48
plugins/modules/xenserver_guest.py
View file

@ -25,15 +25,15 @@ notes:
Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the XenAPI.py file from the SDK to your Python site-packages on your
Ansible Control Node to use it. Latest version of the library can also be acquired from GitHub:
U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py)'
- 'If no scheme is specified in I(hostname), module defaults to C(http://) because C(https://) is problematic in most setups. Make sure you are
- 'If no scheme is specified in O(hostname), module defaults to C(http://) because C(https://) is problematic in most setups. Make sure you are
accessing XenServer host in trusted environment or use C(https://) scheme explicitly.'
- 'To use C(https://) scheme for I(hostname) you have to either import host certificate to your OS certificate store or use I(validate_certs): C(false)
- 'To use C(https://) scheme for O(hostname) you have to either import host certificate to your OS certificate store or use O(validate_certs=false)
which requires XenAPI library from XenServer 7.2 SDK or newer and Python 2.7.9 or newer.'
- 'Network configuration inside a guest OS, by using I(networks.type), I(networks.ip), I(networks.gateway) etc. parameters, is supported on
- 'Network configuration inside a guest OS, by using O(networks[].type), O(networks[].ip), O(networks[].gateway) etc. parameters, is supported on
XenServer 7.0 or newer for Windows guests by using official XenServer Guest agent support for network configuration. The module will try to
detect if such support is available and utilize it, else it will use a custom method of configuration via xenstore. Since XenServer Guest
agent only support None and Static types of network configuration, where None means DHCP configured interface, I(networks.type) and I(networks.type6)
values C(none) and C(dhcp) have same effect. More info here:
agent only support None and Static types of network configuration, where None means DHCP configured interface, O(networks[].type) and O(networks[].type6)
values V(none) and V(dhcp) have same effect. More info here:
U(https://www.citrix.com/community/citrix-developer/citrix-hypervisor-developer/citrix-hypervisor-developing-products/citrix-hypervisor-staticip.html)'
- 'On platforms without official support for network configuration inside a guest OS, network parameters will be written to xenstore
C(vm-data/networks/<vif_device>) key. Parameters can be inspected by using C(xenstore ls) and C(xenstore read) tools on \*nix guests or trough
@ -55,10 +55,10 @@ options:
state:
description:
- Specify the state VM should be in.
- If I(state) is set to C(present) and VM exists, ensure the VM configuration conforms to given parameters.
- If I(state) is set to C(present) and VM does not exist, then VM is deployed with given parameters.
- If I(state) is set to C(absent) and VM exists, then VM is removed with its associated components.
- If I(state) is set to C(poweredon) and VM does not exist, then VM is deployed with given parameters and powered on automatically.
- If O(state) is set to V(present) and VM exists, ensure the VM configuration conforms to given parameters.
- If O(state) is set to V(present) and VM does not exist, then VM is deployed with given parameters.
- If O(state) is set to V(absent) and VM exists, then VM is removed with its associated components.
- If O(state) is set to V(poweredon) and VM does not exist, then VM is deployed with given parameters and powered on automatically.
type: str
default: present
choices: [ present, absent, poweredon ]
@ -66,7 +66,7 @@ options:
description:
- Name of the VM to work with.
- VMs running on XenServer do not necessarily have unique names. The module will fail if multiple VMs with same name are found.
- In case of multiple VMs with same name, use I(uuid) to uniquely specify VM to manage.
- In case of multiple VMs with same name, use O(uuid) to uniquely specify VM to manage.
- This parameter is case sensitive.
type: str
aliases: [ name_label ]
@ -84,7 +84,7 @@ options:
description:
- Name of a template, an existing VM (must be shut down) or a snapshot that should be used to create VM.
- Templates/VMs/snapshots on XenServer do not necessarily have unique names. The module will fail if multiple templates with same name are found.
- In case of multiple templates/VMs/snapshots with same name, use I(template_uuid) to uniquely specify source template.
- In case of multiple templates/VMs/snapshots with same name, use O(template_uuid) to uniquely specify source template.
- If VM already exists, this setting will be ignored.
- This parameter is case sensitive.
type: str
@ -117,7 +117,7 @@ options:
type: int
num_cpu_cores_per_socket:
description:
- Number of Cores Per Socket. I(num_cpus) has to be a multiple of I(num_cpu_cores_per_socket).
- Number of Cores Per Socket. O(hardware.num_cpus) has to be a multiple of O(hardware.num_cpu_cores_per_socket).
type: int
memory_mb:
description:
@ -128,7 +128,7 @@ options:
- A list of disks to add to VM.
- All parameters are case sensitive.
- Removing or detaching existing disks of VM is not supported.
- New disks are required to have either a I(size) or one of I(size_[tb,gb,mb,kb,b]) parameters specified.
- New disks are required to have either a O(disks[].size) or one of O(ignore:disks[].size_[tb,gb,mb,kb,b]) parameters specified.
- VM needs to be shut down to reconfigure disk size.
type: list
elements: dict
@ -184,13 +184,13 @@ options:
suboptions:
type:
description:
- The type of CD-ROM. With C(none) the CD-ROM device will be present but empty.
- The type of CD-ROM. With V(none) the CD-ROM device will be present but empty.
type: str
choices: [ none, iso ]
iso_name:
description:
- 'The file name of an ISO image from one of the XenServer ISO Libraries (implies I(type): C(iso)).'
- Required if I(type) is set to C(iso).
- 'The file name of an ISO image from one of the XenServer ISO Libraries (implies O(cdrom.type=iso)).'
- Required if O(cdrom.type) is set to V(iso).
type: str
networks:
description:
@ -212,17 +212,17 @@ options:
type: str
type:
description:
- Type of IPv4 assignment. Value C(none) means whatever is default for OS.
- Type of IPv4 assignment. Value V(none) means whatever is default for OS.
- On some operating systems it could be DHCP configured (e.g. Windows) or unconfigured interface (e.g. Linux).
type: str
choices: [ none, dhcp, static ]
ip:
description:
- 'Static IPv4 address (implies I(type): C(static)). Can include prefix in format C(<IPv4 address>/<prefix>) instead of using C(netmask).'
- 'Static IPv4 address (implies O(networks[].type=static)). Can include prefix in format C(<IPv4 address>/<prefix>) instead of using C(netmask).'
type: str
netmask:
description:
- Static IPv4 netmask required for I(ip) if prefix is not specified.
- Static IPv4 netmask required for O(networks[].ip) if prefix is not specified.
type: str
gateway:
description:
@ -230,12 +230,12 @@ options:
type: str
type6:
description:
- Type of IPv6 assignment. Value C(none) means whatever is default for OS.
- Type of IPv6 assignment. Value V(none) means whatever is default for OS.
type: str
choices: [ none, dhcp, static ]
ip6:
description:
- 'Static IPv6 address (implies I(type6): C(static)) with prefix in format C(<IPv6 address>/<prefix>).'
- 'Static IPv6 address (implies O(networks[].type6=static)) with prefix in format C(<IPv6 address>/<prefix>).'
type: str
gateway6:
description:
@ -250,7 +250,7 @@ options:
description:
- Define a list of custom VM params to set on VM.
- Useful for advanced users familiar with managing VM params trough xe CLI.
- A custom value object takes two fields I(key) and I(value) (see example below).
- A custom value object takes two fields O(custom_params[].key) and O(custom_params[].value) (see example below).
type: list
elements: dict
suboptions:
@ -266,13 +266,13 @@ options:
required: true
wait_for_ip_address:
description:
- Wait until XenServer detects an IP address for the VM. If I(state) is set to C(absent), this parameter is ignored.
- Wait until XenServer detects an IP address for the VM. If O(state) is set to V(absent), this parameter is ignored.
- This requires XenServer Tools to be preinstalled on the VM to work properly.
type: bool
default: false
state_change_timeout:
description:
- 'By default, module will wait indefinitely for VM to accquire an IP address if I(wait_for_ip_address): C(true).'
- 'By default, module will wait indefinitely for VM to accquire an IP address if O(wait_for_ip_address=true).'
- If this parameter is set to positive value, the module will instead wait specified number of seconds for the state change.
- In case of timeout, module will generate an error message.
type: int

23
plugins/modules/xfconf.py
View file

@ -58,15 +58,15 @@ options:
value_type:
description:
- The type of value being set.
- When providing more than one I(value_type), the length of the list must
be equal to the length of I(value).
- If only one I(value_type) is provided, but I(value) contains more than
on element, that I(value_type) will be applied to all elements of I(value).
- If the I(property) being set is an array and it can possibly have ony one
element in the array, then I(force_array=true) must be used to ensure
- When providing more than one O(value_type), the length of the list must
be equal to the length of O(value).
- If only one O(value_type) is provided, but O(value) contains more than
on element, that O(value_type) will be applied to all elements of O(value).
- If the O(property) being set is an array and it can possibly have ony one
element in the array, then O(force_array=true) must be used to ensure
that C(xfconf-query) will interpret the value as an array rather than a
scalar.
- Support for C(uchar), C(char), C(uint64), and C(int64) has been added in community.general 4.8.0.
- Support for V(uchar), V(char), V(uint64), and V(int64) has been added in community.general 4.8.0.
type: list
elements: str
choices: [ string, int, double, bool, uint, uchar, char, uint64, int64, float ]
@ -74,7 +74,7 @@ options:
type: str
description:
- The action to take upon the property/value.
- The state C(get) has been removed in community.general 5.0.0. Please use the module M(community.general.xfconf_info) instead.
- The state V(get) has been removed in community.general 5.0.0. Please use the module M(community.general.xfconf_info) instead.
choices: [ present, absent ]
default: "present"
force_array:
@ -86,7 +86,7 @@ options:
version_added: 1.0.0
disable_facts:
description:
- The value C(false) is no longer allowed since community.general 4.0.0.
- The value V(false) is no longer allowed since community.general 4.0.0.
- This option is deprecated, and will be removed in community.general 8.0.0.
type: bool
default: true
@ -130,9 +130,8 @@ RETURN = '''
sample: "/Xft/DPI"
value_type:
description:
- The type of the value that was changed (C(none) for C(reset)
state). Either a single string value or a list of strings for array
types.
- The type of the value that was changed (V(none) for O(state=reset)).
Either a single string value or a list of strings for array types.
- This is a string or a list of strings.
returned: success
type: any

6
plugins/modules/xfconf_info.py
View file

@ -36,8 +36,8 @@ options:
- >
A Xfce preference key is an element in the Xfconf repository
that corresponds to an application preference.
- If provided, then I(channel) is required.
- If not provided and a I(channel) is provided, then the module will list all available properties in that I(channel).
- If provided, then O(channel) is required.
- If not provided and a O(channel) is provided, then the module will list all available properties in that O(channel).
type: str
notes:
- See man xfconf-query(1) for more details.
@ -82,7 +82,7 @@ RETURN = '''
properties:
description:
- List of available properties for a specific channel.
- Returned by passing only the I(channel) parameter to the module.
- Returned by passing only the O(channel) parameter to the module.
returned: success
type: list
elements: str

54
plugins/modules/xml.py
View file

@ -29,18 +29,18 @@ options:
description:
- Path to the file to operate on.
- This file must exist ahead of time.
- This parameter is required, unless I(xmlstring) is given.
- This parameter is required, unless O(xmlstring) is given.
type: path
aliases: [ dest, file ]
xmlstring:
description:
- A string containing XML on which to operate.
- This parameter is required, unless I(path) is given.
- This parameter is required, unless O(path) is given.
type: str
xpath:
description:
- A valid XPath expression describing the item(s) you want to manipulate.
- Operates on the document root, C(/), by default.
- Operates on the document root, V(/), by default.
type: str
namespaces:
description:
@ -57,43 +57,43 @@ options:
aliases: [ ensure ]
attribute:
description:
- The attribute to select when using parameter I(value).
- This is a string, not prepended with C(@).
- The attribute to select when using parameter O(value).
- This is a string, not prepended with V(@).
type: raw
value:
description:
- Desired state of the selected attribute.
- Either a string, or to unset a value, the Python C(None) keyword (YAML Equivalent, C(null)).
- Either a string, or to unset a value, the Python C(None) keyword (YAML Equivalent, V(null)).
- Elements default to no value (but present).
- Attributes default to an empty string.
type: raw
add_children:
description:
- Add additional child-element(s) to a selected element for a given I(xpath).
- Add additional child-element(s) to a selected element for a given O(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),
(for example 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 I(xpath) to be set.
- This parameter requires O(xpath) to be set.
type: list
elements: raw
set_children:
description:
- Set the child-element(s) of a selected element for a given I(xpath).
- Set the child-element(s) of a selected element for a given O(xpath).
- Removes any existing children.
- Child elements must be specified as in I(add_children).
- This parameter requires I(xpath) to be set.
- Child elements must be specified as in O(add_children).
- This parameter requires O(xpath) to be set.
type: list
elements: raw
count:
description:
- Search for a given I(xpath) and provide the count of any matches.
- This parameter requires I(xpath) to be set.
- Search for a given O(xpath) and provide the count of any matches.
- This parameter requires O(xpath) to be set.
type: bool
default: false
print_match:
description:
- Search for a given I(xpath) and print out any matches.
- This parameter requires I(xpath) to be set.
- Search for a given O(xpath) and print out any matches.
- This parameter requires O(xpath) to be set.
type: bool
default: false
pretty_print:
@ -103,13 +103,13 @@ options:
default: false
content:
description:
- Search for a given I(xpath) and get content.
- This parameter requires I(xpath) to be set.
- Search for a given O(xpath) and get content.
- This parameter requires O(xpath) to be set.
type: str
choices: [ attribute, text ]
input_type:
description:
- Type of input for I(add_children) and I(set_children).
- Type of input for O(add_children) and O(set_children).
type: str
choices: [ xml, yaml ]
default: yaml
@ -127,20 +127,20 @@ options:
default: false
insertbefore:
description:
- Add additional child-element(s) before the first selected element for a given I(xpath).
- Add additional child-element(s) before the first selected element for a given O(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),
(for example 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 I(xpath) to be set.
- This parameter requires O(xpath) to be set.
type: bool
default: false
insertafter:
description:
- Add additional child-element(s) after the last selected element for a given I(xpath).
- Add additional child-element(s) after the last selected element for a given O(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),
(for example 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 I(xpath) to be set.
- This parameter requires O(xpath) to be set.
type: bool
default: false
requirements:
@ -149,7 +149,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 I(namespaces) parameter, see the examples.
- Beware that in case your XML elements are namespaced, you need to use the O(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
@ -338,7 +338,7 @@ actions:
backup_file:
description: The name of the backup file that was created
type: str
returned: when I(backup=true)
returned: when O(backup=true)
sample: /path/to/file.xml.1942.2017-08-24@14:16:01~
count:
description: The count of xpath matches.

18
plugins/modules/zfs_delegate_admin.py
View file

@ -15,7 +15,7 @@ short_description: Manage ZFS delegated administration (user admin privileges)
description:
- Manages ZFS file system delegated administration permissions, which allow unprivileged users to perform ZFS
operations normally restricted to the superuser.
- See the C(zfs allow) section of C(zfs(1M)) for detailed explanations of options.
- See the C(zfs allow) section of V(zfs(1M\)) for detailed explanations of options.
- This module attempts to adhere to the behavior of the command line tool as much as possible.
requirements:
- "A ZFS/OpenZFS implementation that supports delegation with C(zfs allow), including: Solaris >= 10, illumos (all
@ -30,14 +30,14 @@ attributes:
options:
name:
description:
- File system or volume name e.g. C(rpool/myfs).
- File system or volume name, for example V(rpool/myfs).
required: true
type: str
state:
description:
- Whether to allow (C(present)), or unallow (C(absent)) a permission.
- When set to C(present), at least one "entity" param of I(users), I(groups), or I(everyone) are required.
- When set to C(absent), removes permissions from the specified entities, or removes all permissions if no entity params are specified.
- Whether to allow (V(present)), or unallow (V(absent)) a permission.
- When set to V(present), at least one "entity" param of O(users), O(groups), or O(everyone) are required.
- When set to V(absent), removes permissions from the specified entities, or removes all permissions if no entity params are specified.
choices: [ absent, present ]
default: present
type: str
@ -58,22 +58,22 @@ options:
default: false
permissions:
description:
- The list of permission(s) to delegate (required if C(state) is C(present)).
- The list of permission(s) to delegate (required if O(state=present)).
- Supported permissions depend on the ZFS version in use. See for example
U(https://openzfs.github.io/openzfs-docs/man/8/zfs-allow.8.html) for OpenZFS.
type: list
elements: str
local:
description:
- Apply permissions to C(name) locally (C(zfs allow -l)).
- Apply permissions to O(name) locally (C(zfs allow -l)).
type: bool
descendents:
description:
- Apply permissions to C(name)'s descendents (C(zfs allow -d)).
- Apply permissions to O(name)'s descendents (C(zfs allow -d)).
type: bool
recursive:
description:
- Unallow permissions recursively (ignored when C(state) is C(present)).
- Unallow permissions recursively (ignored when O(state=present)).
type: bool
default: false
author:

6
plugins/modules/znode.py
View file

@ -66,9 +66,9 @@ options:
version_added: 5.8.0
auth_credential:
description:
- The authentication credential value. Depends on I(auth_scheme).
- The format for I(auth_scheme=digest) is C(user:password),
and the format for I(auth_scheme=sasl) is C(user:password).
- The authentication credential value. Depends on O(auth_scheme).
- The format for O(auth_scheme=digest) is C(user:password),
and the format for O(auth_scheme=sasl) is C(user:password).
type: str
required: false
version_added: 5.8.0

24
plugins/modules/zypper.py
View file

@ -42,22 +42,22 @@ attributes:
options:
name:
description:
- Package name C(name) or package specifier or a list of either.
- Can include a version like C(name=1.0), C(name>3.4) or C(name<=2.7). If a version is given, C(oldpackage) is implied and zypper is allowed to
- Package name V(name) or package specifier or a list of either.
- Can include a version like V(name=1.0), V(name>3.4) or V(name<=2.7). If a version is given, V(oldpackage) is implied and zypper is allowed to
update the package within the version range given.
- You can also pass a url or a local path to a rpm file.
- When using I(state=latest), this can be '*', which updates all installed packages.
- When using O(state=latest), this can be '*', which updates all installed packages.
required: true
aliases: [ 'pkg' ]
type: list
elements: str
state:
description:
- C(present) will make sure the package is installed.
C(latest) will make sure the latest version of the package is installed.
C(absent) will make sure the specified package is not installed.
C(dist-upgrade) will make sure the latest version of all installed packages from all enabled repositories is installed.
- When using C(dist-upgrade), I(name) should be C('*').
- V(present) will make sure the package is installed.
V(latest) will make sure the latest version of the package is installed.
V(absent) will make sure the specified package is not installed.
V(dist-upgrade) will make sure the latest version of all installed packages from all enabled repositories is installed.
- When using V(dist-upgrade), O(name) should be V('*').
required: false
choices: [ present, latest, absent, dist-upgrade, installed, removed ]
default: "present"
@ -78,14 +78,14 @@ options:
disable_gpg_check:
description:
- Whether to disable to GPG signature checking of the package
signature being installed. Has an effect only if state is
I(present) or I(latest).
signature being installed. Has an effect only if O(state) is
V(present) or V(latest).
required: false
default: false
type: bool
disable_recommends:
description:
- Corresponds to the C(--no-recommends) option for I(zypper). Default behavior (C(true)) modifies zypper's default behavior; C(false) does
- Corresponds to the C(--no-recommends) option for I(zypper). Default behavior (V(true)) modifies zypper's default behavior; V(false) does
install recommended packages.
required: false
default: true
@ -146,7 +146,7 @@ options:
version_added: '4.6.0'
notes:
- When used with a C(loop:) each package will be processed individually,
it is much more efficient to pass the list directly to the I(name) option.
it is much more efficient to pass the list directly to the O(name) option.
# informational: requirements for nodes
requirements:
- "zypper >= 1.0 # included in openSUSE >= 11.1 or SUSE Linux Enterprise Server/Desktop >= 11.0"

5
plugins/modules/zypper_repository.py
View file

@ -47,8 +47,7 @@ options:
disable_gpg_check:
description:
- Whether to disable GPG signature checking of
all packages. Has an effect only if state is
I(present).
all packages. Has an effect only if O(state=present).
- Needs zypper version >= 1.6.2.
type: bool
default: false
@ -73,7 +72,7 @@ options:
auto_import_keys:
description:
- Automatically import the gpg signing key of the new or changed repository.
- Has an effect only if state is I(present). Has no effect on existing (unchanged) repositories or in combination with I(absent).
- Has an effect only if O(state=present). Has no effect on existing (unchanged) repositories or in combination with O(state=absent).
- Implies runrefresh.
- Only works with C(.repo) files if `name` is given explicitly.
type: bool