mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-29 11:40:22 -07:00
Merge pull request #16978 from caphrim007/feature.add-module-doc-fragments-for-f5-modules
Adds module doc fragment for F5 modules
This commit is contained in:
commit
375f7c515a
1 changed files with 52 additions and 0 deletions
52
lib/ansible/utils/module_docs_fragments/f5.py
Normal file
52
lib/ansible/utils/module_docs_fragments/f5.py
Normal file
|
@ -0,0 +1,52 @@
|
||||||
|
# -*- 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.
|
||||||
|
required: true
|
||||||
|
server:
|
||||||
|
description:
|
||||||
|
- The BIG-IP host.
|
||||||
|
required: true
|
||||||
|
server_port:
|
||||||
|
description:
|
||||||
|
- The BIG-IP server port.
|
||||||
|
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.
|
||||||
|
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.
|
||||||
|
required: false
|
||||||
|
default: yes
|
||||||
|
choices:
|
||||||
|
- yes
|
||||||
|
- no
|
||||||
|
version_added: 2.0
|
||||||
|
'''
|
Loading…
Add table
Add a link
Reference in a new issue