diff options
author | Brian Coca <bcoca@users.noreply.github.com> | 2019-01-23 20:03:47 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-01-23 20:03:47 -0500 |
commit | 96b3ef555316afdacab6fd1401b4ec5da7663ae1 (patch) | |
tree | fcd903ff83c6b98b71b480e80bcf6906de92877f /lib/ansible/utils | |
parent | 4041f0238924b409f4de2906428800f0d6cc6aee (diff) | |
download | ansible-96b3ef555316afdacab6fd1401b4ec5da7663ae1.tar.gz |
Doc fragments to plugins (#50172)
* promote doc_fragments into actual plugins
change tests hardcoded path to doc fragments
avoid sanity in fragments
avoid improper testing of doc_fragments
also change runner paths
fix botmeta
updated comment for fragments
updated docs
Diffstat (limited to 'lib/ansible/utils')
96 files changed, 1 insertions, 6010 deletions
diff --git a/lib/ansible/utils/module_docs_fragments/__init__.py b/lib/ansible/utils/module_docs_fragments/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/ansible/utils/module_docs_fragments/__init__.py +++ /dev/null diff --git a/lib/ansible/utils/module_docs_fragments/a10.py b/lib/ansible/utils/module_docs_fragments/a10.py deleted file mode 100644 index 088f3e95da..0000000000 --- a/lib/ansible/utils/module_docs_fragments/a10.py +++ /dev/null @@ -1,60 +0,0 @@ -# -# (c) 2016, John Barker <jobarker@redhat.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -notes: - - "Requires A10 Networks aXAPI 2.1" -options: - host: - description: - - Hostname or IP of the A10 Networks device. - type: str - required: true - username: - description: - - An account with administrator privileges. - type: str - required: true - aliases: [ admin, user ] - password: - description: - - Password for the C(username) account. - type: str - required: true - aliases: [ pass, pwd ] - write_config: - description: - - If C(yes), any changes will cause a write of the running configuration - to non-volatile memory. This will save I(all) configuration changes, - including those that may have been made manually or through other modules, - so care should be taken when specifying C(yes). - type: bool - default: no - version_added: 2.2 - validate_certs: - description: - - If C(no), SSL certificates will not be validated. This should only be used - on personally controlled devices using self-signed certificates. - type: bool - default: yes - version_added: 2.2 -""" diff --git a/lib/ansible/utils/module_docs_fragments/aci.py b/lib/ansible/utils/module_docs_fragments/aci.py deleted file mode 100644 index 54b371108f..0000000000 --- a/lib/ansible/utils/module_docs_fragments/aci.py +++ /dev/null @@ -1,84 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2017, Dag Wieers (@dagwieers) <dag@wieers.com> -# Copyright: (c) 2017, Swetha Chunduri (@schunduri) -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Standard files documentation fragment - DOCUMENTATION = r''' -options: - host: - description: - - IP Address or hostname of APIC resolvable by Ansible control host. - type: str - required: yes - aliases: [ hostname ] - port: - description: - - Port number to be used for REST connection. - - The default value depends on parameter C(use_ssl). - type: int - username: - description: - - The username to use for authentication. - type: str - default: admin - aliases: [ user ] - password: - description: - - The password to use for authentication. - - This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. - type: str - required: yes - private_key: - description: - - PEM formatted file that contains your private key to be used for signature-based authentication. - - The name of the key (without extension) is used as the certificate name in ACI, unless C(certificate_name) is specified. - - This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. - type: path - required: yes - aliases: [ cert_key ] - certificate_name: - description: - - The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. - - It defaults to the C(private_key) basename, without extension. - type: str - aliases: [ cert_name ] - output_level: - description: - - Influence the output of this ACI module. - - C(normal) means the standard output, incl. C(current) dict - - C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts - - C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information - type: str - choices: [ debug, info, normal ] - default: normal - timeout: - description: - - The socket level timeout in seconds. - type: int - default: 30 - use_proxy: - description: - - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. - type: bool - default: yes - use_ssl: - description: - - If C(no), an HTTP connection will be used instead of the default HTTPS connection. - type: bool - default: yes - validate_certs: - description: - - If C(no), SSL certificates will not be validated. - - This should only set to C(no) when used on personally controlled sites using self-signed certificates. - type: bool - default: yes -seealso: -- ref: aci_guide - description: Detailed information on how to manage your ACI infrastructure using Ansible. -- ref: aci_dev_guide - description: Detailed guide on how to write your own Cisco ACI modules to contribute. -''' diff --git a/lib/ansible/utils/module_docs_fragments/acme.py b/lib/ansible/utils/module_docs_fragments/acme.py deleted file mode 100644 index c058435b57..0000000000 --- a/lib/ansible/utils/module_docs_fragments/acme.py +++ /dev/null @@ -1,105 +0,0 @@ -# -*- coding: utf-8 -*- - -# (c) 2016 Michael Gruener <michael.gruener@chaosmoon.net> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -notes: - - "If a new enough version of the C(cryptography) library - is available (see Requirements for details), it will be used - instead of the C(openssl) binary. This can be explicitly disabled - or enabled with the C(select_crypto_backend) option. Note that using - the C(openssl) binary will be slower and less secure, as private key - contents always have to be stored on disk (see - C(account_key_content))." - - "Although the defaults are chosen so that the module can be used with - the L(Let's Encrypt,https://letsencrypt.org/) CA, the module can in - principle be used with any CA providing an ACME endpoint." -requirements: - - "python >= 2.6" - - "either openssl, ..." - - "... or L(cryptography,https://cryptography.io/) >= 1.5" -options: - account_key_src: - description: - - "Path to a file containing the ACME account RSA or Elliptic Curve - key." - - "RSA keys can be created with C(openssl rsa ...). Elliptic curve keys can - be created with C(openssl ecparam -genkey ...). Any other tool creating - private keys in PEM format can be used as well." - - "Mutually exclusive with C(account_key_content)." - - "Required if C(account_key_content) is not used." - aliases: [ account_key ] - account_key_content: - description: - - "Content of the ACME account RSA or Elliptic Curve key." - - "Mutually exclusive with C(account_key_src)." - - "Required if C(account_key_src) is not used." - - "I(Warning): the content will be written into a temporary file, which will - be deleted by Ansible when the module completes. Since this is an - important private key — it can be used to change the account key, - or to revoke your certificates without knowing their private keys - —, this might not be acceptable." - - "In case C(cryptography) is used, the content is not written into a - temporary file. It can still happen that it is written to disk by - Ansible in the process of moving the module with its argument to - the node where it is executed." - version_added: "2.5" - account_uri: - description: - - "If specified, assumes that the account URI is as given. If the - account key does not match this account, or an account with this - URI does not exist, the module fails." - version_added: "2.7" - acme_version: - description: - - "The ACME version of the endpoint." - - "Must be 1 for the classic Let's Encrypt ACME endpoint, or 2 for the - new standardized ACME v2 endpoint." - default: 1 - choices: [1, 2] - version_added: "2.5" - acme_directory: - description: - - "The ACME directory to use. This is the entry point URL to access - CA server API." - - "For safety reasons the default is set to the Let's Encrypt staging - server (for the ACME v1 protocol). This will create technically correct, - but untrusted certificates." - - "For Let's Encrypt, all staging endpoints can be found here: - U(https://letsencrypt.org/docs/staging-environment/)" - - "For Let's Encrypt, the production directory URL for ACME v1 is - U(https://acme-v01.api.letsencrypt.org/directory), and the production - directory URL for ACME v2 is U(https://acme-v02.api.letsencrypt.org/directory)." - - "I(Warning): So far, the module has only been tested against Let's Encrypt - (staging and production) and against the - L(Pebble testing server,https://github.com/letsencrypt/Pebble)." - default: https://acme-staging.api.letsencrypt.org/directory - validate_certs: - description: - - Whether calls to the ACME directory will validate TLS certificates. - - "I(Warning): Should I(only ever) be set to C(no) for testing purposes, - for example when testing against a local Pebble server." - type: bool - default: 'yes' - version_added: "2.5" - select_crypto_backend: - description: - - "Determines which crypto backend to use. The default choice is C(auto), - which tries to use C(cryptography) if available, and falls back to - C(openssl)." - - "If set to C(openssl), will try to use the C(openssl) binary." - - "If set to C(cryptography), will try to use the - L(cryptography,https://cryptography.io/) library." - type: str - default: 'auto' - choices: - - auto - - cryptography - - openssl - version_added: "2.7" -""" diff --git a/lib/ansible/utils/module_docs_fragments/aireos.py b/lib/ansible/utils/module_docs_fragments/aireos.py deleted file mode 100644 index 6f623a3a0c..0000000000 --- a/lib/ansible/utils/module_docs_fragments/aireos.py +++ /dev/null @@ -1,65 +0,0 @@ -# -# (c) 2017, James Mighion <@jmighion> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote. - device. - default: 22 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the - key used to authenticate the SSH session. If the value is not specified - in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. -""" diff --git a/lib/ansible/utils/module_docs_fragments/alicloud.py b/lib/ansible/utils/module_docs_fragments/alicloud.py deleted file mode 100644 index e94f4fed00..0000000000 --- a/lib/ansible/utils/module_docs_fragments/alicloud.py +++ /dev/null @@ -1,61 +0,0 @@ -# !/usr/bin/python -# Copyright (c) 2017 Alibaba Group Holding Limited. He Guimin <heguimin36@163.com> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Alicloud only documentation fragment - DOCUMENTATION = """ -options: - alicloud_access_key: - description: - - Aliyun Cloud access key. If not set then the value of environment variable C(ALICLOUD_ACCESS_KEY), - C(ALICLOUD_ACCESS_KEY_ID) will be used instead. - aliases: ['access_key_id', 'access_key'] - alicloud_secret_key: - description: - - Aliyun Cloud secret key. If not set then the value of environment variable C(ALICLOUD_SECRET_KEY), - C(ALICLOUD_SECRET_ACCESS_KEY) will be used instead. - aliases: ['secret_access_key', 'secret_key'] - alicloud_region: - description: - - The Aliyun Cloud region to use. If not specified then the value of environment variable - C(ALICLOUD_REGION), C(ALICLOUD_REGION_ID) will be used instead. - aliases: ['region', 'region_id'] - alicloud_security_token: - description: - - The Aliyun Cloud security token. If not specified then the value of environment variable - C(ALICLOUD_SECURITY_TOKEN) will be used instead. - aliases: ['security_token'] -author: - - "He Guimin (@xiaozhu36)" -requirements: - - "python >= 2.6" -extends_documentation_fragment: - - alicloud -notes: - - If parameters are not set within the module, the following - environment variables can be used in decreasing order of precedence - C(ALICLOUD_ACCESS_KEY) or C(ALICLOUD_ACCESS_KEY_ID), - C(ALICLOUD_SECRET_KEY) or C(ALICLOUD_SECRET_ACCESS_KEY), - C(ALICLOUD_REGION) or C(ALICLOUD_REGION_ID), - C(ALICLOUD_SECURITY_TOKEN) - - C(ALICLOUD_REGION) or C(ALICLOUD_REGION_ID) can be typically be used to specify the - ALICLOUD region, when required, but this can also be configured in the footmark config file -""" diff --git a/lib/ansible/utils/module_docs_fragments/aruba.py b/lib/ansible/utils/module_docs_fragments/aruba.py deleted file mode 100644 index 6f623a3a0c..0000000000 --- a/lib/ansible/utils/module_docs_fragments/aruba.py +++ /dev/null @@ -1,65 +0,0 @@ -# -# (c) 2017, James Mighion <@jmighion> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote. - device. - default: 22 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the - key used to authenticate the SSH session. If the value is not specified - in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. -""" diff --git a/lib/ansible/utils/module_docs_fragments/asa.py b/lib/ansible/utils/module_docs_fragments/asa.py deleted file mode 100644 index 183ba3b693..0000000000 --- a/lib/ansible/utils/module_docs_fragments/asa.py +++ /dev/null @@ -1,103 +0,0 @@ -# -# (c) 2016, Peter Sprygada <psprygada@ansible.com> -# (c) 2016, Patrick Ogenstad <@ogenstad> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - authorize: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli) and C(become: yes)." - - For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols). - - HORIZONTALLINE - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: 'no' - context: - description: - - Specifies which context to target if you are running in the ASA in - multiple context mode. Defaults to the current context you login to. - provider: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli)." - - For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols). - - HORIZONTALLINE - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - port: - description: - - Specifies the port to use when building the connection to the remote - device. - default: 22 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the - key used to authenticate the SSH session. If the value is not specified - in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. - authorize: - description: - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: 'no' - auth_pass: - description: - - Specifies the password to use if required to enter privileged mode - on the remote device. If I(authorize) is false, then this argument - does nothing. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - timeout: - description: - - Specifies idle timeout in seconds for the connection, in seconds. Useful - if the console freezes before continuing. For example when saving - configurations. - default: 10 -notes: - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` -""" diff --git a/lib/ansible/utils/module_docs_fragments/auth_basic.py b/lib/ansible/utils/module_docs_fragments/auth_basic.py deleted file mode 100644 index 22620a9a20..0000000000 --- a/lib/ansible/utils/module_docs_fragments/auth_basic.py +++ /dev/null @@ -1,36 +0,0 @@ -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - api_url: - description: - - The resolvable endpoint for the API - api_username: - description: - - The username to use for authentication against the API - api_password: - description: - - The password to use for authentication against the API - validate_certs: - description: - - Whether or not to validate SSL certs when supplying a https endpoint. - type: bool - default: 'yes' -""" diff --git a/lib/ansible/utils/module_docs_fragments/avi.py b/lib/ansible/utils/module_docs_fragments/avi.py deleted file mode 100644 index 5e034fe540..0000000000 --- a/lib/ansible/utils/module_docs_fragments/avi.py +++ /dev/null @@ -1,63 +0,0 @@ -# -# Created on December 12, 2016 -# @author: Gaurav Rastogi (grastogi@avinetworks.com) -# Avi Version: 16.3.4 -# -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. -# - - -class ModuleDocFragment(object): - # Avi common documentation fragment - DOCUMENTATION = """ -options: - controller: - description: - - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). - default: '' - username: - description: - - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). - default: '' - password: - description: - - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). - default: '' - tenant: - description: - - Name of tenant used for all Avi API calls and context of object. - default: admin - tenant_uuid: - description: - - UUID of tenant used for all Avi API calls and context of object. - default: '' - api_version: - description: - - Avi API version of to use for Avi API and objects. - default: "16.4.4" - avi_credentials: - description: - - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. - version_added: "2.5" - api_context: - description: - - Avi API context that includes current session ID and CSRF Token. - - This allows user to perform single login and re-use the session. - version_added: "2.5" -notes: - - For more information on using Ansible to manage Avi Network devices see U(https://www.ansible.com/ansible-avi-networks). -""" diff --git a/lib/ansible/utils/module_docs_fragments/aws.py b/lib/ansible/utils/module_docs_fragments/aws.py deleted file mode 100644 index 56090c0b26..0000000000 --- a/lib/ansible/utils/module_docs_fragments/aws.py +++ /dev/null @@ -1,67 +0,0 @@ -# (c) 2014, Will Thames <will@thames.id.au> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # AWS only documentation fragment - DOCUMENTATION = """ -options: - ec2_url: - description: - - Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). - Ignored for modules where region is required. Must be specified for all other modules if region is not used. - If not set then the value of the EC2_URL environment variable, if any, is used. - aws_secret_key: - description: - - AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. - aliases: [ 'ec2_secret_key', 'secret_key' ] - aws_access_key: - description: - - AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. - aliases: [ 'ec2_access_key', 'access_key' ] - security_token: - description: - - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. - aliases: [ 'access_token' ] - version_added: "1.6" - validate_certs: - description: - - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. - type: bool - default: 'yes' - version_added: "1.5" - profile: - description: - - Uses a boto profile. Only works with boto >= 2.24.0. - version_added: "1.6" -requirements: - - "python >= 2.6" - - boto -notes: - - If parameters are not set within the module, the following - environment variables can be used in decreasing order of precedence - C(AWS_URL) or C(EC2_URL), - C(AWS_ACCESS_KEY_ID) or C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY), - C(AWS_SECRET_ACCESS_KEY) or C(AWS_SECRET_KEY) or C(EC2_SECRET_KEY), - C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN), - C(AWS_REGION) or C(EC2_REGION) - - Ansible uses the boto configuration file (typically ~/.boto) if no - credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html - - C(AWS_REGION) or C(EC2_REGION) can be typically be used to specify the - AWS region, when required, but this can also be configured in the boto config file -""" diff --git a/lib/ansible/utils/module_docs_fragments/aws_credentials.py b/lib/ansible/utils/module_docs_fragments/aws_credentials.py deleted file mode 100644 index 61bdcf6d18..0000000000 --- a/lib/ansible/utils/module_docs_fragments/aws_credentials.py +++ /dev/null @@ -1,39 +0,0 @@ -# (c) 2017 Ansible Project -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # inventory cache - DOCUMENTATION = """ -options: - aws_profile: - description: The AWS profile - aliases: ['boto_profile'] - env: - - name: AWS_PROFILE - - name: AWS_DEFAULT_PROFILE - aws_access_key: - description: The AWS access key to use. - env: - - name: AWS_ACCESS_KEY_ID - - name: AWS_ACCESS_KEY - - name: EC2_ACCESS_KEY - aws_secret_key: - description: The AWS secret key that corresponds to the access key. - env: - - name: AWS_SECRET_ACCESS_KEY - - name: AWS_SECRET_KEY - - name: EC2_SECRET_KEY - aws_security_token: - description: The AWS security token if using temporary access and secret keys. - env: - - name: AWS_SECURITY_TOKEN - - name: AWS_SESSION_TOKEN - - name: EC2_SECURITY_TOKEN - region: - description: The region for which to create the connection. - env: - - name: AWS_REGION - - name: EC2_REGION -""" diff --git a/lib/ansible/utils/module_docs_fragments/azure.py b/lib/ansible/utils/module_docs_fragments/azure.py deleted file mode 100644 index 6701e2d304..0000000000 --- a/lib/ansible/utils/module_docs_fragments/azure.py +++ /dev/null @@ -1,110 +0,0 @@ -# Copyright (c) 2016 Matt Davis, <mdavis@ansible.com> -# Chris Houseknecht, <house@redhat.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. -# - - -class ModuleDocFragment(object): - - # Azure doc fragment - DOCUMENTATION = ''' - -options: - ad_user: - description: - - Active Directory username. Use when authenticating with an Active Directory user rather than service - principal. - password: - description: - - Active Directory user password. Use when authenticating with an Active Directory user rather than service - principal. - profile: - description: - - Security profile found in ~/.azure/credentials file. - subscription_id: - description: - - Your Azure subscription Id. - client_id: - description: - - Azure client ID. Use when authenticating with a Service Principal. - secret: - description: - - Azure client secret. Use when authenticating with a Service Principal. - tenant: - description: - - Azure tenant ID. Use when authenticating with a Service Principal. - cloud_environment: - description: - - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), - C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or - the C(AZURE_CLOUD_ENVIRONMENT) environment variable. - default: AzureCloud - version_added: 2.4 - adfs_authority_url: - description: - - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. - required: false - default: null - version_added: 2.6 - cert_validation_mode: - description: - - Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but - when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be - set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. - choices: [validate, ignore] - version_added: 2.5 - auth_source: - description: - - Controls the source of the credentials to use for authentication. - - If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to C(auto) if variable is not defined. - - C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file - C(~/.azure/credentials). - - When set to C(cli), the credentials will be sources from the default Azure CLI profile. - - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - - When set to C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the - environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if the resource is granted - access to more than one subscription, otherwise the first subscription is chosen. - - The C(msi) was added in Ansible 2.6. - choices: - - auto - - cli - - credential_file - - env - - msi - version_added: 2.5 - api_profile: - description: - - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; - future values will allow use with Azure Stack. - default: latest - version_added: 2.5 -requirements: - - "python >= 2.7" - - "azure >= 2.0.0" - -notes: - - For authentication with Azure you can pass parameters, set environment variables or use a profile stored - in ~/.azure/credentials. Authentication is possible using a service principal or Active Directory user. - To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment - variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT. - - To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and - AZURE_PASSWORD in the environment. - - "Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing - a [default] section and the following keys: subscription_id, client_id, secret and tenant or - subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile - by passing profile or setting AZURE_PROFILE in the environment." - ''' diff --git a/lib/ansible/utils/module_docs_fragments/azure_tags.py b/lib/ansible/utils/module_docs_fragments/azure_tags.py deleted file mode 100644 index ff8579fde4..0000000000 --- a/lib/ansible/utils/module_docs_fragments/azure_tags.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright (c) 2016 Matt Davis, <mdavis@ansible.com> -# Chris Houseknecht, <house@redhat.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. -# - - -class ModuleDocFragment(object): - - # Azure doc fragment - DOCUMENTATION = ''' -options: - tags: - description: - - > - Dictionary of string:string pairs to assign as metadata to the object. - Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false. - append_tags: - description: - - Use to control if tags field is canonical or just appends to existing tags. - When canonical, any tags not found in the tags parameter will be removed from the object's metadata. - type: bool - default: 'yes' - ''' diff --git a/lib/ansible/utils/module_docs_fragments/backup.py b/lib/ansible/utils/module_docs_fragments/backup.py deleted file mode 100644 index 5d46528f26..0000000000 --- a/lib/ansible/utils/module_docs_fragments/backup.py +++ /dev/null @@ -1,18 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2015, Ansible, Inc -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard documentation fragment - DOCUMENTATION = r''' -options: - backup: - description: - - Create a backup file including the timestamp information so you can get - the original file back if you somehow clobbered it incorrectly. - type: bool - default: no -''' diff --git a/lib/ansible/utils/module_docs_fragments/ce.py b/lib/ansible/utils/module_docs_fragments/ce.py deleted file mode 100644 index 7a5f006ae8..0000000000 --- a/lib/ansible/utils/module_docs_fragments/ce.py +++ /dev/null @@ -1,67 +0,0 @@ -# -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote - device. This value applies to either I(cli) or I(netconf). The port - value will default to the appropriate transport common port if - none is provided in the task. (cli=22, netconf=22). - default: 0 (use common port) - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate the CLI login. - If the value is not specified in the task, the value of environment - variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This is a common argument used for cli - transports. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This argument is used for the I(cli) - transport. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. - transport: - description: - - Configures the transport connection to use when connecting to the - remote device. The transport argument supports connectivity to the - device over cli (ssh). - required: true - default: cli - -""" diff --git a/lib/ansible/utils/module_docs_fragments/cloudstack.py b/lib/ansible/utils/module_docs_fragments/cloudstack.py deleted file mode 100644 index 63c6f3ce7a..0000000000 --- a/lib/ansible/utils/module_docs_fragments/cloudstack.py +++ /dev/null @@ -1,61 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright (c) 2015, René Moser <mail@renemoser.net> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard cloudstack documentation fragment - DOCUMENTATION = ''' -options: - api_key: - description: - - API key of the CloudStack API. - - If not given, the C(CLOUDSTACK_KEY) env variable is considered. - - As the last option, the value is taken from the ini config file, also see the notes. - api_secret: - description: - - Secret key of the CloudStack API. - - If not set, the C(CLOUDSTACK_SECRET) env variable is considered. - - As the last option, the value is taken from the ini config file, also see the notes. - api_url: - description: - - URL of the CloudStack API e.g. https://cloud.example.com/client/api. - - If not given, the C(CLOUDSTACK_ENDPOINT) env variable is considered. - - As the last option, the value is taken from the ini config file, also see the notes. - api_http_method: - description: - - HTTP method used to query the API endpoint. - - If not given, the C(CLOUDSTACK_METHOD) env variable is considered. - - As the last option, the value is taken from the ini config file, also see the notes. - - Fallback value is C(get) if not specified. - choices: [ get, post ] - api_timeout: - description: - - HTTP timeout in seconds. - - If not given, the C(CLOUDSTACK_TIMEOUT) env variable is considered. - - As the last option, the value is taken from the ini config file, also see the notes. - - Fallback value is 10 seconds if not specified. - api_region: - description: - - Name of the ini section in the C(cloustack.ini) file. - - If not given, the C(CLOUDSTACK_REGION) env variable is considered. - default: cloudstack -requirements: - - "python >= 2.6" - - "cs >= 0.6.10" -notes: - - Ansible uses the C(cs) library's configuration method if credentials are not - provided by the arguments C(api_url), C(api_key), C(api_secret). - Configuration is read from several locations, in the following order. - The C(CLOUDSTACK_ENDPOINT), C(CLOUDSTACK_KEY), C(CLOUDSTACK_SECRET) and - C(CLOUDSTACK_METHOD). C(CLOUDSTACK_TIMEOUT) environment variables. - A C(CLOUDSTACK_CONFIG) environment variable pointing to an C(.ini) file. - A C(cloudstack.ini) file in the current working directory. - A C(.cloudstack.ini) file in the users home directory. - Optionally multiple credentials and endpoints can be specified using ini sections in C(cloudstack.ini). - Use the argument C(api_region) to select the section name, default section is C(cloudstack). - See https://github.com/exoscale/cs for more information. - - A detailed guide about cloudstack modules can be found in the L(CloudStack Cloud Guide,../scenario_guides/guide_cloudstack.html). - - This module supports check mode. -''' diff --git a/lib/ansible/utils/module_docs_fragments/cnos.py b/lib/ansible/utils/module_docs_fragments/cnos.py deleted file mode 100644 index 3f41a2c564..0000000000 --- a/lib/ansible/utils/module_docs_fragments/cnos.py +++ /dev/null @@ -1,83 +0,0 @@ -# Copyright (C) 2017 Lenovo, Inc. -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. -# - - -class ModuleDocFragment(object): - # Standard CNOS documentation fragment - DOCUMENTATION = ''' -options: - outputfile: - description: - - This specifies the file path where the output of each command - execution is saved. Each command that is specified in the merged - template file and each response from the device are saved here. - Usually the location is the results folder, but you can - choose another location based on your write permission. - required: true - version_added: 2.3 - host: - description: - - This is the variable used to search the hosts file at - /etc/ansible/hosts and identify the IP address of the device on - which the template is going to be applied. Usually the Ansible - keyword {{ inventory_hostname }} is specified in the playbook as - an abstraction of the group of network elements that need to be - configured. - required: true - version_added: 2.3 - username: - description: - - Configures the username used to authenticate the connection to - the remote device. The value of the username parameter is used to - authenticate the SSH session. While generally the value should - come from the inventory file, you can also specify it as a - variable. This parameter is optional. If it is not specified, no - default value will be used. - required: true - version_added: 2.3 - password: - description: - - Configures the password used to authenticate the connection to - the remote device. The value of the password parameter is used to - authenticate the SSH session. While generally the value should - come from the inventory file, you can also specify it as a - variable. This parameter is optional. If it is not specified, no - default value will be used. - required: true - version_added: 2.3 - enablePassword: - description: - - Configures the password used to enter Global Configuration - command mode on the switch. If the switch does not request this - password, the parameter is ignored.While generally the value - should come from the inventory file, you can also specify it as a - variable. This parameter is optional. If it is not specified, - no default value will be used. - version_added: 2.3 - deviceType: - description: - - This specifies the type of device where the method is executed. - The choices NE1072T,NE1032,NE1032T,NE10032,NE2572 are added - since version 2.4. The choice NE0152T is added since 2.8 - required: Yes - choices: [g8272_cnos,g8296_cnos,g8332_cnos,NE1072T,NE1032, - NE1032T,NE10032,NE2572,NE0152T] - version_added: 2.3 -notes: - - For more information on using Ansible to manage Lenovo Network devices see U(https://www.ansible.com/ansible-lenovo). -''' diff --git a/lib/ansible/utils/module_docs_fragments/constructed.py b/lib/ansible/utils/module_docs_fragments/constructed.py deleted file mode 100644 index 4f8036abdc..0000000000 --- a/lib/ansible/utils/module_docs_fragments/constructed.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright (c) 2017 Ansible Project -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - DOCUMENTATION = """ -options: - strict: - description: - - If true make invalid entries a fatal error, otherwise skip and continue - - Since it is possible to use facts in the expressions they might not always be available - and we ignore those errors by default. - type: boolean - default: False - compose: - description: create vars from jinja2 expressions - type: dictionary - default: {} - groups: - description: add hosts to group based on Jinja2 conditionals - type: dictionary - default: {} - keyed_groups: - description: add hosts to group based on the values of a variable - type: list - default: [] -""" diff --git a/lib/ansible/utils/module_docs_fragments/decrypt.py b/lib/ansible/utils/module_docs_fragments/decrypt.py deleted file mode 100644 index 3b33cf5fa1..0000000000 --- a/lib/ansible/utils/module_docs_fragments/decrypt.py +++ /dev/null @@ -1,31 +0,0 @@ -# (c) 2017, Brian Coca <bcoca@redhat.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - decrypt: - description: - - This option controls the autodecryption of source files using vault. - required: false - type: 'bool' - default: 'yes' - version_added: "2.4" -""" diff --git a/lib/ansible/utils/module_docs_fragments/default_callback.py b/lib/ansible/utils/module_docs_fragments/default_callback.py deleted file mode 100644 index ec56a28850..0000000000 --- a/lib/ansible/utils/module_docs_fragments/default_callback.py +++ /dev/null @@ -1,51 +0,0 @@ -# (c) 2017 Ansible Project -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - DOCUMENTATION = """ - options: - display_skipped_hosts: - name: Show skipped hosts - description: "Toggle to control displaying skipped task/host results in a task" - default: True - env: - - name: DISPLAY_SKIPPED_HOSTS - ini: - - key: display_skipped_hosts - section: defaults - type: boolean - display_ok_hosts: - name: Show 'ok' hosts - description: "Toggle to control displaying 'ok' task/host results in a task" - default: True - env: - - name: ANSIBLE_DISPLAY_OK_HOSTS - ini: - - key: display_ok_hosts - section: defaults - type: boolean - version_added: '2.7' - display_failed_stderr: - name: Use STDERR for failed and unreachable tasks - description: "Toggle to control whether failed and unreachable tasks are displayed to STDERR (vs. STDOUT)" - default: False - env: - - name: ANSIBLE_DISPLAY_FAILED_STDERR - ini: - - key: display_failed_stderr - section: defaults - type: boolean - version_added: '2.7' - show_custom_stats: - name: Show custom stats - description: 'This adds the custom stats set via the set_stats plugin to the play recap' - default: False - env: - - name: ANSIBLE_SHOW_CUSTOM_STATS - ini: - - key: show_custom_stats - section: defaults - type: bool -""" diff --git a/lib/ansible/utils/module_docs_fragments/dellos10.py b/lib/ansible/utils/module_docs_fragments/dellos10.py deleted file mode 100644 index 71c70cec48..0000000000 --- a/lib/ansible/utils/module_docs_fragments/dellos10.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com> -# Copyright: (c) 2016, Dell Inc. -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote - device. - default: 22 - username: - description: - - User to authenticate the SSH session to the remote device. If the - value is not specified in the task, the value of environment variable - C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Password to authenticate the SSH session to the remote device. If the - value is not specified in the task, the value of environment variable - C(ANSIBLE_NET_PASSWORD) will be used instead. - ssh_keyfile: - description: - - Path to an ssh key used to authenticate the SSH session to the remote - device. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. - timeout: - description: - - Specifies idle timeout (in seconds) for the connection. Useful if the - console freezes before continuing. For example when saving - configurations. - default: 10 -notes: - - For more information on using Ansible to manage Dell EMC Network devices see U(https://www.ansible.com/ansible-dell-networking). -""" diff --git a/lib/ansible/utils/module_docs_fragments/dellos6.py b/lib/ansible/utils/module_docs_fragments/dellos6.py deleted file mode 100644 index 61fe4b2dfe..0000000000 --- a/lib/ansible/utils/module_docs_fragments/dellos6.py +++ /dev/null @@ -1,57 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com> -# Copyright: (c) 2016, Dell Inc. -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - type: str - required: true - port: - description: - - Specifies the port to use when building the connection to the remote - device. - type: int - default: 22 - username: - description: - - User to authenticate the SSH session to the remote device. If the - value is not specified in the task, the value of environment variable - C(ANSIBLE_NET_USERNAME) will be used instead. - type: str - password: - description: - - Password to authenticate the SSH session to the remote device. If the - value is not specified in the task, the value of environment variable - C(ANSIBLE_NET_PASSWORD) will be used instead. - type: str - ssh_keyfile: - description: - - Path to an ssh key used to authenticate the SSH session to the remote - device. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. - type: str - timeout: - description: - - Specifies idle timeout (in seconds) for the connection. Useful if the - console freezes before continuing. For example when saving - configurations. - type: int - default: 10 -notes: - - For more information on using Ansible to manage Dell EMC Network devices see U(https://www.ansible.com/ansible-dell-networking). -""" diff --git a/lib/ansible/utils/module_docs_fragments/dellos9.py b/lib/ansible/utils/module_docs_fragments/dellos9.py deleted file mode 100644 index 4afb580411..0000000000 --- a/lib/ansible/utils/module_docs_fragments/dellos9.py +++ /dev/null @@ -1,58 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com> -# Copyright: (c) 2016, Dell Inc. -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - A dict object containing connection details. - type: dict - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - type: str - required: true - port: - description: - - Specifies the port to use when building the connection to the remote - device. - type: int - default: 22 - username: - description: - - User to authenticate the SSH session to the remote device. If the - value is not specified in the task, the value of environment variable - C(ANSIBLE_NET_USERNAME) will be used instead. - type: str - password: - description: - - Password to authenticate the SSH session to the remote device. If the - value is not specified in the task, the value of environment variable - C(ANSIBLE_NET_PASSWORD) will be used instead. - type: str - ssh_keyfile: - description: - - Path to an ssh key used to authenticate the SSH session to the remote - device. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. - type: str - timeout: - description: - - Specifies idle timeout (in seconds) for the connection. Useful if the - console freezes before continuing. For example when saving - configurations. - type: int - default: 10 -notes: - - For more information on using Ansible to manage Dell EMC Network devices see U(https://www.ansible.com/ansible-dell-networking). -""" diff --git a/lib/ansible/utils/module_docs_fragments/digital_ocean.py b/lib/ansible/utils/module_docs_fragments/digital_ocean.py deleted file mode 100644 index f592c6c46f..0000000000 --- a/lib/ansible/utils/module_docs_fragments/digital_ocean.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright (c) 2018, Ansible Project -# Copyright (c) 2018, Abhijeet Kasurde (akasurde@redhat.com) -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Parameters for DigitalOcean modules - DOCUMENTATION = ''' -options: - oauth_token: - description: - - DigitalOcean OAuth token. - - "There are several other environment variables which can be used to provide this value." - - "i.e., - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' and 'OAUTH_TOKEN'" - required: false - aliases: ['api_token'] - timeout: - description: - - The timeout in seconds used for polling DigitalOcean's API. - default: 30 - validate_certs: - description: - - If set to C(no), the SSL certificates will not be validated. - - This should only set to C(no) used on personally controlled sites using self-signed certificates. - default: true - type: bool - -''' diff --git a/lib/ansible/utils/module_docs_fragments/dimensiondata.py b/lib/ansible/utils/module_docs_fragments/dimensiondata.py deleted file mode 100644 index ef40b200ef..0000000000 --- a/lib/ansible/utils/module_docs_fragments/dimensiondata.py +++ /dev/null @@ -1,59 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright (c) 2016 Dimension Data -# -# This module is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This software is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this software. If not, see <http://www.gnu.org/licenses/>. -# -# Authors: -# - Adam Friedman <tintoy@tintoy.io> - - -class ModuleDocFragment(object): - - # Dimension Data doc fragment - DOCUMENTATION = ''' - -options: - region: - description: - - The target region. - choices: - - Regions are defined in Apache libcloud project [libcloud/common/dimensiondata.py] - - They are also listed in U(https://libcloud.readthedocs.io/en/latest/compute/drivers/dimensiondata.html) - - Note that the default value "na" stands for "North America". - - The module prepends 'dd-' to the region choice. - default: na - mcp_user: - description: - - The username used to authenticate to the CloudControl API. - - If not specified, will fall back to C(MCP_USER) from environment variable or C(~/.dimensiondata). - required: false - mcp_password: - description: - - The password used to authenticate to the CloudControl API. - - If not specified, will fall back to C(MCP_PASSWORD) from environment variable or C(~/.dimensiondata). - - Required if I(mcp_user) is specified. - required: false - location: - description: - - The target datacenter. - required: true - validate_certs: - description: - - If C(false), SSL certificates will not be validated. - - This should only be used on private instances of the CloudControl API that use self-signed certificates. - required: false - default: true - type: bool - ''' diff --git a/lib/ansible/utils/module_docs_fragments/dimensiondata_wait.py b/lib/ansible/utils/module_docs_fragments/dimensiondata_wait.py deleted file mode 100644 index 37c5327234..0000000000 --- a/lib/ansible/utils/module_docs_fragments/dimensiondata_wait.py +++ /dev/null @@ -1,46 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright (c) 2016 Dimension Data -# -# This module is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This software is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this software. If not, see <http://www.gnu.org/licenses/>. -# -# Authors: -# - Adam Friedman <tintoy@tintoy.io> - - -class ModuleDocFragment(object): - - # Dimension Data ("wait-for-completion" parameters) doc fragment - DOCUMENTATION = ''' - -options: - wait: - description: - - Should we wait for the task to complete before moving onto the next. - required: false - default: false - type: bool - wait_time: - description: - - The maximum amount of time (in seconds) to wait for the task to complete. - - Only applicable if I(wait=true). - required: false - default: 600 - wait_poll_interval: - description: - - The amount of time (in seconds) to wait between checks for task completion. - - Only applicable if I(wait=true). - required: false - default: 2 - ''' diff --git a/lib/ansible/utils/module_docs_fragments/docker.py b/lib/ansible/utils/module_docs_fragments/docker.py deleted file mode 100644 index 093d7e9b01..0000000000 --- a/lib/ansible/utils/module_docs_fragments/docker.py +++ /dev/null @@ -1,104 +0,0 @@ -# -*- coding: utf-8 -*- - -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Docker doc fragment - DOCUMENTATION = r''' - -options: - docker_host: - description: - - The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the - TCP connection string. For example, C(tcp://192.0.2.23:2376). If TLS is used to encrypt the connection, - the module will automatically replace C(tcp) in the connection URL with C(https). - - If the value is not specified in the task, the value of environment variable C(DOCKER_HOST) will be used - instead. If the environment variable is not set, the default value will be used. - type: str - default: unix://var/run/docker.sock - aliases: [ docker_url ] - tls_hostname: - description: - - When verifying the authenticity of the Docker Host server, provide the expected name of the server. - - If the value is not specified in the task, the value of environment variable C(DOCKER_TLS_HOSTNAME) will - be used instead. If the environment variable is not set, the default value will be used. - type: str - default: localhost - api_version: - description: - - The version of the Docker API running on the Docker Host. - - Defaults to the latest version of the API supported by docker-py. - - If the value is not specified in the task, the value of environment variable C(DOCKER_API_VERSION) will be - used instead. If the environment variable is not set, the default value will be used. - type: str - default: auto - aliases: [ docker_api_version ] - timeout: - description: - - The maximum amount of time in seconds to wait on a response from the API. - - If the value is not specified in the task, the value of environment variable C(DOCKER_TIMEOUT) will be used - instead. If the environment variable is not set, the default value will be used. - type: int - default: 60 - cacert_path: - description: - - Use a CA certificate when performing server verification by providing the path to a CA certificate file. - - If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set, - the file C(ca.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used. - type: str - aliases: [ tls_ca_cert ] - cert_path: - description: - - Path to the client's TLS certificate file. - - If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set, - the file C(cert.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used. - type: str - aliases: [ tls_client_cert ] - key_path: - description: - - Path to the client's TLS key file. - - If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set, - the file C(key.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used. - type: str - aliases: [ tls_client_key ] - ssl_version: - description: - - Provide a valid SSL version number. Default value determined by ssl.py module. - - If the value is not specified in the task, the value of environment variable C(DOCKER_SSL_VERSION) will be - used instead. - type: str - tls: - description: - - Secure the connection to the API by using TLS without verifying the authenticity of the Docker host - server. - - If the value is not specified in the task, the value of environment variable C(DOCKER_TLS) will be used - instead. If the environment variable is not set, the default value will be used. - type: bool - default: false - tls_verify: - description: - - Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server. - - If the value is not specified in the task, the value of environment variable C(DOCKER_TLS_VERIFY) will be - used instead. If the environment variable is not set, the default value will be used. - type: bool - default: false - debug: - description: - - Debug mode - type: bool - default: false - -notes: - - Connect to the Docker daemon by providing parameters with each task or by defining environment variables. - You can define C(DOCKER_HOST), C(DOCKER_TLS_HOSTNAME), C(DOCKER_API_VERSION), C(DOCKER_CERT_PATH), C(DOCKER_SSL_VERSION), - C(DOCKER_TLS), C(DOCKER_TLS_VERIFY) and C(DOCKER_TIMEOUT). If you are using docker machine, run the script shipped - with the product that sets up the environment. It will set these variables for you. See - U(https://docker-py.readthedocs.io/en/stable/machine/) 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). - - 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. -''' diff --git a/lib/ansible/utils/module_docs_fragments/ec2.py b/lib/ansible/utils/module_docs_fragments/ec2.py deleted file mode 100644 index 5485f484af..0000000000 --- a/lib/ansible/utils/module_docs_fragments/ec2.py +++ /dev/null @@ -1,30 +0,0 @@ -# (c) 2015, Ansible, Inc -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # EC2 only documentation fragment - DOCUMENTATION = """ -options: - region: - description: - - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. - See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) - required: false - aliases: [ 'aws_region', 'ec2_region' ] -""" diff --git a/lib/ansible/utils/module_docs_fragments/emc.py b/lib/ansible/utils/module_docs_fragments/emc.py deleted file mode 100644 index 9d75b9396d..0000000000 --- a/lib/ansible/utils/module_docs_fragments/emc.py +++ /dev/null @@ -1,43 +0,0 @@ -# -# Copyright (c) 2018, Luca 'remix_tj' Lorenzetto <lorenzetto.luca@gmail.com> -# -# This file is part of Ansible -# -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - DOCUMENTATION = """ -options: - - See respective platform section for more details -requirements: - - See respective platform section for more details -notes: - - Ansible modules are available for EMC VNX. -""" - - # Documentation fragment for VNX (emc_vnx) - EMC_VNX = """ -options: - sp_address: - description: - - Address of the SP of target/secondary storage. - required: true - sp_user: - description: - - Username for accessing SP. - default: sysadmin - required: false - sp_password: - description: - - password for accessing SP. - default: sysadmin - required: false -requirements: - - An EMC VNX Storage device. - - Ansible 2.7. - - storops (0.5.10 or greater). Install using 'pip install storops'. -notes: - - The modules prefixed with emc_vnx are built to support the EMC VNX storage platform. - """ diff --git a/lib/ansible/utils/module_docs_fragments/enos.py b/lib/ansible/utils/module_docs_fragments/enos.py deleted file mode 100644 index 128608f28e..0000000000 --- a/lib/ansible/utils/module_docs_fragments/enos.py +++ /dev/null @@ -1,88 +0,0 @@ -# (C) 2017 Red Hat Inc. -# Copyright (C) 2017 Lenovo. -# -# GNU General Public License v3.0+ -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = ''' -options: - authorize: - description: - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: 'no' - auth_pass: - description: - - Specifies the password to use if required to enter privileged mode - on the remote device. If I(authorize) is false, then this argument - does nothing. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - provider: - description: - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote device. - default: 22 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the - key used to authenticate the SSH session. If the value is not specified - in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. - authorize: - description: - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: 'no' - auth_pass: - description: - - Specifies the password to use if required to enter privileged mode - on the remote device. If I(authorize) is false, then this argument - does nothing. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. -''' diff --git a/lib/ansible/utils/module_docs_fragments/eos.py b/lib/ansible/utils/module_docs_fragments/eos.py deleted file mode 100644 index 0252d1dcd8..0000000000 --- a/lib/ansible/utils/module_docs_fragments/eos.py +++ /dev/null @@ -1,146 +0,0 @@ -# -# (c) 2015, Peter Sprygada <psprygada@ansible.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - authorize: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli) and C(become: yes)." - - This option is only required if you are using eAPI. - - For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html). - - HORIZONTALLINE - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: 'no' - auth_pass: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli) and C(become: yes) with C(become_pass)." - - This option is only required if you are using eAPI. - - For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html). - - HORIZONTALLINE - - Specifies the password to use if required to enter privileged mode - on the remote device. If I(authorize) is false, then this argument - does nothing. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - provider: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli)." - - This option is only required if you are using eAPI. - - For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html). - - HORIZONTALLINE - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote - device. This value applies to either I(cli) or I(eapi). The port - value will default to the appropriate transport common port if - none is provided in the task. (cli=22, http=80, https=443). - default: 0 (use common port) - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - either the CLI login or the eAPI authentication depending on which - transport is used. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This is a common argument used for either I(cli) - or I(eapi) transports. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH keyfile to use to authenticate the connection to - the remote device. This argument is only used for I(cli) transports. - If the value is not specified in the task, the value of environment - variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. - authorize: - description: - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: 'no' - auth_pass: - description: - - Specifies the password to use if required to enter privileged mode - on the remote device. If I(authorize) is false, then this argument - does nothing. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - transport: - description: - - Configures the transport connection to use when connecting to the - remote device. - required: true - choices: - - eapi - - cli - default: cli - use_ssl: - description: - - Configures the I(transport) to use SSL if set to true only when the - C(transport=eapi). If the transport - argument is not eapi, this value is ignored. - type: bool - default: 'yes' - validate_certs: - description: - - If C(no), SSL certificates will not be validated. This should only be used - on personally controlled sites using self-signed certificates. If the transport - argument is not eapi, this value is ignored. - type: bool - use_proxy: - description: - - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. - type: bool - default: 'yes' - version_added: "2.5" - -notes: - - For information on using CLI, eAPI and privileged mode see the :ref:`EOS Platform Options guide <eos_platform_options>` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - - For more information on using Ansible to manage Arista EOS devices see the `Arista integration page <https://www.ansible.com/ansible-arista-networks>`_. - -""" diff --git a/lib/ansible/utils/module_docs_fragments/exoscale.py b/lib/ansible/utils/module_docs_fragments/exoscale.py deleted file mode 100644 index d1352551fa..0000000000 --- a/lib/ansible/utils/module_docs_fragments/exoscale.py +++ /dev/null @@ -1,48 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright (c) 2017 René Moser <mail@renemoser.net> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard exoscale documentation fragment - DOCUMENTATION = ''' -options: - api_key: - description: - - API key of the Exoscale DNS API. - - Since 2.4, the ENV variable C(CLOUDSTACK_KEY) is used as default, when defined. - api_secret: - description: - - Secret key of the Exoscale DNS API. - - Since 2.4, the ENV variable C(CLOUDSTACK_SECRET) is used as default, when defined. - api_timeout: - description: - - HTTP timeout to Exoscale DNS API. - - Since 2.4, the ENV variable C(CLOUDSTACK_TIMEOUT) is used as default, when defined. - default: 10 - api_region: - description: - - Name of the ini section in the C(cloustack.ini) file. - - Since 2.4, the ENV variable C(CLOUDSTACK_REGION) is used as default, when defined. - default: cloudstack - validate_certs: - description: - - Validate SSL certs of the Exoscale DNS API. - default: true - type: bool -requirements: - - "python >= 2.6" -notes: - - As Exoscale DNS uses the same API key and secret for all services, we reuse the config used for Exscale Compute based on CloudStack. - The config is read from several locations, in the following order. - The C(CLOUDSTACK_KEY), C(CLOUDSTACK_SECRET) environment variables. - A C(CLOUDSTACK_CONFIG) environment variable pointing to an C(.ini) file, - A C(cloudstack.ini) file in the current working directory. - A C(.cloudstack.ini) file in the users home directory. - Optionally multiple credentials and endpoints can be specified using ini sections in C(cloudstack.ini). - Use the argument C(api_region) to select the section name, default section is C(cloudstack). - - This module does not support multiple A records and will complain properly if you try. - - More information Exoscale DNS can be found on https://community.exoscale.ch/documentation/dns/. - - This module supports check mode and diff. -''' diff --git a/lib/ansible/utils/module_docs_fragments/f5.py b/lib/ansible/utils/module_docs_fragments/f5.py deleted file mode 100644 index 798bd9ced6..0000000000 --- a/lib/ansible/utils/module_docs_fragments/f5.py +++ /dev/null @@ -1,116 +0,0 @@ -# -*- coding: utf-8 -*- -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - # Standard F5 documentation fragment - DOCUMENTATION = ''' -options: - password: - description: - - The password for the user account used to connect to the BIG-IP. - - You may omit this option by setting the environment variable C(F5_PASSWORD). - required: true - aliases: ['pass', 'pwd'] - server: - description: - - The BIG-IP host. - - You may omit this option by setting the environment variable C(F5_SERVER). - required: true - server_port: - description: - - The BIG-IP server port. - - You may omit this option by setting the environment variable C(F5_SERVER_PORT). - default: 443 - version_added: 2.2 - user: - description: - - The username to connect to the BIG-IP with. This user must have - administrative privileges on the device. - - You may omit this option by setting the environment variable C(F5_USER). - required: true - validate_certs: - description: - - If C(no), SSL certificates are not validated. Use this only - on personally controlled sites using self-signed certificates. - - You may omit this option by setting the environment variable - C(F5_VALIDATE_CERTS). - default: yes - type: bool - version_added: 2.0 - provider: - description: - - A dict object containing connection details. - default: null - version_added: 2.5 - suboptions: - password: - description: - - The password for the user account used to connect to the BIG-IP. - - You may omit this option by setting the environment variable C(F5_PASSWORD). - required: true - aliases: ['pass', 'pwd'] - server: - description: - - The BIG-IP host. - - You may omit this option by setting the environment variable C(F5_SERVER). - required: true - server_port: - description: - - The BIG-IP server port. - - You may omit this option by setting the environment variable C(F5_SERVER_PORT). - default: 443 - user: - description: - - The username to connect to the BIG-IP with. This user must have - administrative privileges on the device. - - You may omit this option by setting the environment variable C(F5_USER). - required: true - validate_certs: - description: - - If C(no), SSL certificates are not validated. Use this only - on personally controlled sites using self-signed certificates. - - You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS). - default: yes - type: bool - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH keyfile to use to authenticate the connection to - the remote device. This argument is only used for I(cli) transports. - - You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE). - transport: - description: - - Configures the transport connection to use when connecting to the - remote device. - choices: - - rest - - cli - default: rest -notes: - - For more information on using Ansible to manage F5 Networks devices see U(https://www.ansible.com/integrations/networks/f5). - - Requires BIG-IP software version >= 12. - - The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP - specific configuration persists to disk, be sure to include at least one task that uses the - M(bigip_config) module to save the running configuration. Refer to the module's documentation for - the correct usage of the module to save your running configuration. -''' diff --git a/lib/ansible/utils/module_docs_fragments/files.py b/lib/ansible/utils/module_docs_fragments/files.py deleted file mode 100644 index 75ee6c8834..0000000000 --- a/lib/ansible/utils/module_docs_fragments/files.py +++ /dev/null @@ -1,78 +0,0 @@ -# Copyright: (c) 2014, Matt Martz <matt@sivel.net> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - - # Note: mode is overridden by the copy and template modules so if you change the description - # here, you should also change it there. - DOCUMENTATION = r''' -options: - mode: - description: - - The permissions the resulting file or directory should have. - - For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers. - You must either add a leading zero so that Ansible's YAML parser knows it is an octal number - (like C(0644) or C(01777)) or quote it (like C('644') or C('1777')) so Ansible receives - a string and can do its own conversion from string into number. - - Giving Ansible a number without following one of these rules will end up with a decimal - number which will have unexpected results. - - As of version 1.8, the mode may be specified as a symbolic mode (for example, C(u+rwx) or - C(u=rw,g=r,o=r)). - - As of version 2.6, the mode may also be the special string C(preserve). - - When set to C(preserve) the file will be given the same permissions as the source file. - owner: - description: - - Name of the user that should own the file/directory, as would be fed to I(chown). - type: str - group: - description: - - Name of the group that should own the file/directory, as would be fed to I(chown). - type: str - seuser: - description: - - The user part of the SELinux file context. - - By default it uses the C(system) policy, where applicable. - - When set to C(_default), it will use the C(user) portion of the policy if available. - type: str - serole: - description: - - The role part of the SELinux file context. - - When set to C(_default), it will use the C(role) portion of the policy if available. - type: str - setype: - description: - - The type part of the SELinux file context. - - When set to C(_default), it will use the C(type) portion of the policy if available. - type: str - selevel: - description: - - The level part of the SELinux file context. - - This is the MLS/MCS attribute, sometimes known as the C(range). - - When set to C(_default), it will use the C(level) portion of the policy if available. - type: str - default: s0 - unsafe_writes: - description: - - Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file. - - By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, - but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted files, - which cannot be updated atomically from inside the container and can only be written in an unsafe manner. - - This option allows Ansible to fall back to unsafe methods of updating files when atomic operations fail - (however, it doesn't force Ansible to perform unsafe writes). - - IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. - type: bool - default: no - version_added: '2.2' - attributes: - description: - - The attributes the resulting file or directory should have. - - To get supported flags look at the man page for I(chattr) on the target system. - - This string should contain the attributes in the same order as the one displayed by I(lsattr). - - The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string. - type: str - aliases: [ attr ] - version_added: '2.3' -''' diff --git a/lib/ansible/utils/module_docs_fragments/fortios.py b/lib/ansible/utils/module_docs_fragments/fortios.py deleted file mode 100644 index d53bbc007a..0000000000 --- a/lib/ansible/utils/module_docs_fragments/fortios.py +++ /dev/null @@ -1,67 +0,0 @@ -# -# (c) 2017, Benjamin Jolivot <bjolivot@gmail.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. -# - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - file_mode: - description: - - Don't connect to any device, only use I(config_file) as input and Output. - default: false - type: bool - version_added: "2.4" - config_file: - description: - - Path to configuration file. Required when I(file_mode) is True. - version_added: "2.4" - host: - description: - - Specifies the DNS hostname or IP address for connecting to the remote fortios device. Required when I(file_mode) is False. - username: - description: - - Configures the username used to authenticate to the remote device. Required when I(file_mode) is True. - password: - description: - - Specifies the password used to authenticate to the remote device. Required when I(file_mode) is True. - timeout: - description: - - Timeout in seconds for connecting to the remote device. - default: 60 - vdom: - description: - - Specifies on which vdom to apply configuration - backup: - description: - - This argument will cause the module to create a backup of - the current C(running-config) from the remote device before any - changes are made. The backup file is written to the i(backup) - folder. - default: no - type: bool - backup_path: - description: - - Specifies where to store backup files. Required if I(backup=yes). - backup_filename: - description: - - Specifies the backup filename. If omitted filename will be - formatted like HOST_config.YYYY-MM-DD@HH:MM:SS -""" diff --git a/lib/ansible/utils/module_docs_fragments/gcp.py b/lib/ansible/utils/module_docs_fragments/gcp.py deleted file mode 100644 index e736e5d4de..0000000000 --- a/lib/ansible/utils/module_docs_fragments/gcp.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright: (c) 2018, Google Inc. -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # GCP doc fragment. - DOCUMENTATION = ''' -options: - project: - description: - - The Google Cloud Platform project to use. - default: null - auth_kind: - description: - - The type of credential used. - required: true - choices: ["machineaccount", "serviceaccount", "application"] - service_account_file: - description: - - The path of a Service Account JSON file if serviceaccount is selected as type. - service_account_email: - description: - - An optional service account email address if machineaccount is selected - and the user does not wish to use the default email. - scopes: - description: - - Array of scopes to be used. -notes: - - For authentication, you can set service_account_file using the - C(GCP_SERVICE_ACCOUNT_FILE) env variable. - - For authentication, you can set service_account_email using the - C(GCP_SERVICE_ACCOUNT_EMAIL) env variable. - - For authentication, you can set auth_kind using the C(GCP_AUTH_KIND) env - variable. - - For authentication, you can set scopes using the C(GCP_SCOPES) env variable. - - Environment variables values will only be used if the playbook values are - not set. - - The I(service_account_email) and I(service_account_file) options are - mutually exclusive. -''' diff --git a/lib/ansible/utils/module_docs_fragments/ibm_storage.py b/lib/ansible/utils/module_docs_fragments/ibm_storage.py deleted file mode 100644 index 371ef91376..0000000000 --- a/lib/ansible/utils/module_docs_fragments/ibm_storage.py +++ /dev/null @@ -1,33 +0,0 @@ -# -# Copyright (C) 2018 IBM CORPORATION -# Author(s): Tzur Eliyahu <tzure@il.ibm.com> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - -from __future__ import absolute_import, division, print_function -__metaclass__ = type - - -class ModuleDocFragment(object): - - # ibm_storage documentation fragment - DOCUMENTATION = ''' -options: - username: - description: - - Management user on the spectrum accelerate storage system. - required: True - password: - description: - - Password for username on the spectrum accelerate storage system. - required: True - endpoints: - description: - - The hostname or management IP of Spectrum Accelerate storage system. - required: True -notes: - - This module requires pyxcli python library. - Use 'pip install pyxcli' in order to get pyxcli. -requirements: - - "python >= 2.7" - - pyxcli -''' diff --git a/lib/ansible/utils/module_docs_fragments/infinibox.py b/lib/ansible/utils/module_docs_fragments/infinibox.py deleted file mode 100644 index cd3834d5e4..0000000000 --- a/lib/ansible/utils/module_docs_fragments/infinibox.py +++ /dev/null @@ -1,46 +0,0 @@ -# -# (c) 2016, Gregory Shulov <gregory.shulov@gmail.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard Infinibox documentation fragment - DOCUMENTATION = ''' -options: - system: - description: - - Infinibox Hostname or IPv4 Address. - required: true - user: - description: - - Infinibox User username with sufficient priveledges ( see notes ). - required: false - password: - description: - - Infinibox User password. - required: false -notes: - - This module requires infinisdk python library - - You must set INFINIBOX_USER and INFINIBOX_PASSWORD environment variables - if user and password arguments are not passed to the module directly - - Ansible uses the infinisdk configuration file C(~/.infinidat/infinisdk.ini) if no credentials are provided. - See U(http://infinisdk.readthedocs.io/en/latest/getting_started.html) -requirements: - - "python >= 2.7" - - infinisdk -''' diff --git a/lib/ansible/utils/module_docs_fragments/influxdb.py b/lib/ansible/utils/module_docs_fragments/influxdb.py deleted file mode 100644 index ac4c2ed781..0000000000 --- a/lib/ansible/utils/module_docs_fragments/influxdb.py +++ /dev/null @@ -1,64 +0,0 @@ -# Copyright: (c) 2017, Ansible Project -# Copyright: (c) 2017, Abhijeet Kasurde (akasurde@redhat.com) -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Parameters for influxdb modules - DOCUMENTATION = ''' -options: - hostname: - description: - - The hostname or IP address on which InfluxDB server is listening. - - Since version 2.5, defaulted to localhost. - default: localhost - username: - description: - - Username that will be used to authenticate against InfluxDB server. - - Alias C(login_username) added in version 2.5. - default: root - aliases: [ login_username ] - password: - description: - - Password that will be used to authenticate against InfluxDB server. - - Alias C(login_password) added in version 2.5. - default: root - aliases: [ login_password ] - port: - description: - - The port on which InfluxDB server is listening - default: 8086 - validate_certs: - description: - - If set to C(no), the SSL certificates will not be validated. - - This should only set to C(no) used on personally controlled sites using self-signed certificates. - default: true - version_added: "2.5" - ssl: - description: - - Use https instead of http to connect to InfluxDB server. - version_added: "2.5" - timeout: - description: - - Number of seconds Requests will wait for client to establish a connection. - version_added: "2.5" - retries: - description: - - Number of retries client will try before aborting. - - C(0) indicates try until success. - default: 3 - version_added: "2.5" - use_udp: - description: - - Use UDP to connect to InfluxDB server. - version_added: "2.5" - udp_port: - description: - - UDP port to connect to InfluxDB server. - default: 4444 - version_added: "2.5" - proxies: - description: - - HTTP(S) proxy to use for Requests to connect to InfluxDB server. - version_added: "2.5" -''' diff --git a/lib/ansible/utils/module_docs_fragments/ingate.py b/lib/ansible/utils/module_docs_fragments/ingate.py deleted file mode 100644 index 1b07d2dd5f..0000000000 --- a/lib/ansible/utils/module_docs_fragments/ingate.py +++ /dev/null @@ -1,68 +0,0 @@ -# Copyright (c) 2018, Ingate Systems AB -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - DOCUMENTATION = ''' -options: - client: - description: - - A dict object containing connection details. - suboptions: - version: - description: - - REST API version. - choices: [v1] - default: v1 - required: true - scheme: - description: - - Which HTTP protocol to use. - choices: [http, https] - required: true - address: - description: - - The hostname or IP address to the unit. - required: true - username: - description: - - The username of the REST API user. - required: true - password: - description: - - The password for the REST API user. - required: true - port: - description: - - Which HTTP(S) port to connect to. - required: false - timeout: - description: - - The timeout (in seconds) for REST API requests. - required: false - verify_ssl: - description: - - Verify the unit's HTTPS certificate. - default: true - required: false -notes: - - This module requires that the Ingate Python SDK is installed on the - host. To install the SDK use the pip command from your shell - C(pip install ingatesdk). -requirements: - - ingatesdk >= 1.0.6 -''' diff --git a/lib/ansible/utils/module_docs_fragments/inventory_cache.py b/lib/ansible/utils/module_docs_fragments/inventory_cache.py deleted file mode 100644 index 784f899ad7..0000000000 --- a/lib/ansible/utils/module_docs_fragments/inventory_cache.py +++ /dev/null @@ -1,46 +0,0 @@ -# (c) 2017 Ansible Project -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # inventory cache - DOCUMENTATION = """ -options: - cache: - description: - - Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work. - type: boolean - default: False - env: - - name: ANSIBLE_INVENTORY_CACHE - ini: - - section: inventory - key: cache - cache_plugin: - description: - - Cache plugin to use for the inventory's source data. - env: - - name: ANSIBLE_INVENTORY_CACHE_PLUGIN - ini: - - section: inventory - key: cache_plugin - cache_timeout: - description: - - Cache duration in seconds - default: 3600 - type: integer - env: - - name: ANSIBLE_INVENTORY_CACHE_TIMEOUT - ini: - - section: inventory - key: cache_timeout - cache_connection: - description: - - Cache connection data or path, read cache plugin documentation for specifics. - env: - - name: ANSIBLE_INVENTORY_CACHE_CONNECTION - ini: - - section: inventory - key: cache_connection -""" diff --git a/lib/ansible/utils/module_docs_fragments/ios.py b/lib/ansible/utils/module_docs_fragments/ios.py deleted file mode 100644 index b53aa31655..0000000000 --- a/lib/ansible/utils/module_docs_fragments/ios.py +++ /dev/null @@ -1,109 +0,0 @@ -# -# (c) 2015, Peter Sprygada <psprygada@ansible.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - authorize: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli) and C(become: yes)." - - For more information please see the L(IOS Platform Options guide, ../network/user_guide/platform_ios.html). - - HORIZONTALLINE - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: 'no' - auth_pass: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli) and C(become: yes) with C(become_pass)." - - For more information please see the L(IOS Platform Options guide, ../network/user_guide/platform_ios.html). - - HORIZONTALLINE - - Specifies the password to use if required to enter privileged mode - on the remote device. If I(authorize) is false, then this argument - does nothing. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - provider: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli)." - - For more information please see the L(IOS Platform Options guide, ../network/user_guide/platform_ios.html). - - HORIZONTALLINE - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote device. - default: 22 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the - key used to authenticate the SSH session. If the value is not specified - in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. - authorize: - description: - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: 'no' - auth_pass: - description: - - Specifies the password to use if required to enter privileged mode - on the remote device. If I(authorize) is false, then this argument - does nothing. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. -notes: - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_. -""" diff --git a/lib/ansible/utils/module_docs_fragments/iosxr.py b/lib/ansible/utils/module_docs_fragments/iosxr.py deleted file mode 100644 index c54046b2af..0000000000 --- a/lib/ansible/utils/module_docs_fragments/iosxr.py +++ /dev/null @@ -1,74 +0,0 @@ -# -# (c) 2015, Peter Sprygada <psprygada@ansible.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli)." - - For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols). - - HORIZONTALLINE - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote device. - default: 22 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the - key used to authenticate the SSH session. If the value is not specified - in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. -requirements: - - "ncclient >= 0.5.3 when using netconf" - - "lxml >= 4.1.1 when using netconf" -notes: - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_. -""" diff --git a/lib/ansible/utils/module_docs_fragments/ipa.py b/lib/ansible/utils/module_docs_fragments/ipa.py deleted file mode 100644 index d2017b7e4e..0000000000 --- a/lib/ansible/utils/module_docs_fragments/ipa.py +++ /dev/null @@ -1,62 +0,0 @@ -# Copyright (c) 2017-18, Ansible Project -# Copyright (c) 2017-18, Abhijeet Kasurde (akasurde@redhat.com) -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Parameters for FreeIPA/IPA modules - DOCUMENTATION = ''' -options: - ipa_port: - description: - - Port of FreeIPA / IPA server. - - If the value is not specified in the task, the value of environment variable C(IPA_PORT) will be used instead. - - If both the environment variable C(IPA_PORT) and the value are not specified in the task, then default value is set. - - 'Environment variable fallback mechanism is added in version 2.5.' - default: 443 - ipa_host: - description: - - IP or hostname of IPA server. - - If the value is not specified in the task, the value of environment variable C(IPA_HOST) will be used instead. - - If both the environment variable C(IPA_HOST) and the value are not specified in the task, then default value is set. - - 'Environment variable fallback mechanism is added in version 2.5.' - default: ipa.example.com - ipa_user: - description: - - Administrative account used on IPA server. - - If the value is not specified in the task, the value of environment variable C(IPA_USER) will be used instead. - - If both the environment variable C(IPA_USER) and the value are not specified in the task, then default value is set. - - 'Environment variable fallback mechanism is added in version 2.5.' - default: admin - ipa_pass: - description: - - Password of administrative user. - - If the value is not specified in the task, the value of environment variable C(IPA_PASS) will be used instead. - - If both the environment variable C(IPA_PASS) and the value are not specified in the task, then default value is set. - - 'Environment variable fallback mechanism is added in version 2.5.' - required: true - ipa_prot: - description: - - Protocol used by IPA server. - - If the value is not specified in the task, the value of environment variable C(IPA_PROT) will be used instead. - - If both the environment variable C(IPA_PROT) and the value are not specified in the task, then default value is set. - - 'Environment variable fallback mechanism is added in version 2.5.' - default: https - choices: ["http", "https"] - validate_certs: - description: - - This only applies if C(ipa_prot) is I(https). - - If set to C(no), the SSL certificates will not be validated. - - This should only set to C(no) used on personally controlled sites using self-signed certificates. - default: true - type: bool - ipa_timeout: - description: - - Specifies idle timeout (in seconds) for the connection. - - For bulk operations, you may want to increase this in order to avoid timeout from IPA server. - - If the value is not specified in the task, the value of environment variable C(IPA_TIMEOUT) will be used instead. - - If both the environment variable C(IPA_TIMEOUT) and the value are not specified in the task, then default value is set. - default: 10 - version_added: 2.7 - -''' diff --git a/lib/ansible/utils/module_docs_fragments/ironware.py b/lib/ansible/utils/module_docs_fragments/ironware.py deleted file mode 100644 index 7a57478e7d..0000000000 --- a/lib/ansible/utils/module_docs_fragments/ironware.py +++ /dev/null @@ -1,98 +0,0 @@ -# -# (c) 2017, Paul Baker <@paulquack> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - authorize: - description: - - B(Deprecated) - - "Starting with Ansible 2.7 we recommend using C(connection: network_cli) and C(become: yes)." - - For more information please see the L(IronWare Platform Options guide, ../network/user_guide/platform_ironware.html). - - HORIZONTALLINE - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: 'no' - provider: - description: - - B(Deprecated) - - "Starting with Ansible 2.7 we recommend using C(connection: network_cli) and C(become: yes)." - - For more information please see the L(IronWare Platform Options guide, ../network/user_guide/platform_ironware.html). - - HORIZONTALLINE - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - port: - description: - - Specifies the port to use when building the connection to the remote - device. - default: 22 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the - key used to authenticate the SSH session. If the value is not specified - in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. - authorize: - description: - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: 'no' - auth_pass: - description: - - Specifies the password to use if required to enter privileged mode - on the remote device. If I(authorize) is false, then this argument - does nothing. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - timeout: - description: - - Specifies idle timeout in seconds for the connection, in seconds. Useful - if the console freezes before continuing. For example when saving - configurations. - default: 10 -notes: - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` -""" diff --git a/lib/ansible/utils/module_docs_fragments/junos.py b/lib/ansible/utils/module_docs_fragments/junos.py deleted file mode 100644 index d8596862b5..0000000000 --- a/lib/ansible/utils/module_docs_fragments/junos.py +++ /dev/null @@ -1,75 +0,0 @@ -# -# (c) 2015, Peter Sprygada <psprygada@ansible.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli) or C(connection: netconf)." - - For more information please see the L(Junos OS Platform Options guide, ../network/user_guide/platform_junos.html). - - HORIZONTALLINE - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote - device. The port value will default to the well known SSH port - of 22 (for C(transport=cli)) or port 830 (for C(transport=netconf)) - device. - default: 22 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the key - used to authenticate the SSH session. If the value is not specified in - the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. -notes: - - For information on using CLI and netconf see the :ref:`Junos OS Platform Options guide <junos_platform_options>` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - - For more information on using Ansible to manage Juniper network devices see U(https://www.ansible.com/ansible-juniper). -""" diff --git a/lib/ansible/utils/module_docs_fragments/k8s_auth_options.py b/lib/ansible/utils/module_docs_fragments/k8s_auth_options.py deleted file mode 100644 index b24cbfaab9..0000000000 --- a/lib/ansible/utils/module_docs_fragments/k8s_auth_options.py +++ /dev/null @@ -1,74 +0,0 @@ -# -# Copyright 2018 Red Hat | Ansible -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - -# Options for authenticating with the API. - - -class ModuleDocFragment(object): - - DOCUMENTATION = ''' -options: - host: - description: - - Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable. - api_key: - description: - - Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable. - kubeconfig: - description: - - Path to an existing Kubernetes config file. If not provided, and no other connection - options are provided, the openshift client will attempt to load the default - configuration file from I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG environment - variable. - context: - description: - - The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable. - username: - description: - - Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment - variable. - password: - description: - - Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment - variable. - cert_file: - description: - - Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment - variable. - key_file: - description: - - Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment - variable. - ssl_ca_cert: - description: - - Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to - avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable. - verify_ssl: - description: - - "Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL - environment variable." - type: bool - -notes: - - "The OpenShift Python client wraps the K8s Python client, providing full access to - all of the APIS and models available on both platforms. For API version details and - additional information visit https://github.com/openshift/openshift-restclient-python" - - "To avoid SSL certificate validation errors when C(verify_ssl) is I(True), the full - certificate chain for the API server must be provided via C(ssl_ca_cert) or in the - kubeconfig file." -''' diff --git a/lib/ansible/utils/module_docs_fragments/k8s_name_options.py b/lib/ansible/utils/module_docs_fragments/k8s_name_options.py deleted file mode 100644 index 74e693c396..0000000000 --- a/lib/ansible/utils/module_docs_fragments/k8s_name_options.py +++ /dev/null @@ -1,54 +0,0 @@ -# -# Copyright 2018 Red Hat | Ansible -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - -# Options for selecting or identifying a specific K8s object - - -class ModuleDocFragment(object): - - DOCUMENTATION = ''' -options: - api_version: - description: - - Use to specify the API version. Use to create, delete, or discover an object without providing a full - resource definition. Use in conjunction with I(kind), I(name), and I(namespace) to identify a - specific object. If I(resource definition) is provided, the I(apiVersion) from the I(resource_definition) - will override this option. - default: v1 - aliases: - - api - - version - kind: - description: - - Use to specify an object model. Use to create, delete, or discover an object without providing a full - resource definition. Use in conjunction with I(api_version), I(name), and I(namespace) to identify a - specific object. If I(resource definition) is provided, the I(kind) from the I(resource_definition) - will override this option. - name: - description: - - Use to specify an object name. Use to create, delete, or discover an object without providing a full - resource definition. Use in conjunction with I(api_version), I(kind) and I(namespace) to identify a - specific object. If I(resource definition) is provided, the I(metadata.name) value from the - I(resource_definition) will override this option. - namespace: - description: - - Use to specify an object namespace. Useful when creating, deleting, or discovering an object without - providing a full resource definition. Use in conjunction with I(api_version), I(kind), and I(name) - to identify a specfic object. If I(resource definition) is provided, the I(metadata.namespace) value - from the I(resource_definition) will override this option. -''' diff --git a/lib/ansible/utils/module_docs_fragments/k8s_resource_options.py b/lib/ansible/utils/module_docs_fragments/k8s_resource_options.py deleted file mode 100644 index 25adb32db5..0000000000 --- a/lib/ansible/utils/module_docs_fragments/k8s_resource_options.py +++ /dev/null @@ -1,41 +0,0 @@ -# -# Copyright 2018 Red Hat | Ansible -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - -# Options for providing an object configuration - - -class ModuleDocFragment(object): - - DOCUMENTATION = ''' -options: - resource_definition: - description: - - "Provide a valid YAML definition (either as a string, list, or dict) for an object when creating or updating. NOTE: I(kind), I(api_version), I(name), - and I(namespace) will be overwritten by corresponding values found in the provided I(resource_definition)." - aliases: - - definition - - inline - src: - description: - - "Provide a path to a file containing a valid YAML definition of an object or objects to be created or updated. Mutually - exclusive with I(resource_definition). NOTE: I(kind), I(api_version), I(name), and I(namespace) will be - overwritten by corresponding values found in the configuration read in from the I(src) file." - - Reads from the local file system. To read from the Ansible controller's file system, including vaulted files, use the file lookup - plugin or template lookup plugin, combined with the from_yaml filter, and pass the result to - I(resource_definition). See Examples below. -''' diff --git a/lib/ansible/utils/module_docs_fragments/k8s_scale_options.py b/lib/ansible/utils/module_docs_fragments/k8s_scale_options.py deleted file mode 100644 index 6eef7cbb8f..0000000000 --- a/lib/ansible/utils/module_docs_fragments/k8s_scale_options.py +++ /dev/null @@ -1,51 +0,0 @@ -# -# Copyright 2018 Red Hat | Ansible -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - -# Options used by scale modules. - - -class ModuleDocFragment(object): - - DOCUMENTATION = ''' -options: - replicas: - description: - - The desired number of replicas. - current_replicas: - description: - - For Deployment, ReplicaSet, Replication Controller, only scale, if the number of existing replicas - matches. In the case of a Job, update parallelism only if the current parallelism value matches. - type: int - resource_version: - description: - - Only attempt to scale, if the current object version matches. - type: str - wait: - description: - - For Deployment, ReplicaSet, Replication Controller, wait for the status value of I(ready_replicas) to change - to the number of I(replicas). In the case of a Job, this option is ignored. - type: bool - default: true - wait_timeout: - description: - - When C(wait) is I(True), the number of seconds to wait for the I(ready_replicas) status to equal I(replicas). - If the status is not reached within the allotted time, an error will result. In the case of a Job, this option - is ignored. - type: int - default: 20 -''' diff --git a/lib/ansible/utils/module_docs_fragments/k8s_state_options.py b/lib/ansible/utils/module_docs_fragments/k8s_state_options.py deleted file mode 100644 index 660d6db98c..0000000000 --- a/lib/ansible/utils/module_docs_fragments/k8s_state_options.py +++ /dev/null @@ -1,41 +0,0 @@ -# -# Copyright 2018 Red Hat | Ansible -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - -# Options for specifying object state - - -class ModuleDocFragment(object): - - DOCUMENTATION = ''' -options: - state: - description: - - Determines if an object should be created, patched, or deleted. When set to C(present), an object will be - created, if it does not already exist. If set to C(absent), an existing object will be deleted. If set to - C(present), an existing object will be patched, if its attributes differ from those specified using - I(resource_definition) or I(src). - default: present - choices: - - present - - absent - force: - description: - - If set to C(True), and I(state) is C(present), an existing object will be replaced. - default: false - type: bool -''' diff --git a/lib/ansible/utils/module_docs_fragments/keycloak.py b/lib/ansible/utils/module_docs_fragments/keycloak.py deleted file mode 100644 index bd0c36b20b..0000000000 --- a/lib/ansible/utils/module_docs_fragments/keycloak.py +++ /dev/null @@ -1,65 +0,0 @@ -# Copyright (c) 2017 Eike Frost <ei@kefro.st> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard documentation fragment - DOCUMENTATION = ''' -options: - auth_keycloak_url: - description: - - URL to the Keycloak instance. - required: true - aliases: - - url - - auth_client_id: - description: - - OpenID Connect I(client_id) to authenticate to the API with. - default: admin-cli - required: true - - auth_realm: - description: - - Keycloak realm name to authenticate to for API access. - required: true - - auth_client_secret: - description: - - Client Secret to use in conjunction with I(auth_client_id) (if required). - - auth_username: - description: - - Username to authenticate for API access with. - required: true - aliases: - - username - - auth_password: - description: - - Password to authenticate for API access with. - required: true - aliases: - - password - - validate_certs: - description: - - Verify TLS certificates (do not disable this in production). - default: True - type: bool -''' diff --git a/lib/ansible/utils/module_docs_fragments/ldap.py b/lib/ansible/utils/module_docs_fragments/ldap.py deleted file mode 100644 index e76a2ee7b3..0000000000 --- a/lib/ansible/utils/module_docs_fragments/ldap.py +++ /dev/null @@ -1,42 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2016, Peter Sagerson <psagers@ignorare.net> -# Copyright: (c) 2016, Jiri Tyr <jiri.tyr@gmail.com> -# Copyright: (c) 2017-2018 Keller Fuchs (@KellerFuchs) <kellerfuchs@hashbang.sh> -# -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Standard LDAP documentation fragment - DOCUMENTATION = ''' -options: - bind_dn: - description: - - A DN to bind with. If this is omitted, we'll try a SASL bind with the EXTERNAL mechanism. - - If this is blank, we'll use an anonymous bind. - bind_pw: - description: - - The password to use with I(bind_dn). - dn: - required: true - description: - - The DN of the entry to add or remove. - server_uri: - default: ldapi:/// - description: - - A URI to the LDAP server. - - The default value lets the underlying LDAP client library look for a UNIX domain socket in its default location. - start_tls: - default: 'no' - type: bool - description: - - If true, we'll use the START_TLS LDAP extension. - validate_certs: - default: 'yes' - type: bool - description: - - If set to C(no), SSL certificates will not be validated. - - This should only be used on sites using self-signed certificates. - version_added: "2.4" -''' diff --git a/lib/ansible/utils/module_docs_fragments/lxca_common.py b/lib/ansible/utils/module_docs_fragments/lxca_common.py deleted file mode 100644 index cf06b85051..0000000000 --- a/lib/ansible/utils/module_docs_fragments/lxca_common.py +++ /dev/null @@ -1,63 +0,0 @@ -# This code is part of Ansible, but is an independent component. -# This particular file snippet, and this file snippet only, is BSD licensed. -# Modules you write using this snippet, which is embedded dynamically by -# Ansible still belong to the author of the module, and may assign their -# own license to the complete work. -# -# Copyright (C) 2017 Lenovo, Inc. -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# * Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# * Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. -# - - -class ModuleDocFragment(object): - # Standard Pylxca documentation fragment - DOCUMENTATION = ''' -author: - - Naval Patel (@navalkp) - - Prashant Bhosale (@prabhosa) - -options: - login_user: - description: - The username for use in HTTP basic authentication. - - required: true - - login_password: - description: - The password for use in HTTP basic authentication. - required: true - - auth_url: - description: - lxca https full web address - required: true - -requirements: - - pylxca - -notes: - - Additional detail about pylxca can be found at U(https://github.com/lenovo/pylxca) - - Playbooks using these modules can be found at U(https://github.com/lenovo/ansible.lenovo-lxca) - - Check mode is not supported. -''' diff --git a/lib/ansible/utils/module_docs_fragments/manageiq.py b/lib/ansible/utils/module_docs_fragments/manageiq.py deleted file mode 100644 index 397b65df48..0000000000 --- a/lib/ansible/utils/module_docs_fragments/manageiq.py +++ /dev/null @@ -1,38 +0,0 @@ -# (c) 2017, Daniel Korn <korndaniel1@gmail.com> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard ManageIQ documentation fragment - DOCUMENTATION = """ -options: - manageiq_connection: - required: true - description: - - ManageIQ connection configuration information. - suboptions: - url: - required: true - description: - - ManageIQ environment url. C(MIQ_URL) env var if set. otherwise, it is required to pass it. - username: - description: - - ManageIQ username. C(MIQ_USERNAME) env var if set. otherwise, required if no token is passed in. - password: - description: - - ManageIQ password. C(MIQ_PASSWORD) env var if set. otherwise, required if no token is passed in. - token: - description: - - ManageIQ token. C(MIQ_TOKEN) env var if set. otherwise, required if no username or password is passed in. - verify_ssl: - description: - - Whether SSL certificates should be verified for HTTPS requests. defaults to True. - default: true - ca_bundle_path: - description: - - The path to a CA bundle file or directory with certificates. defaults to None. - -requirements: - - 'manageiq-client U(https://github.com/ManageIQ/manageiq-api-client-python/)' -""" diff --git a/lib/ansible/utils/module_docs_fragments/meraki.py b/lib/ansible/utils/module_docs_fragments/meraki.py deleted file mode 100644 index ea4ea44339..0000000000 --- a/lib/ansible/utils/module_docs_fragments/meraki.py +++ /dev/null @@ -1,59 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2018, Kevin Breit (@kbreit) <kevin.breit@kevinbreit.net> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Standard files for documentation fragment - DOCUMENTATION = r''' -notes: -- More information about the Meraki API can be found at U(https://dashboard.meraki.com/api_docs). -- Some of the options are likely only used for developers within Meraki. -options: - auth_key: - description: - - Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set. - type: str - host: - description: - - Hostname for Meraki dashboard. - - Only useful for internal Meraki developers. - type: str - default: 'api.meraki.com' - use_proxy: - description: - - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. - type: bool - use_https: - description: - - If C(no), it will use HTTP. Otherwise it will use HTTPS. - - Only useful for internal Meraki developers. - type: bool - default: 'yes' - output_level: - description: - - Set amount of debug output during module execution - type: str - choices: [ normal, debug ] - default: normal - timeout: - description: - - Time to timeout for HTTP requests. - type: int - default: 30 - validate_certs: - description: - - Whether to validate HTTP certificates. - type: bool - default: 'yes' - org_name: - description: - - Name of organization. - type: str - aliases: [ organization ] - org_id: - description: - - ID of organization. - type: str -''' diff --git a/lib/ansible/utils/module_docs_fragments/mso.py b/lib/ansible/utils/module_docs_fragments/mso.py deleted file mode 100644 index 8add92c8c5..0000000000 --- a/lib/ansible/utils/module_docs_fragments/mso.py +++ /dev/null @@ -1,68 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2018, Dag Wieers (@dagwieers) <dag@wieers.com> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Standard files documentation fragment - DOCUMENTATION = ''' -options: - host: - description: - - IP Address or hostname of the ACI Multi Site Orchestrator host. - type: str - required: yes - aliases: [ hostname ] - port: - description: - - Port number to be used for the REST connection. - - The default value depends on parameter `use_ssl`. - type: int - username: - description: - - The username to use for authentication. - type: str - default: admin - password: - description: - - The password to use for authentication. - - This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. - type: str - required: yes - output_level: - description: - - Influence the output of this ACI module. - - C(normal) means the standard output, incl. C(current) dict - - C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts - - C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information - type: str - choices: [ debug, info, normal ] - default: normal - timeout: - description: - - The socket level timeout in seconds. - type: int - default: 30 - use_proxy: - description: - - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. - type: bool - default: yes - use_ssl: - description: - - If C(no), an HTTP connection will be used instead of the default HTTPS connection. - type: bool - default: yes - validate_certs: - description: - - If C(no), SSL certificates will not be validated. - - This should only set to C(no) when used on personally controlled sites using self-signed certificates. - type: bool - default: yes -requirements: -- Multi Site Orchestrator v2.1 or newer -notes: -- Please read the :ref:`aci_guide` for more detailed information on how to manage your ACI infrastructure using Ansible. -- This module was written to support ACI Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions. -''' diff --git a/lib/ansible/utils/module_docs_fragments/mysql.py b/lib/ansible/utils/module_docs_fragments/mysql.py deleted file mode 100644 index 58a9deac95..0000000000 --- a/lib/ansible/utils/module_docs_fragments/mysql.py +++ /dev/null @@ -1,77 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright (c) 2015 Jonathan Mainguy <jon@soh.re> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard mysql documentation fragment - DOCUMENTATION = ''' -options: - login_user: - description: - - The username used to authenticate with. - login_password: - description: - - The password used to authenticate with. - login_host: - description: - - Host running the database. - default: localhost - login_port: - description: - - Port of the MySQL server. Requires I(login_host) be defined as other than localhost if login_port is used. - default: 3306 - login_unix_socket: - description: - - The path to a Unix domain socket for local connections. - connect_timeout: - description: - - The connection timeout when connecting to the MySQL server. - default: 30 - version_added: "2.1" - config_file: - description: - - Specify a config file from which user and password are to be read. - default: '~/.my.cnf' - version_added: "2.0" - ssl_ca: - version_added: "2.0" - description: - - The path to a Certificate Authority (CA) certificate. This option, if used, must specify the same certificate - as used by the server. - ssl_cert: - version_added: "2.0" - description: - - The path to a client public key certificate. - ssl_key: - version_added: "2.0" - description: - - The path to the client private key. -requirements: - - PyMySQL (Python 2.7 and Python 3.X), or - - 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). - - 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 - default login of 'root' with no password. -''' diff --git a/lib/ansible/utils/module_docs_fragments/netapp.py b/lib/ansible/utils/module_docs_fragments/netapp.py deleted file mode 100644 index ee65e81cb6..0000000000 --- a/lib/ansible/utils/module_docs_fragments/netapp.py +++ /dev/null @@ -1,171 +0,0 @@ -# -# (c) 2018, Sumit Kumar <sumit4@netapp.com>, chris Archibald <carchi@netapp.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - DOCUMENTATION = """ -options: - - See respective platform section for more details -requirements: - - See respective platform section for more details -notes: - - Ansible modules are available for the following NetApp Storage Platforms: E-Series, ONTAP, SolidFire -""" - - # Documentation fragment for ONTAP (na_ontap) - NA_ONTAP = """ -options: - hostname: - required: true - description: - - The hostname or IP address of the ONTAP instance. - username: - required: true - description: - - This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. - For more information, please read the documentation U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/). - aliases: ['user'] - password: - required: true - description: - - Password for the specified user. - aliases: ['pass'] - https: - description: - - Enable and disable https - type: bool - default: false - validate_certs: - description: - - If set to C(False), the SSL certificates will not be validated. - - This should only set to C(False) used on personally controlled sites using self-signed certificates. - default: true - type: bool - http_port: - description: - - Override the default port (80 or 443) with this port - type: int - ontapi: - description: - - The ontap api version to use - type: int - - -requirements: - - A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward - - Ansible 2.6 - - Python2 netapp-lib (2017.10.30) or later. Install using 'pip install netapp-lib' - - Python3 netapp-lib (2018.11.13) or later. Install using 'pip install netapp-lib' - - To enable http on the cluster you must run the following commands 'set -privilege advanced;' 'system services web modify -http-enabled true;' - -notes: - - The modules prefixed with na\\_ontap are built to support the ONTAP storage platform. - - """ - - # Documentation fragment for ONTAP (na_cdot) - ONTAP = """ -options: - hostname: - required: true - description: - - The hostname or IP address of the ONTAP instance. - username: - required: true - description: - - This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. - For more information, please read the documentation U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/). - aliases: ['user'] - password: - required: true - description: - - Password for the specified user. - aliases: ['pass'] -requirements: - - A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 8.3 - - Ansible 2.2 - - netapp-lib (2015.9.25). Install using 'pip install netapp-lib' - -notes: - - The modules prefixed with na\\_cdot are built to support the ONTAP storage platform. - -""" - - # Documentation fragment for SolidFire - SOLIDFIRE = """ -options: - hostname: - required: true - description: - - The hostname or IP address of the SolidFire cluster. - username: - required: true - description: - - Please ensure that the user has the adequate permissions. For more information, please read the official documentation - U(https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US). - aliases: ['user'] - password: - required: true - description: - - Password for the specified user. - aliases: ['pass'] - -requirements: - - The modules were developed with SolidFire 10.1 - - solidfire-sdk-python (1.1.0.92) or greater. Install using 'pip install solidfire-sdk-python' - -notes: - - The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. - -""" - - # Documentation fragment for E-Series - ESERIES = """ -options: - api_username: - required: true - description: - - The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API. - api_password: - required: true - description: - - The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API. - api_url: - required: true - description: - - The url to the SANtricity Web Services Proxy or Embedded Web Services API. - example: - - https://prod-1.wahoo.acme.com/devmgr/v2 - validate_certs: - required: false - default: true - description: - - Should https certificates be validated? - type: bool - ssid: - required: true - description: - - The ID of the array to manage. This value must be unique for each array. - -notes: - - The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage - the storage-system, or an E-Series storage-system that supports the Embedded Web Services API. - - Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models. - - M(netapp_e_storage_system) may be utilized for configuring the systems managed by a WSP instance. - """ diff --git a/lib/ansible/utils/module_docs_fragments/netconf.py b/lib/ansible/utils/module_docs_fragments/netconf.py deleted file mode 100644 index b578fc31b4..0000000000 --- a/lib/ansible/utils/module_docs_fragments/netconf.py +++ /dev/null @@ -1,77 +0,0 @@ -# -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote - device. The port value will default to port 830. - type: int - default: 830 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - type: int - default: 10 - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the key - used to authenticate the SSH session. If the value is not specified in - the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. - type: path - hostkey_verify: - description: - - If set to true, the ssh host key of the device must match a ssh key present on - the host if false, the ssh host key of the device is not checked. - type: bool - default: True - look_for_keys: - description: - - Enables looking in the usual locations for the ssh keys (e.g. :file:`~/.ssh/id_*`) - type: bool - default: True -notes: - - For information on using netconf see the :ref:`Platform Options guide using Netconf<netconf_enabled_platform_options>` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` -""" diff --git a/lib/ansible/utils/module_docs_fragments/netscaler.py b/lib/ansible/utils/module_docs_fragments/netscaler.py deleted file mode 100644 index 3f47b2c32e..0000000000 --- a/lib/ansible/utils/module_docs_fragments/netscaler.py +++ /dev/null @@ -1,55 +0,0 @@ -class ModuleDocFragment(object): - DOCUMENTATION = ''' - -options: - nsip: - description: - - The ip address of the netscaler appliance where the nitro API calls will be made. - - "The port can be specified with the colon (:). E.g. 192.168.1.1:555." - required: True - - nitro_user: - description: - - The username with which to authenticate to the netscaler node. - required: True - - nitro_pass: - description: - - The password with which to authenticate to the netscaler node. - required: True - - nitro_protocol: - choices: [ 'http', 'https' ] - default: http - description: - - Which protocol to use when accessing the nitro API objects. - - validate_certs: - description: - - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. - required: false - default: 'yes' - type: bool - - nitro_timeout: - description: - - Time in seconds until a timeout error is thrown when establishing a new session with Netscaler - default: 310 - - state: - choices: ['present', 'absent'] - default: 'present' - description: - - The state of the resource being configured by the module on the netscaler node. - - When present the resource will be created if needed and configured according to the module's parameters. - - When absent the resource will be deleted from the netscaler node. - - save_config: - description: - - If true the module will save the configuration on the netscaler node if it makes any changes. - - The module will not save the configuration on the netscaler node if it made no changes. - type: bool - default: true -notes: - - For more information on using Ansible to manage Citrix NetScaler Network devices see U(https://www.ansible.com/ansible-netscaler). -''' diff --git a/lib/ansible/utils/module_docs_fragments/nios.py b/lib/ansible/utils/module_docs_fragments/nios.py deleted file mode 100644 index b05de60c1d..0000000000 --- a/lib/ansible/utils/module_docs_fragments/nios.py +++ /dev/null @@ -1,87 +0,0 @@ -# -# (c) 2015, Peter Sprygada <psprygada@ansible.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - instance of NIOS WAPI over REST - - Value can also be specified using C(INFOBLOX_HOST) environment - variable. - required: true - username: - description: - - Configures the username to use to authenticate the connection to - the remote instance of NIOS. - - Value can also be specified using C(INFOBLOX_USERNAME) environment - variable. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote instance of NIOS. - - Value can also be specified using C(INFOBLOX_PASSWORD) environment - variable. - ssl_verify: - description: - - Boolean value to enable or disable verifying SSL certificates - - Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment - variable. - type: bool - default: 'no' - http_request_timeout: - description: - - The amount of time before to wait before receiving a response - - Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment - variable. - default: 10 - max_retries: - description: - - Configures the number of attempted retries before the connection - is declared usable - - Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment - variable. - default: 3 - wapi_version: - description: - - Specifies the version of WAPI to use - - Value can also be specified using C(INFOBLOX_WAP_VERSION) environment - variable. - - Until ansible 2.8 the default WAPI was 1.4 - default: 2.1 - max_results: - description: - - Specifies the maximum number of objects to be returned, - if set to a negative number the appliance will return an error when the - number of returned objects would exceed the setting. - - Value can also be specified using C(INFOBLOX_MAX_RESULTS) environment - variable. - default: 1000 -notes: - - "This module must be run locally, which can be achieved by specifying C(connection: local)." - - Please read the :ref:`nios_guide` for more detailed information on how to use Infoblox with Ansible. - -""" diff --git a/lib/ansible/utils/module_docs_fragments/nso.py b/lib/ansible/utils/module_docs_fragments/nso.py deleted file mode 100644 index aaa16a7468..0000000000 --- a/lib/ansible/utils/module_docs_fragments/nso.py +++ /dev/null @@ -1,39 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright (c) 2017 Cisco and/or its affiliates. -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. -# - - -class ModuleDocFragment(object): - - DOCUMENTATION = ''' -options: - url: - description: NSO JSON-RPC URL, http://localhost:8080/jsonrpc - required: true - username: - description: NSO username - required: true - password: - description: NSO password - required: true - timeout: - description: JSON-RPC request timeout in seconds - default: 300 - version_added: "2.6" -''' diff --git a/lib/ansible/utils/module_docs_fragments/nxos.py b/lib/ansible/utils/module_docs_fragments/nxos.py deleted file mode 100644 index 24cc086c83..0000000000 --- a/lib/ansible/utils/module_docs_fragments/nxos.py +++ /dev/null @@ -1,118 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli)." - - This option is only required if you are using NX-API. - - For more information please see the L(NXOS Platform Options guide, ../network/user_guide/platform_nxos.html). - - HORIZONTALLINE - - A dict object containing connection details. - type: dict - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - type: str - required: true - port: - description: - - Specifies the port to use when building the connection to the remote - device. This value applies to either I(cli) or I(nxapi). The port - value will default to the appropriate transport common port if - none is provided in the task. (cli=22, http=80, https=443). - type: int - default: 0 (use common port) - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - either the CLI login or the nxapi authentication depending on which - transport is used. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - type: str - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This is a common argument used for either I(cli) - or I(nxapi) transports. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - type: str - authorize: - description: - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: no - version_added: '2.5.3' - auth_pass: - description: - - Specifies the password to use if required to enter privileged mode - on the remote device. If I(authorize) is false, then this argument - does nothing. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. - type: str - version_added: '2.5.3' - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc). - type: int - default: 10 - version_added: '2.3' - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This argument is only used for the I(cli) - transport. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. - type: str - transport: - description: - - Configures the transport connection to use when connecting to the - remote device. The transport argument supports connectivity to the - device over cli (ssh) or nxapi. - type: str - required: true - default: cli - use_ssl: - description: - - Configures the I(transport) to use SSL if set to true only when the - C(transport=nxapi), otherwise this value is ignored. - type: bool - default: no - validate_certs: - description: - - If C(no), SSL certificates will not be validated. This should only be used - on personally controlled sites using self-signed certificates. If the transport - argument is not nxapi, this value is ignored. - type: bool - default: yes - use_proxy: - description: - - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. - type: bool - default: yes - version_added: "2.5" - -notes: - - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>` - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - - For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_. -""" diff --git a/lib/ansible/utils/module_docs_fragments/oneview.py b/lib/ansible/utils/module_docs_fragments/oneview.py deleted file mode 100644 index 73b2eb6548..0000000000 --- a/lib/ansible/utils/module_docs_fragments/oneview.py +++ /dev/null @@ -1,66 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright (2016-2017) Hewlett Packard Enterprise Development LP -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # OneView doc fragment - DOCUMENTATION = ''' -options: - config: - description: - - Path to a .json configuration file containing the OneView client configuration. - The configuration file is optional and when used should be present in the host running the ansible commands. - If the file path is not provided, the configuration will be loaded from environment variables. - For links to example configuration files or how to use the environment variables verify the notes section. - -requirements: - - python >= 2.7.9 - -notes: - - "A sample configuration file for the config parameter can be found at: - U(https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json)" - - "Check how to use environment variables for configuration at: - U(https://github.com/HewlettPackard/oneview-ansible#environment-variables)" - - "Additional Playbooks for the HPE OneView Ansible modules can be found at: - U(https://github.com/HewlettPackard/oneview-ansible/tree/master/examples)" - - "The OneView API version used will directly affect returned and expected fields in resources. - Information on setting the desired API version and can be found at: - U(https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version)" - ''' - - VALIDATEETAG = ''' -options: - validate_etag: - description: - - When the ETag Validation is enabled, the request will be conditionally processed only if the current ETag - for the resource matches the ETag provided in the data. - default: true - type: bool -''' - - FACTSPARAMS = ''' -options: - params: - description: - - List of params to delimit, filter and sort the list of resources. - - "params allowed: - - C(start): The first item to return, using 0-based indexing. - - C(count): The number of resources to return. - - C(filter): A general filter/query string to narrow the list of items returned. - - C(sort): The sort order of the returned data set." -''' diff --git a/lib/ansible/utils/module_docs_fragments/online.py b/lib/ansible/utils/module_docs_fragments/online.py deleted file mode 100644 index b5303a2ef6..0000000000 --- a/lib/ansible/utils/module_docs_fragments/online.py +++ /dev/null @@ -1,36 +0,0 @@ -# -*- coding: utf-8 -*- -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard documentation fragment - DOCUMENTATION = ''' -options: - api_token: - description: - - Online OAuth token. - aliases: ['oauth_token'] - api_url: - description: - - Online API URL - default: 'https://api.online.net' - aliases: ['base_url'] - api_timeout: - description: - - HTTP timeout to Online API in seconds. - default: 30 - aliases: ['timeout'] - validate_certs: - description: - - Validate SSL certs of the Online API. - default: yes - type: bool -notes: - - Also see the API documentation on U(https://console.online.net/en/api/) - - If C(api_token) is not set within the module, the following - environment variables can be used in decreasing order of precedence - C(ONLINE_TOKEN), C(ONLINE_API_KEY), C(ONLINE_OAUTH_TOKEN), C(ONLINE_API_TOKEN) - - If one wants to use a different C(api_url) one can also set the C(ONLINE_API_URL) - environment variable. -''' diff --git a/lib/ansible/utils/module_docs_fragments/onyx.py b/lib/ansible/utils/module_docs_fragments/onyx.py deleted file mode 100644 index 0cc80cee97..0000000000 --- a/lib/ansible/utils/module_docs_fragments/onyx.py +++ /dev/null @@ -1,77 +0,0 @@ -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote device. - default: 22 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the - key used to authenticate the SSH session. If the value is not specified - in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. - authorize: - description: - - Instructs the module to enter privileged mode on the remote device - before sending any commands. If not specified, the device will - attempt to execute all commands in non-privileged mode. If the value - is not specified in the task, the value of environment variable - C(ANSIBLE_NET_AUTHORIZE) will be used instead. - type: bool - default: 'no' - auth_pass: - description: - - Specifies the password to use if required to enter privileged mode - on the remote device. If I(authorize) is false, then this argument - does nothing. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. -""" diff --git a/lib/ansible/utils/module_docs_fragments/opennebula.py b/lib/ansible/utils/module_docs_fragments/opennebula.py deleted file mode 100644 index 233d036a78..0000000000 --- a/lib/ansible/utils/module_docs_fragments/opennebula.py +++ /dev/null @@ -1,37 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright 2018 www.privaz.io Valletech AB -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # OpenNebula common documentation - DOCUMENTATION = ''' -options: - api_url: - description: - - The ENDPOINT URL of the XMLRPC server. - If not specified then the value of the ONE_URL environment variable, if any, is used. - aliases: - - api_endpoint - api_username: - description: - - The name of the user for XMLRPC authentication. - If not specified then the value of the ONE_USERNAME environment variable, if any, is used. - api_password: - description: - - The password or token for XMLRPC authentication. - If not specified then the value of the ONE_PASSWORD environment variable, if any, is used. - aliases: - - api_token - validate_certs: - description: - - Whether to validate the SSL certificates or not. - This parameter is ignored if PYTHONHTTPSVERIFY environment variable is used. - type: bool - default: true - wait_timeout: - description: - - time to wait for the desired state to be reached before timeout, in seconds. - default: 300 -''' diff --git a/lib/ansible/utils/module_docs_fragments/openstack.py b/lib/ansible/utils/module_docs_fragments/openstack.py deleted file mode 100644 index 9bcc2b7ed5..0000000000 --- a/lib/ansible/utils/module_docs_fragments/openstack.py +++ /dev/null @@ -1,109 +0,0 @@ -# Copyright (c) 2014 Hewlett-Packard Development Company, L.P. -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard openstack documentation fragment - DOCUMENTATION = ''' -options: - cloud: - description: - - Named cloud or cloud config to operate against. - If I(cloud) is a string, it references a named cloud config as defined - in an OpenStack clouds.yaml file. Provides default values for I(auth) - and I(auth_type). This parameter is not needed if I(auth) is provided - or if OpenStack OS_* environment variables are present. - If I(cloud) is a dict, it contains a complete cloud configuration like - would be in a section of clouds.yaml. - required: false - auth: - description: - - Dictionary containing auth information as needed by the cloud's auth - plugin strategy. For the default I(password) plugin, this would contain - I(auth_url), I(username), I(password), I(project_name) and any - information about domains if the cloud supports them. For other plugins, - this param will need to contain whatever parameters that auth plugin - requires. This parameter is not needed if a named cloud is provided or - OpenStack OS_* environment variables are present. - required: false - auth_type: - description: - - Name of the auth plugin to use. If the cloud uses something other than - password authentication, the name of the plugin should be indicated here - and the contents of the I(auth) parameter should be updated accordingly. - required: false - region_name: - description: - - Name of the region. - required: false - wait: - description: - - Should ansible wait until the requested resource is complete. - type: bool - required: false - default: true - timeout: - description: - - How long should ansible wait for the requested resource. - required: false - default: 180 - api_timeout: - description: - - How long should the socket layer wait before timing out for API calls. - If this is omitted, nothing will be passed to the requests library. - required: false - verify: - description: - - Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True. - type: bool - required: false - aliases: ['validate_certs'] - cacert: - description: - - A path to a CA Cert bundle that can be used as part of verifying - SSL API requests. - required: false - cert: - description: - - A path to a client certificate to use as part of the SSL transaction. - required: false - key: - description: - - A path to a client key to use as part of the SSL transaction. - required: false - interface: - description: - - Endpoint URL type to fetch from the service catalog. - choices: [public, internal, admin] - required: false - default: public - aliases: ['endpoint_type'] - version_added: "2.3" -requirements: - - python >= 2.7 - - openstacksdk -notes: - - The standard OpenStack environment variables, such as C(OS_USERNAME) - may be used instead of providing explicit values. - - Auth information is driven by openstacksdk, which means that values - can come from a yaml config file in /etc/ansible/openstack.yaml, - /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from - standard environment variables, then finally by explicit parameters in - plays. More information can be found at - U(https://docs.openstack.org/openstacksdk/) -''' diff --git a/lib/ansible/utils/module_docs_fragments/openswitch.py b/lib/ansible/utils/module_docs_fragments/openswitch.py deleted file mode 100644 index b0dfaec342..0000000000 --- a/lib/ansible/utils/module_docs_fragments/openswitch.py +++ /dev/null @@ -1,88 +0,0 @@ -# -# (c) 2015, Peter Sprygada <psprygada@ansible.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. Note this argument - does not affect the SSH argument. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote - device. This value applies to either I(cli) or I(rest). The port - value will default to the appropriate transport common port if - none is provided in the task. (cli=22, http=80, https=443). Note - this argument does not affect the SSH transport. - default: 0 (use common port) - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - either the CLI login or the eAPI authentication depending on which - transport is used. Note this argument does not affect the SSH - transport. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This is a common argument used for either I(cli) - or I(rest) transports. Note this argument does not affect the SSH - transport. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This argument is only used for the I(cli) - transports. If the value is not specified in the task, the value of - environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. - transport: - description: - - Configures the transport connection to use when connecting to the - remote device. The transport argument supports connectivity to the - device over ssh, cli or REST. - required: true - default: ssh - choices: ['ssh', 'cli', 'rest'] - use_ssl: - description: - - Configures the I(transport) to use SSL if set to true only when the - I(transport) argument is configured as rest. If the transport - argument is not I(rest), this value is ignored. - type: bool - default: 'yes' - provider: - description: - - Convenience method that allows all I(openswitch) arguments to be passed as - a dict object. All constraints (required, choices, etc) must be - met either by individual arguments or values in this dict. - -""" diff --git a/lib/ansible/utils/module_docs_fragments/ovirt.py b/lib/ansible/utils/module_docs_fragments/ovirt.py deleted file mode 100644 index bcea8d433c..0000000000 --- a/lib/ansible/utils/module_docs_fragments/ovirt.py +++ /dev/null @@ -1,83 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright (c) 2016 Red Hat, Inc. -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. -# - - -class ModuleDocFragment(object): - - # Standard oVirt documentation fragment - DOCUMENTATION = ''' -options: - wait: - description: - - "I(True) if the module should wait for the entity to get into desired state." - default: true - type: bool - fetch_nested: - description: - - "If I(True) the module will fetch additional data from the API." - - "It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other - attributes of the nested entities by specifying C(nested_attributes)." - version_added: "2.3" - type: bool - nested_attributes: - description: - - "Specifies list of the attributes which should be fetched from the API." - - "This parameter apply only when C(fetch_nested) is I(true)." - version_added: "2.3" - auth: - required: True - description: - - "Dictionary with values needed to create HTTP/HTTPS connection to oVirt:" - - C(username)[I(required)] - The name of the user, something like I(admin@internal). - Default value is set by I(OVIRT_USERNAME) environment variable. - - "C(password)[I(required)] - The password of the user. Default value is set by I(OVIRT_PASSWORD) environment variable." - - "C(url) - A string containing the API URL of the server, usually - something like `I(https://server.example.com/ovirt-engine/api)`. Default value is set by I(OVIRT_URL) environment variable. - Either C(url) or C(hostname) is required." - - "C(hostname) - A string containing the hostname of the server, usually - something like `I(server.example.com)`. Default value is set by I(OVIRT_HOSTNAME) environment variable. - Either C(url) or C(hostname) is required." - - "C(token) - Token to be used instead of login with username/password. Default value is set by I(OVIRT_TOKEN) environment variable." - - "C(insecure) - A boolean flag that indicates if the server TLS - certificate and host name should be checked." - - "C(ca_file) - A PEM file containing the trusted CA certificates. The - certificate presented by the server will be verified using these CA - certificates. If `C(ca_file)` parameter is not set, system wide - CA certificate store is used. Default value is set by I(OVIRT_CAFILE) environment variable." - - "C(kerberos) - A boolean flag indicating if Kerberos authentication - should be used instead of the default basic authentication." - - "C(headers) - Dictionary of HTTP headers to be added to each API call." - timeout: - description: - - "The amount of time in seconds the module should wait for the instance to - get into desired state." - default: 180 - poll_interval: - description: - - "Number of the seconds the module waits until another poll request on entity status is sent." - default: 3 -requirements: - - python >= 2.7 - - ovirt-engine-sdk-python >= 4.2.4 -notes: - - "In order to use this module you have to install oVirt Python SDK. - To ensure it's installed with correct version you can create the following task: - I(pip: name=ovirt-engine-sdk-python version=4.2.4)" -''' diff --git a/lib/ansible/utils/module_docs_fragments/ovirt_facts.py b/lib/ansible/utils/module_docs_fragments/ovirt_facts.py deleted file mode 100644 index 564898ef55..0000000000 --- a/lib/ansible/utils/module_docs_fragments/ovirt_facts.py +++ /dev/null @@ -1,69 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright (c) 2016 Red Hat, Inc. -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. -# - - -class ModuleDocFragment(object): - - # facts standard oVirt documentation fragment - DOCUMENTATION = ''' -options: - fetch_nested: - description: - - "If I(True) the module will fetch additional data from the API." - - "It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other - attributes of the nested entities by specifying C(nested_attributes)." - version_added: "2.3" - type: bool - nested_attributes: - description: - - "Specifies list of the attributes which should be fetched from the API." - - "This parameter apply only when C(fetch_nested) is I(true)." - version_added: "2.3" - auth: - required: True - description: - - "Dictionary with values needed to create HTTP/HTTPS connection to oVirt:" - - C(username)[I(required)] - The name of the user, something like I(admin@internal). - Default value is set by I(OVIRT_USERNAME) environment variable. - - "C(password)[I(required)] - The password of the user. Default value is set by I(OVIRT_PASSWORD) environment variable." - - "C(url)- A string containing the API URL of the server, usually - something like `I(https://server.example.com/ovirt-engine/api)`. Default value is set by I(OVIRT_URL) environment variable. - Either C(url) or C(hostname) is required." - - "C(hostname) - A string containing the hostname of the server, usually - something like `I(server.example.com)`. Default value is set by I(OVIRT_HOSTNAME) environment variable. - Either C(url) or C(hostname) is required." - - "C(token) - Token to be used instead of login with username/password. Default value is set by I(OVIRT_TOKEN) environment variable." - - "C(insecure) - A boolean flag that indicates if the server TLS - certificate and host name should be checked." - - "C(ca_file) - A PEM file containing the trusted CA certificates. The - certificate presented by the server will be verified using these CA - certificates. If `C(ca_file)` parameter is not set, system wide - CA certificate store is used. Default value is set by I(OVIRT_CAFILE) environment variable." - - "C(kerberos) - A boolean flag indicating if Kerberos authentication - should be used instead of the default basic authentication." - - "C(headers) - Dictionary of HTTP headers to be added to each API call." -requirements: - - python >= 2.7 - - ovirt-engine-sdk-python >= 4.2.4 -notes: - - "In order to use this module you have to install oVirt Python SDK. - To ensure it's installed with correct version you can create the following task: - pip: name=ovirt-engine-sdk-python version=4.2.4" -''' diff --git a/lib/ansible/utils/module_docs_fragments/panos.py b/lib/ansible/utils/module_docs_fragments/panos.py deleted file mode 100644 index eb666699f4..0000000000 --- a/lib/ansible/utils/module_docs_fragments/panos.py +++ /dev/null @@ -1,25 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2016, techbizdev <techbizdev@paloaltonetworks.com> -# Copyright: (c) 2018, Kevin Breit (@kbreit) - -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Standard files documentation fragment - DOCUMENTATION = ''' -options: - ip_address: - description: - - IP address (or hostname) of PAN-OS device. - required: true - password: - description: - - Password for authentication. - required: true - username: - description: - - Username for authentication. - default: "admin" -''' diff --git a/lib/ansible/utils/module_docs_fragments/postgres.py b/lib/ansible/utils/module_docs_fragments/postgres.py deleted file mode 100644 index 5068ea064f..0000000000 --- a/lib/ansible/utils/module_docs_fragments/postgres.py +++ /dev/null @@ -1,59 +0,0 @@ -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - # Postgres documentation fragment - DOCUMENTATION = """ -options: - login_user: - description: - - The username used to authenticate with - default: postgres - login_password: - description: - - The password used to authenticate with - login_host: - description: - - Host running the database - login_unix_socket: - description: - - Path to a Unix domain socket for local connections - port: - description: - - Database port to connect to. - default: 5432 - ssl_mode: - description: - - Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server. - - See https://www.postgresql.org/docs/current/static/libpq-ssl.html for more information on the modes. - - Default of C(prefer) matches libpq default. - default: prefer - choices: [disable, allow, prefer, require, verify-ca, verify-full] - version_added: '2.3' - ssl_rootcert: - description: - - Specifies the name of a file containing SSL certificate authority (CA) certificate(s). - - If the file exists, the server's certificate will be verified to be signed by one of these authorities. - version_added: '2.3' -notes: -- The default authentication assumes that you are either logging in as or sudo'ing to the C(postgres) account on the host. -- This module uses I(psycopg2), a Python PostgreSQL database adapter. You must ensure that psycopg2 is installed on - the host before using this module. If the remote host is the PostgreSQL server (which is the default case), then - PostgreSQL must also be installed on the remote host. For Ubuntu-based systems, install the C(postgresql), C(libpq-dev), - and C(python-psycopg2) packages on the remote host before using this module. -- The ssl_rootcert parameter requires at least Postgres version 8.4 and I(psycopg2) version 2.4.3. -requirements: [ psycopg2 ] -""" diff --git a/lib/ansible/utils/module_docs_fragments/proxysql.py b/lib/ansible/utils/module_docs_fragments/proxysql.py deleted file mode 100644 index ad65911cf9..0000000000 --- a/lib/ansible/utils/module_docs_fragments/proxysql.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright: (c) 2017, Ansible Project -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt - - -class ModuleDocFragment(object): - - # Documentation fragment for ProxySQL connectivity - CONNECTIVITY = ''' -options: - login_user: - description: - - The username used to authenticate to ProxySQL admin interface. - login_password: - description: - - The password used to authenticate to ProxySQL admin interface. - login_host: - description: - - The host used to connect to ProxySQL admin interface. - default: '127.0.0.1' - login_port: - description: - - The port used to connect to ProxySQL admin interface. - default: 6032 - config_file: - description: - - Specify a config file from which I(login_user) and I(login_password) - are to be read. - default: '' -requirements: - - PyMySQL (Python 2.7 and Python 3.X), or - - MySQLdb (Python 2.x) -''' - - # Documentation fragment for managing ProxySQL configuration - MANAGING_CONFIG = ''' -options: - save_to_disk: - description: - - Save config to sqlite db on disk to persist the configuration. - type: bool - default: 'yes' - load_to_runtime: - description: - - Dynamically load config to runtime memory. - type: bool - default: 'yes' -''' diff --git a/lib/ansible/utils/module_docs_fragments/purestorage.py b/lib/ansible/utils/module_docs_fragments/purestorage.py deleted file mode 100644 index 8e780c5b3a..0000000000 --- a/lib/ansible/utils/module_docs_fragments/purestorage.py +++ /dev/null @@ -1,68 +0,0 @@ -# -# (c) 2017, Simon Dodsley <simon@purestorage.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard Pure Storage documentation fragment - DOCUMENTATION = ''' -options: - - See separate platform section for more details -requirements: - - See separate platform section for more details -notes: - - Ansible modules are available for the following Pure Storage products: FlashArray, FlashBlade -''' - - # Documentation fragment for FlashBlade - FB = ''' -options: - fb_url: - description: - - FlashBlade management IP address or Hostname. - api_token: - description: - - FlashBlade API token for admin privileged user. -notes: - - This module requires the ``purity_fb`` Python library - - You must set C(PUREFB_URL) and C(PUREFB_API) environment variables - if I(fb_url) and I(api_token) arguments are not passed to the module directly -requirements: - - "python >= 2.7" - - "purity_fb >= 1.1" -''' - - # Documentation fragment for FlashArray - FA = ''' -options: - fa_url: - description: - - FlashArray management IPv4 address or Hostname. - required: true - api_token: - description: - - FlashArray API token for admin privileged user. - required: true -notes: - - This module requires the ``purestorage`` Python library - - You must set C(PUREFA_URL) and C(PUREFA_API) environment variables - if I(fa_url) and I(api_token) arguments are not passed to the module directly -requirements: - - "python >= 2.7" - - purestorage -''' diff --git a/lib/ansible/utils/module_docs_fragments/rabbitmq.py b/lib/ansible/utils/module_docs_fragments/rabbitmq.py deleted file mode 100644 index 87c52346d6..0000000000 --- a/lib/ansible/utils/module_docs_fragments/rabbitmq.py +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright: (c) 2016, Jorge Rodriguez <jorge.rodriguez@tiriel.eu> - -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Parameters for RabbitMQ modules - DOCUMENTATION = ''' -options: - login_user: - description: - - rabbitMQ user for connection. - required: false - default: guest - login_password: - description: - - rabbitMQ password for connection. - required: false - default: false - login_host: - description: - - rabbitMQ host for connection. - required: false - default: localhost - login_port: - description: - - rabbitMQ management API port. - required: false - default: 15672 - login_protocol: - description: - - rabbitMQ management API protocol. - choices: [ http , https ] - required: false - default: http - version_added: "2.3" - cacert: - description: - - CA certificate to verify SSL connection to management API. - required: false - version_added: "2.3" - cert: - description: - - Client certificate to send on SSL connections to management API. - required: false - version_added: "2.3" - key: - description: - - Private key matching the client certificate. - required: false - version_added: "2.3" - vhost: - description: - - rabbitMQ virtual host. - required: false - default: "/" -''' diff --git a/lib/ansible/utils/module_docs_fragments/rackspace.py b/lib/ansible/utils/module_docs_fragments/rackspace.py deleted file mode 100644 index c3312f75b2..0000000000 --- a/lib/ansible/utils/module_docs_fragments/rackspace.py +++ /dev/null @@ -1,123 +0,0 @@ -# (c) 2014, Matt Martz <matt@sivel.net> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard Rackspace only documentation fragment - DOCUMENTATION = """ -options: - api_key: - description: - - Rackspace API key, overrides I(credentials). - aliases: - - password - credentials: - description: - - File to find the Rackspace credentials in. Ignored if I(api_key) and - I(username) are provided. - aliases: - - creds_file - env: - description: - - Environment as configured in I(~/.pyrax.cfg), - see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration). - version_added: 1.5 - region: - description: - - Region to create an instance in. - default: DFW - username: - description: - - Rackspace username, overrides I(credentials). - verify_ssl: - description: - - Whether or not to require SSL validation of API endpoints. - version_added: 1.5 -requirements: - - "python >= 2.6" - - pyrax -notes: - - The following environment variables can be used, C(RAX_USERNAME), - C(RAX_API_KEY), C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION). - - C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file - appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating) - - C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file - - C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) -""" - - # Documentation fragment including attributes to enable communication - # of other OpenStack clouds. Not all rax modules support this. - OPENSTACK = """ -options: - api_key: - description: - - Rackspace API key, overrides I(credentials). - aliases: - - password - auth_endpoint: - description: - - The URI of the authentication service. - default: https://identity.api.rackspacecloud.com/v2.0/ - version_added: 1.5 - credentials: - description: - - File to find the Rackspace credentials in. Ignored if I(api_key) and - I(username) are provided. - aliases: - - creds_file - env: - description: - - Environment as configured in I(~/.pyrax.cfg), - see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration). - version_added: 1.5 - identity_type: - description: - - Authentication mechanism to use, such as rackspace or keystone. - default: rackspace - version_added: 1.5 - region: - description: - - Region to create an instance in. - default: DFW - tenant_id: - description: - - The tenant ID used for authentication. - version_added: 1.5 - tenant_name: - description: - - The tenant name used for authentication. - version_added: 1.5 - username: - description: - - Rackspace username, overrides I(credentials). - verify_ssl: - description: - - Whether or not to require SSL validation of API endpoints. - version_added: 1.5 - type: bool -requirements: - - "python >= 2.6" - - pyrax -notes: - - The following environment variables can be used, C(RAX_USERNAME), - C(RAX_API_KEY), C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION). - - C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file - appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating) - - C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file - - C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) -""" diff --git a/lib/ansible/utils/module_docs_fragments/return_common.py b/lib/ansible/utils/module_docs_fragments/return_common.py deleted file mode 100644 index 998e1a0558..0000000000 --- a/lib/ansible/utils/module_docs_fragments/return_common.py +++ /dev/null @@ -1,53 +0,0 @@ -# Copyright (c) 2016 Ansible, Inc -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard documentation fragment - RETURN = ''' -changed: - description: Whether the module affected changes on the target. - returned: always - type: bool - sample: False -failed: - description: Whether the module failed to execute. - returned: always - type: bool - sample: True -msg: - description: Human-readable message. - returned: as needed - type: string - sample: "all ok" -skipped: - description: Whether the module was skipped. - returned: always - type: bool - sample: False -results: - description: List of module results, - returned: when using a loop. - type: list - sample: [{changed: True, msg: 'first item changed'}, {changed: False, msg: 'second item ok'}] -exception: - description: Optional information from a handled error. - returned: on some errors - type: string - sample: 'Unknown error' -''' diff --git a/lib/ansible/utils/module_docs_fragments/scaleway.py b/lib/ansible/utils/module_docs_fragments/scaleway.py deleted file mode 100644 index b21cad2aa1..0000000000 --- a/lib/ansible/utils/module_docs_fragments/scaleway.py +++ /dev/null @@ -1,42 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright (C) 2018 Yanis Guenane <yanis+ansible@guenane.org> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard documentation fragment - DOCUMENTATION = ''' -options: - api_token: - description: - - Scaleway OAuth token. - aliases: ['oauth_token'] - api_url: - description: - - Scaleway API URL - default: 'https://api.scaleway.com' - aliases: ['base_url'] - api_timeout: - description: - - HTTP timeout to Scaleway API in seconds. - default: 30 - aliases: ['timeout'] - query_parameters: - description: - - List of parameters passed to the query string - type: dict - default: {} - validate_certs: - description: - - Validate SSL certs of the Scaleway API. - default: yes - type: bool -notes: - - Also see the API documentation on U(https://developer.scaleway.com/) - - If C(api_token) is not set within the module, the following - environment variables can be used in decreasing order of precedence - C(SCW_TOKEN), C(SCW_API_KEY), C(SCW_OAUTH_TOKEN) or C(SCW_API_TOKEN). - - If one wants to use a different C(api_url) one can also set the C(SCW_API_URL) - environment variable. -''' diff --git a/lib/ansible/utils/module_docs_fragments/shell_common.py b/lib/ansible/utils/module_docs_fragments/shell_common.py deleted file mode 100644 index d3b78e12ac..0000000000 --- a/lib/ansible/utils/module_docs_fragments/shell_common.py +++ /dev/null @@ -1,61 +0,0 @@ -# Copyright (c) 2017 Ansible Project -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # common shelldocumentation fragment - DOCUMENTATION = """ -options: - remote_tmp: - description: - - Temporary directory to use on targets when executing tasks. - default: '~/.ansible/tmp' - env: [{name: ANSIBLE_REMOTE_TEMP}, {name: ANSIBLE_REMOTE_TMP}] - ini: - - section: defaults - key: remote_tmp - vars: - - name: ansible_remote_tmp - system_tmpdirs: - description: - - "List of valid system temporary directories for Ansible to choose when it cannot use - ``remote_tmp``, normally due to permission issues. These must be world readable, writable, - and executable." - default: [ /var/tmp, /tmp ] - type: list - env: [{name: ANSIBLE_SYSTEM_TMPDIRS}] - ini: - - section: defaults - key: system_tmpdirs - vars: - - name: ansible_system_tmpdirs - async_dir: - description: - - Directory in which ansible will keep async job information - default: '~/.ansible_async' - env: [{name: ANSIBLE_ASYNC_DIR}] - ini: - - section: defaults - key: async_dir - vars: - - name: ansible_async_dir - environment: - type: dict - default: {} - description: - - dictionary of environment variables and their values to use when executing commands. - admin_users: - type: list - default: ['root', 'toor'] - description: - - list of users to be expected to have admin privileges. This is used by the controller to - determine how to share temporary files between the remote user and the become user. - env: - - name: ANSIBLE_ADMIN_USERS - ini: - - section: defaults - key: admin_users - vars: - - name: ansible_admin_users -""" diff --git a/lib/ansible/utils/module_docs_fragments/sros.py b/lib/ansible/utils/module_docs_fragments/sros.py deleted file mode 100644 index 667e9800eb..0000000000 --- a/lib/ansible/utils/module_docs_fragments/sros.py +++ /dev/null @@ -1,67 +0,0 @@ -# -# (c) 2015, Peter Sprygada <psprygada@ansible.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote - device. - default: 22 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the - key used to authenticate the SSH session. If the value is not specified - in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. -notes: - - For more information on using Ansible to manage Nokia SR OS Network devices see U(https://www.ansible.com/ansible-nokia). -""" diff --git a/lib/ansible/utils/module_docs_fragments/tower.py b/lib/ansible/utils/module_docs_fragments/tower.py deleted file mode 100644 index 8e51af57c3..0000000000 --- a/lib/ansible/utils/module_docs_fragments/tower.py +++ /dev/null @@ -1,55 +0,0 @@ -# (c) 2017, Wayne Witzel III <wayne@riotousliving.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. -# - - -class ModuleDocFragment(object): - - # Ansible Tower documentation fragment - DOCUMENTATION = ''' -options: - tower_host: - description: - - URL to your Tower instance. - tower_username: - description: - - Username for your Tower instance. - tower_password: - description: - - Password for your Tower instance. - tower_verify_ssl: - description: - - Dis/allow insecure connections to Tower. If C(no), SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates. - type: bool - default: 'yes' - tower_config_file: - description: - - Path to the Tower config file. See notes. - - -requirements: - - "ansible-tower-cli >= 3.0.2" - -notes: - - If no I(config_file) is provided we will attempt to use the tower-cli library - defaults to find your Tower host information. - - I(config_file) should contain Tower configuration in the following format - host=hostname - username=username - password=password -''' diff --git a/lib/ansible/utils/module_docs_fragments/ucs.py b/lib/ansible/utils/module_docs_fragments/ucs.py deleted file mode 100644 index 4555e457ba..0000000000 --- a/lib/ansible/utils/module_docs_fragments/ucs.py +++ /dev/null @@ -1,71 +0,0 @@ -# -*- coding: utf-8 -*- - -# This code is part of Ansible, but is an independent component. -# This particular file snippet, and this file snippet only, is BSD licensed. -# Modules you write using this snippet, which is embedded dynamically by Ansible -# still belong to the author of the module, and may assign their own license -# to the complete work. -# -# (c) 2016 Red Hat Inc. -# (c) 2017 Cisco Systems Inc. -# -# Redistribution and use in source and binary forms, with or without modification, -# are permitted provided that the following conditions are met: -# -# * Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# * Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. -# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, -# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, -# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE -# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -# - - -class ModuleDocFragment(object): - # Cisco UCS doc fragment - DOCUMENTATION = ''' -options: - hostname: - description: - - IP address or hostname of Cisco UCS Manager. - type: str - required: yes - username: - description: - - Username for Cisco UCS Manager authentication. - type: str - default: admin - password: - description: - - Password for Cisco UCS Manager authentication. - type: str - required: yes - port: - description: - - Port number to be used during connection (by default uses 443 for https and 80 for http connection). - type: int - use_ssl: - description: - - If C(no), an HTTP connection will be used instead of the default HTTPS connection. - type: bool - default: yes - use_proxy: - description: - - If C(no), will not use the proxy as defined by system environment variable. - type: bool - default: yes - proxy: - description: - - If use_proxy is no, specfies proxy to be used for connection. - e.g. 'http://proxy.xy.z:8080' - type: str -''' diff --git a/lib/ansible/utils/module_docs_fragments/url.py b/lib/ansible/utils/module_docs_fragments/url.py deleted file mode 100644 index d4f7fe4e95..0000000000 --- a/lib/ansible/utils/module_docs_fragments/url.py +++ /dev/null @@ -1,64 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2018, John Barker <gundalow@redhat.com> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = r''' -options: - url: - description: - - HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path - type: str - force: - description: - - If C(yes) do not get a cached copy. - aliases: - - thirsty - type: bool - default: no - http_agent: - description: - - Header to identify as, generally appears in web server logs. - type: str - default: ansible-httpget - use_proxy: - description: - - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. - type: bool - default: yes - validate_certs: - description: - - If C(no), SSL certificates will not be validated. - - This should only be used on personally controlled sites using self-signed certificates. - type: bool - default: yes - url_username: - description: - - The username for use in HTTP basic authentication. - - This parameter can be used without I(url_password) for sites that allow empty passwords - type: str - url_password: - description: - - The password for use in HTTP basic authentication. - - If the I(url_username) parameter is not specified, the I(url_password) parameter will not be used. - type: str - force_basic_auth: - description: - - Credentials specified with I(url_username) and I(url_password) should be passed in HTTP Header. - type: bool - default: no - client_cert: - description: - - PEM formatted certificate chain file to be used for SSL client authentication. - - This file can also include the key as well, and if the key is included, C(client_key) is not required. - type: path - client_key: - description: - - PEM formatted file that contains your private key to be used for SSL client authentication. - - If C(client_cert) contains both the certificate and key, this option is not required. - type: path -''' diff --git a/lib/ansible/utils/module_docs_fragments/utm.py b/lib/ansible/utils/module_docs_fragments/utm.py deleted file mode 100644 index 92876f50b3..0000000000 --- a/lib/ansible/utils/module_docs_fragments/utm.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright: (c) 2018, Johannes Brunswicker <johannes.brunswicker@gmail.com> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - DOCUMENTATION = """ -options: - headers: - description: - - A dictionary of additional headers to be sent to POST and PUT requests. - - Is needed for some modules - required: false - utm_host: - description: - - The REST Endpoint of the Sophos UTM. - required: true - utm_port: - description: - - The port of the REST interface. - default: 4444 - utm_token: - description: - - "The token used to identify at the REST-API. See U(https://www.sophos.com/en-us/medialibrary/\ - PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter 2.4.2." - required: true - utm_protocol: - description: - - The protocol of the REST Endpoint. - choices: - - https - - http - default: https - validate_certs: - description: - - Whether the REST interface's ssl certificate should be verified or not. - default: True - type: bool - state: - description: - - The desired state of the object. - - C(present) will create or update an object - - C(absent) will delete an object if it was present - choices: - - present - - absent - default: present -""" diff --git a/lib/ansible/utils/module_docs_fragments/validate.py b/lib/ansible/utils/module_docs_fragments/validate.py deleted file mode 100644 index 4b5d852a89..0000000000 --- a/lib/ansible/utils/module_docs_fragments/validate.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2015, Ansible, Inc -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Standard documentation fragment - DOCUMENTATION = r''' -options: - validate: - description: - - The validation command to run before copying into place. - - The path to the file to validate is passed in via '%s' which must be present as in the examples below. - - The command is passed securely so shell features like expansion and pipes will not work. -''' diff --git a/lib/ansible/utils/module_docs_fragments/vca.py b/lib/ansible/utils/module_docs_fragments/vca.py deleted file mode 100644 index 7762861070..0000000000 --- a/lib/ansible/utils/module_docs_fragments/vca.py +++ /dev/null @@ -1,65 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2016, Charles Paul <cpaul@ansible.com> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Parameters for VCA modules - DOCUMENTATION = r''' -options: - username: - description: - - The vca username or email address, if not set the environment variable C(VCA_USER) is checked for the username. - type: str - aliases: [ user ] - password: - description: - - The vca password, if not set the environment variable C(VCA_PASS) is checked for the password. - type: str - aliases: [ pass, passwd] - org: - description: - - The org to login to for creating vapp. - - This option is required when the C(service_type) is I(vdc). - type: str - instance_id: - description: - - The instance ID in a vchs environment to be used for creating the vapp. - type: str - host: - description: - - The authentication host to be used when service type is vcd. - type: str - api_version: - description: - - The API version to be used with the vca. - type: str - default: "5.7" - service_type: - description: - - The type of service we are authenticating against. - type: str - choices: [ vca, vcd, vchs ] - default: vca - state: - description: - - Whether the object should be added or removed. - type: str - choices: [ absent, present ] - default: present - verify_certs: - description: - - If the certificates of the authentication is to be verified. - type: bool - default: 'yes' - vdc_name: - description: - - The name of the vdc where the gateway is located. - type: str - gateway_name: - description: - - The name of the gateway of the vdc where the rule should be added. - type: str - default: gateway -''' diff --git a/lib/ansible/utils/module_docs_fragments/vmware.py b/lib/ansible/utils/module_docs_fragments/vmware.py deleted file mode 100644 index 6cf74348ac..0000000000 --- a/lib/ansible/utils/module_docs_fragments/vmware.py +++ /dev/null @@ -1,88 +0,0 @@ -# Copyright: (c) 2016, Charles Paul <cpaul@ansible.com> -# Copyright: (c) 2018, Ansible Project -# Copyright: (c) 2019, Abhijeet Kasurde <akasurde@redhat.com> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Parameters for VMware modules - DOCUMENTATION = ''' -options: - hostname: - description: - - The hostname or IP address of the vSphere vCenter or ESXi server. - - If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. - - Environment variable support added in version 2.6. - type: str - username: - description: - - The username of the vSphere vCenter or ESXi server. - - If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. - - Environment variable support added in version 2.6. - type: str - aliases: [ admin, user ] - password: - description: - - The password of the vSphere vCenter or ESXi server. - - If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. - - Environment variable support added in version 2.6. - type: str - aliases: [ pass, pwd ] - validate_certs: - description: - - Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. - - If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead. - - Environment variable support added in version 2.6. - - If set to C(yes), please make sure Python >= 2.7.9 is installed on the given machine. - type: bool - default: 'yes' - port: - description: - - The port number of the vSphere vCenter or ESXi server. - - If the value is not specified in the task, the value of environment variable C(VMWARE_PORT) will be used instead. - - Environment variable support added in version 2.6. - type: int - default: 443 - version_added: 2.5 -''' - - # This doc fragment is specific to vcenter modules like vcenter_license - VCENTER_DOCUMENTATION = ''' -options: - hostname: - description: - - The hostname or IP address of the vSphere vCenter server. - - If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. - - Environment variable supported added in version 2.6. - type: str - username: - description: - - The username of the vSphere vCenter server. - - If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. - - Environment variable supported added in version 2.6. - type: str - aliases: [ admin, user ] - password: - description: - - The password of the vSphere vCenter server. - - If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. - - Environment variable supported added in version 2.6. - type: str - aliases: [ pass, pwd ] - validate_certs: - description: - - Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. - - If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead. - - Environment variable supported added in version 2.6. - - If set to C(yes), please make sure Python >= 2.7.9 is installed on the given machine. - type: bool - default: 'yes' - port: - description: - - The port number of the vSphere vCenter server. - - If the value is not specified in the task, the value of environment variable C(VMWARE_PORT) will be used instead. - - Environment variable supported added in version 2.6. - type: int - default: 443 - version_added: 2.5 - ''' diff --git a/lib/ansible/utils/module_docs_fragments/vmware_rest_client.py b/lib/ansible/utils/module_docs_fragments/vmware_rest_client.py deleted file mode 100644 index 7cdbefb8eb..0000000000 --- a/lib/ansible/utils/module_docs_fragments/vmware_rest_client.py +++ /dev/null @@ -1,42 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2018, Ansible Project -# Copyright: (c) 2018, Abhijeet Kasurde <akasurde@redhat.com> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Parameters for VMware REST Client based modules - DOCUMENTATION = r''' -options: - hostname: - description: - - The hostname or IP address of the vSphere vCenter server. - - If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. - type: str - username: - description: - - The username of the vSphere vCenter server. - - If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. - type: str - aliases: [ admin, user ] - password: - description: - - The password of the vSphere vCenter server. - - If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. - type: str - aliases: [ pass, pwd ] - validate_certs: - description: - - Allows connection when SSL certificates are not valid. - - Set to C(false) when certificates are not trusted. - - If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead. - type: bool - default: true - protocol: - description: - - The connection to protocol. - type: str - choices: [ https, http ] - default: https -''' diff --git a/lib/ansible/utils/module_docs_fragments/vultr.py b/lib/ansible/utils/module_docs_fragments/vultr.py deleted file mode 100644 index 0f0ee72ece..0000000000 --- a/lib/ansible/utils/module_docs_fragments/vultr.py +++ /dev/null @@ -1,44 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright (c) 2017 René Moser <mail@renemoser.net> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - - # Standard documentation fragment - DOCUMENTATION = ''' -options: - api_key: - description: - - API key of the Vultr API. - - The ENV variable C(VULTR_API_KEY) is used as default, when defined. - api_timeout: - description: - - HTTP timeout to Vultr API. - - The ENV variable C(VULTR_API_TIMEOUT) is used as default, when defined. - - Fallback value is 60 seconds if not specified. - api_retries: - description: - - Amount of retries in case of the Vultr API retuns an HTTP 503 code. - - The ENV variable C(VULTR_API_RETRIES) is used as default, when defined. - - Fallback value is 5 retries if not specified. - api_account: - description: - - Name of the ini section in the C(vultr.ini) file. - - The ENV variable C(VULTR_API_ACCOUNT) is used as default, when defined. - default: default - api_endpoint: - description: - - URL to API endpint (without trailing slash). - - The ENV variable C(VULTR_API_ENDPOINT) is used as default, when defined. - - Fallback value is U(https://api.vultr.com) if not specified. - validate_certs: - description: - - Validate SSL certs of the Vultr API. - default: yes - type: bool -requirements: - - "python >= 2.6" -notes: - - Also see the API documentation on https://www.vultr.com/api/. -''' diff --git a/lib/ansible/utils/module_docs_fragments/vyos.py b/lib/ansible/utils/module_docs_fragments/vyos.py deleted file mode 100644 index 661c76ebe8..0000000000 --- a/lib/ansible/utils/module_docs_fragments/vyos.py +++ /dev/null @@ -1,71 +0,0 @@ -# -# (c) 2015, Peter Sprygada <psprygada@ansible.com> -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard files documentation fragment - DOCUMENTATION = """ -options: - provider: - description: - - B(Deprecated) - - "Starting with Ansible 2.5 we recommend using C(connection: network_cli)." - - For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols). - - HORIZONTALLINE - - A dict object containing connection details. - suboptions: - host: - description: - - Specifies the DNS host name or address for connecting to the remote - device over the specified transport. The value of host is used as - the destination address for the transport. - required: true - port: - description: - - Specifies the port to use when building the connection to the remote - device. - default: 22 - username: - description: - - Configures the username to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. - password: - description: - - Specifies the password to use to authenticate the connection to - the remote device. This value is used to authenticate - the SSH session. If the value is not specified in the task, the - value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. - timeout: - description: - - Specifies the timeout in seconds for communicating with the network device - for either connecting or sending commands. If the timeout is - exceeded before the operation is completed, the module will error. - default: 10 - ssh_keyfile: - description: - - Specifies the SSH key to use to authenticate the connection to - the remote device. This value is the path to the - key used to authenticate the SSH session. If the value is not specified - in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) - will be used instead. -notes: - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` -""" diff --git a/lib/ansible/utils/module_docs_fragments/xenserver.py b/lib/ansible/utils/module_docs_fragments/xenserver.py deleted file mode 100644 index af6736f331..0000000000 --- a/lib/ansible/utils/module_docs_fragments/xenserver.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright: (c) 2018, Bojan Vitnik <bvitnik@mainstream.rs> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - # Parameters for XenServer modules - DOCUMENTATION = ''' -options: - hostname: - description: - - The hostname or IP address of the XenServer host or XenServer pool master. - - If the value is not specified in the task, the value of environment variable C(XENSERVER_HOST) will be used instead. - required: False - default: 'localhost' - aliases: ['host', 'pool'] - username: - description: - - The username to use for connecting to XenServer. - - If the value is not specified in the task, the value of environment variable C(XENSERVER_USER) will be used instead. - required: False - default: 'root' - aliases: ['user', 'admin'] - password: - description: - - The password to use for connecting to XenServer. - - If the value is not specified in the task, the value of environment variable C(XENSERVER_PASSWORD) will be used instead. - required: False - aliases: ['pass', 'pwd'] - validate_certs: - description: - - Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. - - If the value is not specified in the task, the value of environment variable C(XENSERVER_VALIDATE_CERTS) will be used instead. - default: 'yes' - type: bool -''' diff --git a/lib/ansible/utils/module_docs_fragments/zabbix.py b/lib/ansible/utils/module_docs_fragments/zabbix.py deleted file mode 100644 index f6030bf0e5..0000000000 --- a/lib/ansible/utils/module_docs_fragments/zabbix.py +++ /dev/null @@ -1,56 +0,0 @@ -# Copyright (c) 2017 Ansible, Inc -# -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see <http://www.gnu.org/licenses/>. - - -class ModuleDocFragment(object): - - # Standard documentation fragment - DOCUMENTATION = ''' -options: - server_url: - description: - - URL of Zabbix server, with protocol (http or https). - C(url) is an alias for C(server_url). - required: true - aliases: [ "url" ] - login_user: - description: - - Zabbix user name. - required: true - login_password: - description: - - Zabbix user password. - required: true - http_login_user: - description: - - Basic Auth login - version_added: "2.1" - http_login_password: - description: - - Basic Auth password - version_added: "2.1" - timeout: - description: - - The timeout of API request (seconds). - default: 10 - validate_certs: - description: - - If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. - type: bool - default: 'yes' - version_added: "2.5" -''' diff --git a/lib/ansible/utils/plugin_docs.py b/lib/ansible/utils/plugin_docs.py index 6cbc50859d..1735a6c271 100644 --- a/lib/ansible/utils/plugin_docs.py +++ b/lib/ansible/utils/plugin_docs.py @@ -97,7 +97,7 @@ def add_fragments(doc, filename, fragment_loader): def get_docstring(filename, fragment_loader, verbose=False, ignore_errors=False): """ - DOCUMENTATION can be extended using documentation fragments loaded by the PluginLoader from the module_docs_fragments directory. + DOCUMENTATION can be extended using documentation fragments loaded by the PluginLoader from the doc_fragments plugins. """ data = read_docstring(filename, verbose=verbose, ignore_errors=ignore_errors) |