mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 11:21:25 -07:00
cbfe15a315
For F5 modules, the options that are commonly specified can also be specified in the environment variables. This patch adds the doc fragments that describe which env var goes with which module option.
59 lines
2 KiB
Python
59 lines
2 KiB
Python
# -*- 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.
|
|
This option can be omitted if the environment variable C(F5_PASSWORD)
|
|
is set.
|
|
required: true
|
|
server:
|
|
description:
|
|
- The BIG-IP host. This option can be omitted if the environment
|
|
variable C(F5_SERVER) is set.
|
|
required: true
|
|
server_port:
|
|
description:
|
|
- The BIG-IP server port. This option can be omitted if the environment
|
|
variable C(F5_SERVER_PORT) is set.
|
|
required: false
|
|
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. This option can be omitted
|
|
if the environment variable C(F5_USER) is set.
|
|
required: true
|
|
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.
|
|
This option can be omitted if the environment variable
|
|
C(F5_VALIDATE_CERTS) is set.
|
|
required: false
|
|
default: yes
|
|
choices:
|
|
- yes
|
|
- no
|
|
version_added: 2.0
|
|
'''
|