mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-05 16:04:09 -07:00
doc_fragments: Clean up parameter types (network) (#52176)
* module_utils: Clean up parameter types This PR includes: - Parameter types added - Copyright format fixes - Short license statement - Description fixes (only for a few files, then I stopped :-)) * More network stuff * Fix typo * Fix PEP8 * Fix booleans * Fix typo
This commit is contained in:
parent
2f3960558d
commit
9c1033422b
31 changed files with 411 additions and 535 deletions
|
@ -1,47 +1,38 @@
|
|||
# -*- 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/>.
|
||||
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
# Standard F5 documentation fragment
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
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).
|
||||
type: str
|
||||
required: true
|
||||
aliases: ['pass', 'pwd']
|
||||
aliases: [ pass, pwd ]
|
||||
server:
|
||||
description:
|
||||
- The BIG-IP host.
|
||||
- You may omit this option by setting the environment variable C(F5_SERVER).
|
||||
type: str
|
||||
required: true
|
||||
server_port:
|
||||
description:
|
||||
- The BIG-IP server port.
|
||||
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
|
||||
type: int
|
||||
default: 443
|
||||
version_added: 2.2
|
||||
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).
|
||||
type: str
|
||||
required: true
|
||||
validate_certs:
|
||||
description:
|
||||
|
@ -49,62 +40,67 @@ options:
|
|||
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
|
||||
default: yes
|
||||
version_added: '2.0'
|
||||
provider:
|
||||
description:
|
||||
- A dict object containing connection details.
|
||||
default: null
|
||||
version_added: 2.5
|
||||
type: dict
|
||||
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).
|
||||
type: str
|
||||
required: true
|
||||
aliases: ['pass', 'pwd']
|
||||
aliases: [ pass, pwd ]
|
||||
server:
|
||||
description:
|
||||
- The BIG-IP host.
|
||||
- You may omit this option by setting the environment variable C(F5_SERVER).
|
||||
type: str
|
||||
required: true
|
||||
server_port:
|
||||
description:
|
||||
- The BIG-IP server port.
|
||||
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
|
||||
type: int
|
||||
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).
|
||||
type: str
|
||||
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
|
||||
default: yes
|
||||
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 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).
|
||||
type: path
|
||||
transport:
|
||||
description:
|
||||
- Configures the transport connection to use when connecting to the
|
||||
remote device.
|
||||
choices:
|
||||
- rest
|
||||
- cli
|
||||
type: str
|
||||
choices: [ cli, rest ]
|
||||
default: rest
|
||||
notes:
|
||||
- For more information on using Ansible to manage F5 Networks devices see U(https://www.ansible.com/integrations/networks/f5).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue