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

Fix M(). (#591)

Browse source 
* Fix M().

* Break long line.

* Fix the remaining M(...).

* Break long line.
This commit is contained in:
Felix Fontein 2020-06-29 14:59:15 +02:00 committed by GitHub
parent e3d36a3408
commit 097aebadb0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
126 changed files with 155 additions and 198 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
plugins/callback/say.py
View file

@ -16,7 +16,7 @@ DOCUMENTATION = '''
description:
- This plugin will use the 'say' or 'espeak' program to "speak" about play events.
notes:
- In 2.8, this callback has been renamed from C(osx_say) into M(say).
- In 2.8, this callback has been renamed from C(osx_say) into M(community.general.say).
'''
import distutils.spawn

2
plugins/doc_fragments/docker.py
View file

@ -101,7 +101,7 @@ notes:
with the product that sets up the environment. It will set these variables for you. See
U(https://docs.docker.com/machine/reference/env/) for more details.
- When connecting to Docker daemon with TLS, you might need to install additional Python packages.
For the Docker SDK for Python, version 2.4 or newer, this can be done by installing C(docker[tls]) with M(pip).
For the Docker SDK for Python, version 2.4 or newer, this can be done by installing C(docker[tls]) with M(ansible.builtin.pip).
- Note that the Docker SDK for Python only allows to specify the path to the Docker configuration for very few functions.
In general, it will use C($HOME/.docker/config.json) if the C(DOCKER_CONFIG) environment variable is not specified,
and use C($DOCKER_CONFIG/config.json) otherwise.

6
plugins/doc_fragments/mysql.py
View file

@ -67,9 +67,9 @@ requirements:
- MySQLdb (Python 2.x)
notes:
- Requires the PyMySQL (Python 2.7 and Python 3.X) or MySQL-python (Python 2.X) package on the remote host.
The Python package may be installed with apt-get install python-pymysql (Ubuntu; see M(apt)) or
yum install python2-PyMySQL (RHEL/CentOS/Fedora; see M(yum)). You can also use dnf install python2-PyMySQL
for newer versions of Fedora; see M(dnf).
The Python package may be installed with apt-get install python-pymysql (Ubuntu; see M(ansible.builtin.apt)) or
yum install python2-PyMySQL (RHEL/CentOS/Fedora; see M(ansible.builtin.yum)). You can also use dnf install python2-PyMySQL
for newer versions of Fedora; see M(ansible.builtin.dnf).
- Both C(login_password) and C(login_user) are required when you are
passing credentials. If none are present, the module will attempt to read
the credentials from C(~/.my.cnf), and finally fall back to using the MySQL

2
plugins/lookup/etcd3.py
View file

@ -14,7 +14,7 @@ DOCUMENTATION = '''
short_description: Get key values from etcd3 server
description:
- Retrieves key values and/or key prefixes from etcd3 server using its native gRPC API.
- Try to reuse M(etcd3) options for connection parameters, but add support for some C(ETCDCTL_*) environment variables.
- Try to reuse M(community.general.etcd3) options for connection parameters, but add support for some C(ETCDCTL_*) environment variables.
- See U(https://github.com/etcd-io/etcd/tree/master/Documentation/op-guide) for etcd overview.
options:

2
plugins/modules/cloud/digital_ocean/digital_ocean.py
View file

@ -15,7 +15,7 @@ short_description: Create/delete a droplet/SSH_key in DigitalOcean
deprecated:
removed_in: 2.0.0 # was Ansible 2.12
why: Updated module to remove external dependency with increased functionality.
alternative: Use M(digital_ocean_droplet) instead.
alternative: Use M(community.general.digital_ocean_droplet) instead.
description:
- Create/delete a droplet in DigitalOcean and optionally wait for it to be 'running', or deploy an SSH key.
author: "Vincent Viallet (@zbal)"

2
plugins/modules/cloud/digital_ocean/digital_ocean_sshkey_facts.py
View file

@ -15,7 +15,7 @@ module: digital_ocean_sshkey_facts
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: Deprecated in favour of C(_info) module.
alternative: Use M(digital_ocean_sshkey_info) instead.
alternative: Use M(community.general.digital_ocean_sshkey_info) instead.
short_description: DigitalOcean SSH keys facts
description:
- Fetch DigitalOcean SSH keys facts.

2
plugins/modules/cloud/digital_ocean/digital_ocean_volume_info.py
View file

@ -20,7 +20,7 @@ options:
region_name:
description:
- Name of region to restrict results to volumes available in a specific region.
- Please use M(digital_ocean_region_info) for getting valid values related regions.
- Please use M(community.general.digital_ocean_region_info) for getting valid values related regions.
required: false
requirements:

2
plugins/modules/cloud/docker/docker_container.py
View file

@ -522,7 +522,7 @@ options:
- List of networks the container belongs to.
- For examples of the data structure and usage see EXAMPLES below.
- To remove a container from one or more networks, use the I(purge_networks) option.
- Note that as opposed to C(docker run ...), M(docker_container) does not remove the default
- Note that as opposed to C(docker run ...), M(community.general.docker_container) does not remove the default
network if I(networks) is specified. You need to explicitly use I(purge_networks) to enforce
the removal of the default network (and all other networks not explicitly mentioned in I(networks)).
Alternatively, use the I(networks_cli_compatible) option, which will be enabled by default from community.general 2.0.0 on.

2
plugins/modules/cloud/docker/docker_container_info.py
View file

@ -15,7 +15,7 @@ short_description: Retrieves facts about docker container
description:
- Retrieves facts about a docker container.
- Essentially returns the output of C(docker inspect <name>), similar to what M(docker_container)
- Essentially returns the output of C(docker inspect <name>), similar to what M(community.general.docker_container)
returns for a non-absent container.

2
plugins/modules/cloud/docker/docker_image_info.py
View file

@ -19,7 +19,7 @@ description:
- If an image does not exist locally, it will not appear in the results. If you want to check whether an image exists
locally, you can call the module with the image name, then check whether the result list is empty (image does not
exist) or has one element (the image exists locally).
- The module will not attempt to pull images from registries. Use M(docker_image) with I(source) set to C(pull)
- The module will not attempt to pull images from registries. Use M(community.general.docker_image) with I(source) set to C(pull)
to ensure an image is pulled.
notes:

4
plugins/modules/cloud/docker/docker_network.py
View file

@ -27,7 +27,7 @@ options:
- List of container names or container IDs to connect to a network.
- Please note that the module only makes sure that these containers are connected to the network,
but does not care about connection options. If you rely on specific IP addresses etc., use the
M(docker_container) module to ensure your containers are correctly connected to this network.
M(community.general.docker_container) module to ensure your containers are correctly connected to this network.
type: list
elements: str
aliases:
@ -180,7 +180,7 @@ notes:
- When network options are changed, the module disconnects all containers from the network, deletes the network, and re-creates the network.
It does not try to reconnect containers, except the ones listed in (I(connected), and even for these, it does not consider specific
connection options like fixed IP addresses or MAC addresses. If you need more control over how the containers are connected to the
network, loop the M(docker_container) module to loop over your containers to make sure they are connected properly.
network, loop the M(community.general.docker_container) module to loop over your containers to make sure they are connected properly.
- The module does not support Docker Swarm, i.e. it will not try to disconnect or reconnect services. If services are connected to the
network, deleting the network will fail. When network options are changed, the network has to be deleted and recreated, so this will
fail as well.

2
plugins/modules/cloud/docker/docker_network_info.py
View file

@ -15,7 +15,7 @@ short_description: Retrieves facts about docker network
description:
- Retrieves facts about a docker network.
- Essentially returns the output of C(docker network inspect <name>), similar to what M(docker_network)
- Essentially returns the output of C(docker network inspect <name>), similar to what M(community.general.docker_network)
returns for a non-absent network.

2
plugins/modules/cloud/docker/docker_node.py
View file

@ -26,7 +26,7 @@ options:
description:
- User-defined key/value metadata that will be assigned as node attribute.
- Label operations in this module apply to the docker swarm node specified by I(hostname).
Use M(docker_swarm) module to add/modify/remove swarm cluster labels.
Use M(community.general.docker_swarm) module to add/modify/remove swarm cluster labels.
- The actual state of labels assigned to the node when module completes its work depends on
I(labels_state) and I(labels_to_remove) parameters values. See description below.
type: dict

4
plugins/modules/cloud/docker/docker_swarm.py
View file

@ -139,7 +139,7 @@ options:
description:
- User-defined key/value metadata.
- Label operations in this module apply to the docker swarm cluster.
Use M(docker_node) module to add/modify/remove swarm node labels.
Use M(community.general.docker_node) module to add/modify/remove swarm node labels.
- Requires API version >= 1.32.
type: dict
signing_ca_cert:
@ -165,7 +165,7 @@ options:
description:
- If set, generate a key and use it to lock data stored on the managers.
- Docker default value is C(no).
- M(docker_swarm_info) can be used to retrieve the unlock key.
- M(community.general.docker_swarm_info) can be used to retrieve the unlock key.
type: bool
rotate_worker_token:
description: Rotate the worker join token.

4
plugins/modules/cloud/google/gcdns_record.py
View file

@ -25,7 +25,7 @@ requirements:
deprecated:
removed_in: 2.0.0 # was Ansible 2.12
why: Updated modules released with increased functionality
alternative: Use M(gcp_dns_resource_record_set) instead.
alternative: Use M(google.cloud.gcp_dns_resource_record_set) instead.
options:
state:
description:
@ -116,7 +116,7 @@ options:
description:
- The Google Cloud Platform project ID to use.
notes:
- See also M(gcdns_zone).
- See also M(community.general.gcdns_zone).
- This modules's underlying library does not support in-place updates for
DNS resource records. Instead, resource records are quickly deleted and
recreated.

4
plugins/modules/cloud/google/gcdns_zone.py
View file

@ -24,7 +24,7 @@ requirements:
deprecated:
removed_in: 2.0.0 # was Ansible 2.12
why: Updated modules released with increased functionality
alternative: Use M(gcp_dns_managed_zone) instead.
alternative: Use M(google.cloud.gcp_dns_managed_zone) instead.
options:
state:
description:
@ -61,7 +61,7 @@ options:
description:
- The Google Cloud Platform project ID to use.
notes:
- See also M(gcdns_record).
- See also M(community.general.gcdns_record).
- Zones that are newly created must still be set up with a domain registrar
before they can be used.
'''

2
plugins/modules/cloud/google/gce.py
View file

@ -18,7 +18,7 @@ description:
deprecated:
removed_in: 2.0.0 # was Ansible 2.12
why: Updated modules released with increased functionality
alternative: Use M(gcp_compute_instance) instead.
alternative: Use M(google.cloud.gcp_compute_instance) instead.
options:
image:
description:

2
plugins/modules/cloud/google/gcp_target_proxy.py
View file

@ -23,7 +23,7 @@ requirements:
deprecated:
removed_in: 2.0.0 # was Ansible 2.12
why: Updated modules released with increased functionality
alternative: Use M(gcp_compute_target_http_proxy) instead.
alternative: Use M(google.cloud.gcp_compute_target_http_proxy) instead.
notes:
- Currently only supports global HTTP proxy.
author:

2
plugins/modules/cloud/google/gcp_url_map.py
View file

@ -28,7 +28,7 @@ author:
deprecated:
removed_in: 2.0.0 # was Ansible 2.12
why: Updated modules released with increased functionality
alternative: Use M(gcp_compute_url_map) instead.
alternative: Use M(google.cloud.gcp_compute_url_map) instead.
options:
url_map_name:
description:

2
plugins/modules/cloud/google/gcspanner.py
View file

@ -23,7 +23,7 @@ notes:
deprecated:
removed_in: 2.0.0 # was Ansible 2.12
why: Updated modules released with increased functionality
alternative: Use M(gcp_spanner_database) and/or M(gcp_spanner_instance) instead.
alternative: Use M(google.cloud.gcp_spanner_database) and/or M(google.cloud.gcp_spanner_instance) instead.
author:
- Tom Melendez (@supertom) <tom@supertom.com>
options:

2
plugins/modules/cloud/kubevirt/kubevirt_pvc.py
View file

@ -115,7 +115,7 @@ options:
- "If data is to be copied onto the PVC using the Containerized Data Importer you can specify the source of
the data (along with any additional configuration) as well as it's format."
- "Valid source types are: blank, http, s3, registry, pvc and upload. The last one requires using the
M(kubevirt_cdi_upload) module to actually perform an upload."
M(community.general.kubevirt_cdi_upload) module to actually perform an upload."
- "Source data format is specified using the optional I(content_type). Valid options are C(kubevirt)
(default; raw image) and C(archive) (tar.gz)."
- "This uses the DataVolume source syntax:

2
plugins/modules/cloud/kubevirt/kubevirt_template.py
View file

@ -38,7 +38,7 @@ options:
The definition of these objects can reference parameters defined earlier.
- As part of the list user can pass also I(VirtualMachine) kind. When passing I(VirtualMachine)
user must use Ansible structure of the parameters not the Kubernetes API structure. For more information
please take a look at M(kubevirt_vm) module and at EXAMPLES section, where you can see example.
please take a look at M(community.general.kubevirt_vm) module and at EXAMPLES section, where you can see example.
type: list
merge_type:
description:

2
plugins/modules/cloud/lxd/lxd_container.py
View file

@ -136,7 +136,7 @@ notes:
2.1, the later requires python to be installed in the container which can
be done with the command module.
- You can copy a file from the host to the container
with the Ansible M(copy) and M(template) module and the `lxd` connection plugin.
with the Ansible M(ansible.builtin.copy) and M(ansible.builtin.template) module and the `lxd` connection plugin.
See the example below.
- You can copy a file in the created container to the localhost
with `command=lxc file pull container_name/dir/filename filename`.

2
plugins/modules/cloud/misc/helm.py
View file

@ -12,7 +12,7 @@ DOCUMENTATION = '''
deprecated:
removed_in: 3.0.0 # was Ansible 2.14
why: For more details https://github.com/ansible/ansible/issues/61546.
alternative: Use M(helm) in the community.kubernetes collection instead.
alternative: Use M(community.kubernetes.helm) instead.
module: helm
short_description: Manages Kubernetes packages with the Helm package manager
author: "Flavio Percoco (@flaper87)"

2
plugins/modules/cloud/misc/ovirt.py
View file

@ -17,7 +17,7 @@ deprecated:
why: This module is for deprecated version of ovirt.
alternative: Use C(ovirt_vm) from the C(ovirt.ovirt) collection instead
description:
- This module only supports oVirt/RHEV version 3. A newer module M(ovirt_vm) supports oVirt/RHV version 4.
- This module only supports oVirt/RHEV version 3. A newer module M(ovirt.ovirt.ovirt_vm) supports oVirt/RHV version 4.
- Allows you to create new instances, either from scratch or an image, in addition to deleting or stopping instances on the oVirt/RHEV platform.
options:
user:

2
plugins/modules/cloud/misc/rhevm.py
View file

@ -13,7 +13,7 @@ module: rhevm
short_description: RHEV/oVirt automation
description:
- This module only supports oVirt/RHEV version 3.
- A newer module M(ovirt_vm) supports oVirt/RHV version 4.
- A newer module M(ovirt.ovirt.ovirt_vm) supports oVirt/RHV version 4.
- Allows you to create/remove/update or powermanage virtual machines on a RHEV/oVirt platform.
requirements:
- ovirtsdk

2
plugins/modules/cloud/online/online_server_facts.py
View file

@ -13,7 +13,7 @@ module: online_server_facts
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: Deprecated in favour of C(_info) module.
alternative: Use M(online_server_info) instead.
alternative: Use M(community.general.online_server_info) instead.
short_description: Gather facts about Online servers.
description:
- Gather facts about the servers.

2
plugins/modules/cloud/online/online_user_facts.py
View file

@ -12,7 +12,7 @@ module: online_user_facts
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: Deprecated in favour of C(_info) module.
alternative: Use M(online_user_info) instead.
alternative: Use M(community.general.online_user_info) instead.
short_description: Gather facts about Online user.
description:
- Gather facts about the user.

4
plugins/modules/cloud/ovirt/ovirt_affinity_label_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_affinity_label_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_affinity_label_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV affinity labels."
- This module was called C(ovirt_affinity_label_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_affinity_label_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_affinity_labels), which
contains a list of affinity labels. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_api_facts.py
View file

@ -15,11 +15,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_api_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_api_info) instead.
description:
- "Retrieve information about the oVirt/RHV API."
- This module was called C(ovirt_api_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_api_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_api),
which contains a information about oVirt/RHV API. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_cluster_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_cluster_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_cluster_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV clusters."
- This module was called C(ovirt_cluster_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_cluster_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_clusters), which
contains a list of clusters. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_datacenter_facts.py
View file

@ -15,11 +15,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_datacenter_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_datacenter_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV datacenters."
- This module was called C(ovirt_datacenter_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_datacenter_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_datacenters), which
contains a list of datacenters. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_disk_facts.py
View file

@ -30,11 +30,9 @@ author: "Katerina Koukiou (@KKoukiou)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_disk_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_disk_info) instead
description:
- "Retrieve information about one or more oVirt/RHV disks."
- This module was called C(ovirt_disk_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_disk_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_disks), which
contains a list of disks. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_event_facts.py
View file

@ -14,11 +14,9 @@ author: "Chris Keller (@nasx)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_event_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_event_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV events."
- This module was called C(ovirt_event_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_event_info) module no longer returns C(ansible_facts)!
options:
case_sensitive:
description:

4
plugins/modules/cloud/ovirt/ovirt_external_provider_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_external_provider_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_external_provider_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV external providers."
- This module was called C(ovirt_external_provider_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_external_provider_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_external_providers), which
contains a list of external_providers. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_group_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_group_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_group_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV groups."
- This module was called C(ovirt_group_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_group_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_groups), which
contains a list of groups. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_host_facts.py
View file

@ -15,11 +15,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_host_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_host_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV hosts."
- This module was called C(ovirt_host_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_host_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_hosts), which
contains a list of hosts. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_host_storage_facts.py
View file

@ -15,11 +15,9 @@ author: "Daniel Erez (@derez)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_host_storage_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_host_storage_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV HostStorages (applicable only for block storage)."
- This module was called C(ovirt_host_storage_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_host_storage_info) module no longer returns C(ansible_facts)!
options:
host:
description:

4
plugins/modules/cloud/ovirt/ovirt_network_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_network_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_network_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV networks."
- This module was called C(ovirt_network_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_network_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_networks), which
contains a list of networks. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_nic_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_nic_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_nic_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV virtual machine network interfaces."
- This module was called C(ovirt_nic_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_nic_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_nics), which
contains a list of NICs. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_permission_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_permission_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_permission_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV permissions."
- This module was called C(ovirt_permission_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_permission_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_permissions), which
contains a list of permissions. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_quota_facts.py
View file

@ -30,11 +30,9 @@ author: "Maor Lipchuk (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_quota_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_quota_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV quotas."
- This module was called C(ovirt_quota_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_quota_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_quotas), which
contains a list of quotas. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_scheduling_policy_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_scheduling_policy_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_scheduling_policy_info) instead.
description:
- "Retrieve information about one or more oVirt scheduling policies."
- This module was called C(ovirt_scheduling_policy_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_scheduling_policy_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_scheduling_policies),
which contains a list of scheduling policies. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_snapshot_facts.py
View file

@ -15,11 +15,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_snapshot_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_snapshot_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV virtual machine snapshots."
- This module was called C(ovirt_snapshot_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_snapshot_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_snapshots), which
contains a list of snapshots. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_storage_domain_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_storage_domain_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_storage_domain_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV storage domains."
- This module was called C(ovirt_storage_domain_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_storage_domain_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_storage_domains), which
contains a list of storage domains. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_storage_template_facts.py
View file

@ -30,11 +30,9 @@ author: "Maor Lipchuk (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_storage_template_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_storage_template_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV templates relate to a storage domain."
- This module was called C(ovirt_storage_template_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_storage_template_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_storage_templates), which
contains a list of templates. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_storage_vm_facts.py
View file

@ -30,11 +30,9 @@ author: "Maor Lipchuk (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_storage_vm_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_storage_vm_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV virtual machines relate to a storage domain."
- This module was called C(ovirt_storage_vm_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_storage_vm_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_storage_vms), which
contains a list of virtual machines. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_tag_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_tag_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_tag_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV tags."
- This module was called C(ovirt_tag_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_tag_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_tags), which
contains a list of tags. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_template_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_template_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_template_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV templates."
- This module was called C(ovirt_template_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_template_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_templates), which
contains a list of templates. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_user_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_user_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_user_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV users."
- This module was called C(ovirt_user_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_user_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_users), which
contains a list of users. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_vm_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_vm_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_vm_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV virtual machines."
- This module was called C(ovirt_vm_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_vm_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_vms), which
contains a list of virtual machines. You need to register the result with

4
plugins/modules/cloud/ovirt/ovirt_vmpool_facts.py
View file

@ -30,11 +30,9 @@ author: "Ondra Machacek (@machacekondra)"
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: When migrating to collection we decided to use only _info modules.
alternative: Use C(ovirt_vmpool_info) from the C(ovirt.ovirt) collection instead
alternative: Use M(ovirt.ovirt.ovirt_vmpool_info) instead.
description:
- "Retrieve information about one or more oVirt/RHV vmpools."
- This module was called C(ovirt_vmpool_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(ovirt_vmpool_info) module no longer returns C(ansible_facts)!
notes:
- "This module returns a variable C(ovirt_vmpools), which
contains a list of vmpools. You need to register the result with

2
plugins/modules/cloud/scaleway/scaleway_image_facts.py
View file

@ -13,7 +13,7 @@ module: scaleway_image_facts
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: Deprecated in favour of C(_info) module.
alternative: Use M(scaleway_image_info) instead.
alternative: Use M(community.general.scaleway_image_info) instead.
short_description: Gather facts about the Scaleway images available.
description:
- Gather facts about the Scaleway images available.

2
plugins/modules/cloud/scaleway/scaleway_ip_facts.py
View file

@ -13,7 +13,7 @@ module: scaleway_ip_facts
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: Deprecated in favour of C(_info) module.
alternative: Use M(scaleway_ip_info) instead.
alternative: Use M(community.general.scaleway_ip_info) instead.
short_description: Gather facts about the Scaleway ips available.
description:
- Gather facts about the Scaleway ips available.

2
plugins/modules/cloud/scaleway/scaleway_organization_facts.py
View file

@ -13,7 +13,7 @@ module: scaleway_organization_facts
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: Deprecated in favour of C(_info) module.
alternative: Use M(scaleway_organization_info) instead.
alternative: Use M(community.general.scaleway_organization_info) instead.
short_description: Gather facts about the Scaleway organizations available.
description:
- Gather facts about the Scaleway organizations available.

2
plugins/modules/cloud/scaleway/scaleway_security_group_facts.py
View file

@ -13,7 +13,7 @@ module: scaleway_security_group_facts
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: Deprecated in favour of C(_info) module.
alternative: Use M(scaleway_security_group_info) instead.
alternative: Use M(community.general.scaleway_security_group_info) instead.
short_description: Gather facts about the Scaleway security groups available.
description:
- Gather facts about the Scaleway security groups available.

2
plugins/modules/cloud/scaleway/scaleway_server_facts.py
View file

@ -13,7 +13,7 @@ module: scaleway_server_facts
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: Deprecated in favour of C(_info) module.
alternative: Use M(scaleway_server_info) instead.
alternative: Use M(community.general.scaleway_server_info) instead.
short_description: Gather facts about the Scaleway servers available.
description:
- Gather facts about the Scaleway servers available.

2
plugins/modules/cloud/scaleway/scaleway_snapshot_facts.py
View file

@ -13,7 +13,7 @@ module: scaleway_snapshot_facts
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: Deprecated in favour of C(_info) module.
alternative: Use M(scaleway_snapshot_info) instead.
alternative: Use M(community.general.scaleway_snapshot_info) instead.
short_description: Gather facts about the Scaleway snapshots available.
description:
- Gather facts about the Scaleway snapshot available.

2
plugins/modules/cloud/scaleway/scaleway_volume_facts.py
View file

@ -13,7 +13,7 @@ module: scaleway_volume_facts
deprecated:
removed_in: 3.0.0 # was Ansible 2.13
why: Deprecated in favour of C(_info) module.
alternative: Use M(scaleway_volume_info) instead.
alternative: Use M(community.general.scaleway_volume_info) instead.
short_description: Gather facts about the Scaleway volumes available.
description:
- Gather facts about the Scaleway volumes available.

2
plugins/modules/cloud/smartos/smartos_image_info.py
View file

@ -15,7 +15,7 @@ short_description: Get SmartOS image details.
description:
- Retrieve information about all installed images on SmartOS.
- This module was called C(smartos_image_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(smartos_image_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.smartos_image_info) module no longer returns C(ansible_facts)!
author: Adam Števko (@xen0l)
options:
filters:

2
plugins/modules/database/mssql/mssql_db.py
View file

@ -51,7 +51,7 @@ options:
default: 'no'
notes:
- Requires the pymssql Python package on the remote host. For Ubuntu, this
is as easy as pip install pymssql (See M(pip).)
is as easy as pip install pymssql (See M(ansible.builtin.pip).)
requirements:
- python >= 2.7
- pymssql

4
plugins/modules/database/postgresql/postgresql_membership.py
View file

@ -16,8 +16,8 @@ description:
- Users are roles with login privilege.
- Groups are PostgreSQL roles usually without LOGIN privilege.
- "Common use case:"
- 1) add a new group (groups) by M(postgresql_user) module with I(role_attr_flags=NOLOGIN)
- 2) grant them desired privileges by M(postgresql_privs) module
- 1) add a new group (groups) by M(community.general.postgresql_user) module with I(role_attr_flags=NOLOGIN)
- 2) grant them desired privileges by M(community.general.postgresql_privs) module
- 3) add desired PostgreSQL users to the new group (groups) by this module
options:
groups:

2
plugins/modules/database/postgresql/postgresql_pg_hba.py
View file

@ -105,7 +105,7 @@ notes:
This could give unexpected results with manual created hba files, if it was improperly sorted.
For example a rule was created for a net first and for a ip in that net range next.
In that situation, the 'ip specific rule' will never hit, it is in the C(pg_hba) file obsolete.
After the C(pg_hba) file is rewritten by the M(postgresql_pg_hba) module, the ip specific rule will be sorted above the range rule.
After the C(pg_hba) file is rewritten by the M(community.general.postgresql_pg_hba) module, the ip specific rule will be sorted above the range rule.
And then it will hit, which will give unexpected results.
- With the 'order' parameter you can control which field is used to sort first, next and last.
- The module supports a check mode and a diff mode.

2
plugins/modules/database/postgresql/postgresql_query.py
View file

@ -15,7 +15,7 @@ short_description: Run PostgreSQL queries
description:
- Runs arbitrary PostgreSQL queries.
- Can run queries from SQL script files.
- Does not run against backup files. Use M(postgresql_db) with I(state=restore)
- Does not run against backup files. Use M(community.general.postgresql_db) with I(state=restore)
to run queries on files made by pg_dump/pg_dumpall utilities.
options:
query:

2
plugins/modules/database/postgresql/postgresql_set.py
View file

@ -21,7 +21,7 @@ description:
- The module allows to reset parameter to boot_val (cluster initial value) by I(reset=yes) or remove parameter
string from postgresql.auto.conf and reload I(value=default) (for settings with postmaster context restart is required).
- After change you can see in the ansible output the previous and
the new parameter value and other information using returned values and M(debug) module.
the new parameter value and other information using returned values and M(ansible.builtin.debug) module.
options:
name:
description:

7
plugins/modules/database/proxysql/proxysql_backend_servers.py
View file

@ -12,7 +12,7 @@ module: proxysql_backend_servers
author: "Ben Mildren (@bmildren)"
short_description: Adds or removes mysql hosts from proxysql admin interface.
description:
- The M(proxysql_backend_servers) module adds or removes mysql hosts using
- The M(community.general.proxysql_backend_servers) module adds or removes mysql hosts using
the proxysql admin interface.
options:
hostgroup_id:
@ -96,8 +96,9 @@ EXAMPLES = '''
# This example adds a server, it saves the mysql server config to disk, but
# avoids loading the mysql server config to runtime (this might be because
# several servers are being added and the user wants to push the config to
# runtime in a single batch using the M(proxysql_manage_config) module). It
# uses supplied credentials to connect to the proxysql admin interface.
# runtime in a single batch using the community.general.proxysql_manage_config
# module). It uses supplied credentials to connect to the proxysql admin
# interface.
- name: Add a server
proxysql_backend_servers:

2
plugins/modules/database/proxysql/proxysql_global_variables.py
View file

@ -12,7 +12,7 @@ module: proxysql_global_variables
author: "Ben Mildren (@bmildren)"
short_description: Gets or sets the proxysql global variables.
description:
- The M(proxysql_global_variables) module gets or sets the proxysql global
- The M(community.general.proxysql_global_variables) module gets or sets the proxysql global
variables.
options:
variable:

2
plugins/modules/database/proxysql/proxysql_manage_config.py
View file

@ -13,7 +13,7 @@ module: proxysql_manage_config
author: "Ben Mildren (@bmildren)"
short_description: Writes the proxysql configuration settings between layers.
description:
- The M(proxysql_global_variables) module writes the proxysql configuration
- The M(community.general.proxysql_global_variables) module writes the proxysql configuration
settings between layers. Currently this module will always report a
changed state, so should typically be used with WHEN however this will
change in a future version when the CHECKSUM table commands are available

7
plugins/modules/database/proxysql/proxysql_mysql_users.py
View file

@ -12,7 +12,7 @@ module: proxysql_mysql_users
author: "Ben Mildren (@bmildren)"
short_description: Adds or removes mysql users from proxysql admin interface.
description:
- The M(proxysql_mysql_users) module adds or removes mysql users using the
- The M(community.general.proxysql_mysql_users) module adds or removes mysql users using the
proxysql admin interface.
options:
username:
@ -91,8 +91,9 @@ EXAMPLES = '''
# This example adds a user, it saves the mysql user config to disk, but
# avoids loading the mysql user config to runtime (this might be because
# several users are being added and the user wants to push the config to
# runtime in a single batch using the M(proxysql_manage_config) module). It
# uses supplied credentials to connect to the proxysql admin interface.
# runtime in a single batch using the community.general.proxysql_manage_config
# module). It uses supplied credentials to connect to the proxysql admin
# interface.
- name: Add a user
proxysql_mysql_users:

8
plugins/modules/database/proxysql/proxysql_query_rules.py
View file

@ -12,7 +12,7 @@ module: proxysql_query_rules
author: "Ben Mildren (@bmildren)"
short_description: Modifies query rules using the proxysql admin interface.
description:
- The M(proxysql_query_rules) module modifies query rules using the
- The M(community.general.proxysql_query_rules) module modifies query rules using the
proxysql admin interface.
options:
rule_id:
@ -79,7 +79,7 @@ options:
description:
- Route matched queries to this hostgroup. This happens unless there is a
started transaction and the logged in user has
I(transaction_persistent) set to C(True) (see M(proxysql_mysql_users)).
I(transaction_persistent) set to C(True) (see M(community.general.proxysql_mysql_users)).
cache_ttl:
description:
- The number of milliseconds for which to cache the result of the query.
@ -150,8 +150,8 @@ EXAMPLES = '''
# hostgroup, it saves the mysql query rule config to disk, but avoids loading
# the mysql query config config to runtime (this might be because several
# rules are being added and the user wants to push the config to runtime in a
# single batch using the M(proxysql_manage_config) module). It uses supplied
# credentials to connect to the proxysql admin interface.
# single batch using the community.general.proxysql_manage_config module). It
# uses supplied credentials to connect to the proxysql admin interface.
- name: Add a rule
proxysql_query_rules:

4
plugins/modules/database/proxysql/proxysql_replication_hostgroups.py
View file

@ -48,8 +48,8 @@ EXAMPLES = '''
# to disk, but avoids loading the mysql server config to runtime (this might be
# because several replication hostgroup are being added and the user wants to
# push the config to runtime in a single batch using the
# M(proxysql_manage_config) module). It uses supplied credentials to connect
# to the proxysql admin interface.
# community.general.proxysql_manage_config module). It uses supplied credentials
# to connect to the proxysql admin interface.
- name: Add a replication hostgroup
proxysql_replication_hostgroups:

7
plugins/modules/database/proxysql/proxysql_scheduler.py
View file

@ -12,7 +12,7 @@ module: proxysql_scheduler
author: "Ben Mildren (@bmildren)"
short_description: Adds or removes schedules from proxysql admin interface.
description:
- The M(proxysql_scheduler) module adds or removes schedules using the
- The M(community.general.proxysql_scheduler) module adds or removes schedules using the
proxysql admin interface.
options:
active:
@ -72,8 +72,9 @@ EXAMPLES = '''
# This example adds a schedule, it saves the scheduler config to disk, but
# avoids loading the scheduler config to runtime (this might be because
# several servers are being added and the user wants to push the config to
# runtime in a single batch using the M(proxysql_manage_config) module). It
# uses supplied credentials to connect to the proxysql admin interface.
# runtime in a single batch using the community.general.proxysql_manage_config
# module). It uses supplied credentials to connect to the proxysql admin
# interface.
- name: Add a schedule
proxysql_scheduler:

2
plugins/modules/database/vertica/vertica_info.py
View file

@ -15,7 +15,7 @@ short_description: Gathers Vertica database facts.
description:
- Gathers Vertica database information.
- This module was called C(vertica_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(vertica_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.vertica_info) module no longer returns C(ansible_facts)!
options:
cluster:
description:

2
plugins/modules/files/ini_file.py
View file

@ -17,7 +17,7 @@ short_description: Tweak settings in INI files
extends_documentation_fragment: files
description:
- Manage (add, remove, change) individual settings in an INI-style file without having
to manage the file as a whole with, say, M(template) or M(assemble).
to manage the file as a whole with, say, M(ansible.builtin.template) or M(ansible.builtin.assemble).
- Adds missing sections if they don't exist.
- Before Ansible 2.0, comments are discarded when the source file is read, and therefore will not show up in the destination file.
- Since Ansible 2.3, this module adds missing ending newlines to files to keep in line with the POSIX standard, even when

7
plugins/modules/identity/onepassword_info.py
View file

@ -25,11 +25,11 @@ notes:
data could be stored in clear text on disk or in a database.
short_description: Gather items from 1Password
description:
- M(onepassword_info) wraps the C(op) command line utility to fetch data about one or more 1Password items.
- M(community.general.onepassword_info) wraps the C(op) command line utility to fetch data about one or more 1Password items.
- A fatal error occurs if any of the items being searched for can not be found.
- Recommend using with the C(no_log) option to avoid logging the values of the secrets being retrieved.
- This module was called C(onepassword_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(onepassword_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.onepassword_info) module no longer returns C(ansible_facts)!
You must now use the C(register) option to use the facts in other tasks.
options:
search_terms:
@ -60,7 +60,8 @@ options:
auto_login:
type: dict
description:
- A dictionary containing authentication details. If this is set, M(onepassword_info) will attempt to sign in to 1Password automatically.
- A dictionary containing authentication details. If this is set, M(community.general.onepassword_info)
will attempt to sign in to 1Password automatically.
- Without this option, you must have already logged in via the 1Password CLI before running Ansible.
- It is B(highly) recommended to store 1Password credentials in an Ansible Vault. Ensure that the key used to encrypt
the Ansible Vault is equal to or greater in strength than the 1Password master password.

2
plugins/modules/net_tools/hetzner_firewall.py
View file

@ -124,7 +124,7 @@ options:
the status changes to C(active) or C(disabled).
- Please note that there is a request limit. If you have to do multiple
updates, it can be better to disable waiting, and regularly use
M(hetzner_firewall_info) to query status.
M(community.general.hetzner_firewall_info) to query status.
type: bool
default: yes
wait_delay:

2
plugins/modules/net_tools/hetzner_firewall_info.py
View file

@ -40,7 +40,7 @@ options:
the status changes to C(active) or C(disabled).
- Please note that there is a request limit. If you have to do multiple
updates, it can be better to disable waiting, and regularly use
M(hetzner_firewall_info) to query status.
M(community.general.hetzner_firewall_info) to query status.
type: bool
default: yes
wait_delay:

4
plugins/modules/net_tools/ldap/ldap_attr.py
View file

@ -16,7 +16,7 @@ description:
- Add or remove LDAP attribute values.
notes:
- This only deals with attributes on existing entries. To add or remove
whole entries, see M(ldap_entry).
whole entries, see M(community.general.ldap_entry).
- The default authentication settings will attempt to use a SASL EXTERNAL
bind over a UNIX domain socket. This works well with the default Ubuntu
install for example, which includes a cn=peercred,cn=external,cn=auth ACL
@ -35,7 +35,7 @@ notes:
deprecated:
removed_in: 3.0.0 # was Ansible 2.14
why: 'The current "ldap_attr" module does not support LDAP attribute insertions or deletions with objectClass dependencies.'
alternative: 'Use M(ldap_attrs) instead. Deprecated in community.general 0.2.0.'
alternative: 'Use M(community.general.ldap_attrs) instead. Deprecated in community.general 0.2.0.'
author:
- Jiri Tyr (@jtyr)
requirements:

2
plugins/modules/net_tools/ldap/ldap_attrs.py
View file

@ -19,7 +19,7 @@ description:
- Add or remove multiple LDAP attribute values.
notes:
- This only deals with attributes on existing entries. To add or remove
whole entries, see M(ldap_entry).
whole entries, see M(community.general.ldap_entry).
- The default authentication settings will attempt to use a SASL EXTERNAL
bind over a UNIX domain socket. This works well with the default Ubuntu
install for example, which includes a cn=peercred,cn=external,cn=auth ACL

4
plugins/modules/net_tools/ldap/ldap_entry.py
View file

@ -17,7 +17,7 @@ short_description: Add or remove LDAP entries.
description:
- Add or remove LDAP entries. This module only asserts the existence or
non-existence of an LDAP entry, not its attributes. To assert the
attribute values of an entry, see M(ldap_attr).
attribute values of an entry, see M(community.general.ldap_attr).
notes:
- The default authentication settings will attempt to use a SASL EXTERNAL
bind over a UNIX domain socket. This works well with the default Ubuntu
@ -37,7 +37,7 @@ options:
description:
- If I(state=present), attributes necessary to create an entry. Existing
entries are never modified. To assert specific attribute values on an
existing entry, use M(ldap_attr) module instead.
existing entry, use M(community.general.ldap_attr) module instead.
objectClass:
description:
- If I(state=present), value or list of values to use when creating

2
plugins/modules/net_tools/ldap/ldap_passwd.py
View file

@ -15,7 +15,7 @@ short_description: Set passwords in LDAP.
description:
- Set a password for an LDAP entry. This module only asserts that
a given password is valid for a given entry. To assert the
existence of an entry, see M(ldap_entry).
existence of an entry, see M(community.general.ldap_entry).
notes:
- The default authentication settings will attempt to use a SASL EXTERNAL
bind over a UNIX domain socket. This works well with the default Ubuntu

2
plugins/modules/notification/bearychat.py
View file

@ -25,7 +25,7 @@ DOCUMENTATION = '''
module: bearychat
short_description: Send BearyChat notifications
description:
- The M(bearychat) module sends notifications to U(https://bearychat.com)
- The M(community.general.bearychat) module sends notifications to U(https://bearychat.com)
via the Incoming Robot integration.
author: "Jiangge Zhang (@tonyseek)"
options:

2
plugins/modules/notification/say.py
View file

@ -15,7 +15,7 @@ short_description: Makes a computer to speak.
description:
- makes a computer speak! Amuse your friends, annoy your coworkers!
notes:
- In 2.5, this module has been renamed from C(osx_say) to M(say).
- In 2.5, this module has been renamed from C(osx_say) to M(community.general.say).
- If you like this module, you may also be interested in the osx_say callback plugin.
- A list of available voices, with language, can be found by running C(say -v ?) on a OSX host and C(espeak --voices) on a Linux host.
options:

4
plugins/modules/packaging/language/easy_install.py
View file

@ -52,8 +52,8 @@ options:
notes:
- Please note that the C(easy_install) module can only install Python
libraries. Thus this module is not able to remove libraries. It is
generally recommended to use the M(pip) module which you can first install
using M(easy_install).
generally recommended to use the M(ansible.builtin.pip) module which you can first install
using M(community.general.easy_install).
- Also note that I(virtualenv) must be installed on the remote host if the
C(virtualenv) parameter is specified.
requirements: [ "virtualenv" ]

4
plugins/modules/packaging/os/flatpak.py
View file

@ -36,7 +36,7 @@ module: flatpak
short_description: Manage flatpaks
description:
- Allows users to add or remove flatpaks.
- See the M(flatpak_remote) module for managing flatpak remotes.
- See the M(community.general.flatpak_remote) module for managing flatpak remotes.
author:
- John Kwiatkoski (@JayKayy)
- Alexander Bethke (@oolongbrothers)
@ -77,7 +77,7 @@ options:
- The flatpak remote (repository) to install the flatpak from.
- By default, C(flathub) is assumed, but you do need to add the flathub flatpak_remote before
you can use this.
- See the M(flatpak_remote) module for managing flatpak remotes.
- See the M(community.general.flatpak_remote) module for managing flatpak remotes.
type: str
default: flathub
state:

2
plugins/modules/packaging/os/flatpak_remote.py
View file

@ -40,7 +40,7 @@ description:
formats.
- Currently, remote addition is only supported via I(flatpakrepo) file URLs.
- Existing remotes will not be updated.
- See the M(flatpak) module for managing flatpaks.
- See the M(community.general.flatpak) module for managing flatpaks.
author:
- John Kwiatkoski (@JayKayy)
- Alexander Bethke (@oolongbrothers)

2
plugins/modules/packaging/os/pulp_repo.py
View file

@ -28,7 +28,7 @@ options:
type: str
force_basic_auth:
description:
- httplib2, the library used by the M(uri) module only sends
- httplib2, the library used by the M(ansible.builtin.uri) module only sends
authentication information when a webservice responds to an initial
request with a 401 status. Since some basic auth services do not
properly send a 401, logins will fail. This option forces the sending of

2
plugins/modules/packaging/os/rhn_register.py
View file

@ -16,7 +16,7 @@ description:
author:
- James Laska (@jlaska)
notes:
- This is for older Red Hat products. You probably want the M(redhat_subscription) module instead.
- This is for older Red Hat products. You probably want the M(community.general.redhat_subscription) module instead.
- In order to register a system, C(rhnreg_ks) requires either a username and password, or an activationkey.
requirements:
- rhnreg_ks

2
plugins/modules/packaging/os/svr4pkg.py
View file

@ -40,7 +40,7 @@ options:
description:
- Specifies the location to install the package from. Required when C(state=present).
- "Can be any path acceptable to the C(pkgadd) command's C(-d) option. e.g.: C(somefile.pkg), C(/dir/with/pkgs), C(http:/server/mypkgs.pkg)."
- If using a file or directory, they must already be accessible by the host. See the M(copy) module for a way to get them there.
- If using a file or directory, they must already be accessible by the host. See the M(ansible.builtin.copy) module for a way to get them there.
type: str
proxy:
description:

2
plugins/modules/remote_management/hpilo/hpilo_info.py
View file

@ -19,7 +19,7 @@ description:
for provisioning (e.g. macaddress, uuid).
- This module requires the C(hpilo) python module.
- This module was called C(hpilo_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(hpilo_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.hpilo_info) module no longer returns C(ansible_facts)!
options:
host:
description:

2
plugins/modules/remote_management/imc/imc_rest.py
View file

@ -45,7 +45,7 @@ options:
content:
description:
- When used instead of C(path), sets the content of the API requests directly.
- This may be convenient to template simple requests, for anything complex use the M(template) module.
- This may be convenient to template simple requests, for anything complex use the M(ansible.builtin.template) module.
- You can collate multiple IMC XML fragments and they will be processed sequentially in a single stream,
the Cisco IMC output is subsequently merged.
- Parameter C(content) is mutual exclusive with parameter C(path).

2
plugins/modules/remote_management/oneview/oneview_datacenter_info.py
View file

@ -12,7 +12,7 @@ short_description: Retrieve information about the OneView Data Centers
description:
- Retrieve information about the OneView Data Centers.
- This module was called C(oneview_datacenter_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(oneview_datacenter_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.oneview_datacenter_info) module no longer returns C(ansible_facts)!
requirements:
- "hpOneView >= 2.0.1"
author:

2
plugins/modules/remote_management/oneview/oneview_enclosure_info.py
View file

@ -13,7 +13,7 @@ short_description: Retrieve information about one or more Enclosures
description:
- Retrieve information about one or more of the Enclosures from OneView.
- This module was called C(oneview_enclosure_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(oneview_enclosure_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.oneview_enclosure_info) module no longer returns C(ansible_facts)!
requirements:
- hpOneView >= 2.0.1
author:

2
plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py
View file

@ -12,7 +12,7 @@ short_description: Retrieve the information about one or more of the OneView Eth
description:
- Retrieve the information about one or more of the Ethernet Networks from OneView.
- This module was called C(oneview_ethernet_network_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(oneview_ethernet_network_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.oneview_ethernet_network_info) module no longer returns C(ansible_facts)!
requirements:
- hpOneView >= 2.0.1
author:

2
plugins/modules/remote_management/oneview/oneview_fc_network_info.py
View file

@ -12,7 +12,7 @@ short_description: Retrieve the information about one or more of the OneView Fib
description:
- Retrieve the information about one or more of the Fibre Channel Networks from OneView.
- This module was called C(oneview_fc_network_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(oneview_fc_network_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.oneview_fc_network_info) module no longer returns C(ansible_facts)!
requirements:
- hpOneView >= 2.0.1
author:

2
plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py
View file

@ -12,7 +12,7 @@ short_description: Retrieve the information about one or more of the OneView FCo
description:
- Retrieve the information about one or more of the FCoE Networks from OneView.
- This module was called C(oneview_fcoe_network_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(oneview_fcoe_network_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.oneview_fcoe_network_info) module no longer returns C(ansible_facts)!
requirements:
- hpOneView >= 2.0.1
author:

2
plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py
View file

@ -13,7 +13,7 @@ short_description: Retrieve information about one or more of the OneView Logical
description:
- Retrieve information about one or more of the Logical Interconnect Groups from OneView
- This module was called C(oneview_logical_interconnect_group_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(oneview_logical_interconnect_group_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.oneview_logical_interconnect_group_info) module no longer returns C(ansible_facts)!
requirements:
- hpOneView >= 2.0.1
author:

2
plugins/modules/remote_management/oneview/oneview_network_set_info.py
View file

@ -12,7 +12,7 @@ short_description: Retrieve information about the OneView Network Sets
description:
- Retrieve information about the Network Sets from OneView.
- This module was called C(oneview_network_set_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(oneview_network_set_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.oneview_network_set_info) module no longer returns C(ansible_facts)!
requirements:
- hpOneView >= 2.0.1
author:

2
plugins/modules/remote_management/oneview/oneview_san_manager_info.py
View file

@ -12,7 +12,7 @@ short_description: Retrieve information about one or more of the OneView SAN Man
description:
- Retrieve information about one or more of the SAN Managers from OneView
- This module was called C(oneview_san_manager_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(oneview_san_manager_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.oneview_san_manager_info) module no longer returns C(ansible_facts)!
requirements:
- hpOneView >= 2.0.1
author:

2
plugins/modules/remote_management/redfish/idrac_redfish_info.py
View file

@ -16,7 +16,7 @@ description:
get information back.
- For use with Dell EMC iDRAC operations that require Redfish OEM extensions
- This module was called C(idrac_redfish_facts) before Ansible 2.9, returning C(ansible_facts).
Note that the M(idrac_redfish_info) module no longer returns C(ansible_facts)!
Note that the M(community.general.idrac_redfish_info) module no longer returns C(ansible_facts)!
options:
category:
required: true

Some files were not shown because too many files have changed in this diff Show more