diff options
author | Tim Rupp <caphrim007@gmail.com> | 2016-08-05 08:53:45 -0700 |
---|---|---|
committer | Tim Rupp <caphrim007@gmail.com> | 2016-08-05 12:21:46 -0700 |
commit | 5f34206b0a9dc1b8f1f25d9d04ab832453727164 (patch) | |
tree | 8d5c39cb98e547bfe83e4c96ce46ec631e07bd01 | |
parent | 2dc8d80dc5bdadb8b47c4f813a34a54c91e2e010 (diff) | |
download | ansible-5f34206b0a9dc1b8f1f25d9d04ab832453727164.tar.gz |
Adds module doc fragment for F5 modules
To reduce documentation duplication, this module fragment is
being created for use in all F5 modules.
-rw-r--r-- | lib/ansible/utils/module_docs_fragments/f5.py | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/lib/ansible/utils/module_docs_fragments/f5.py b/lib/ansible/utils/module_docs_fragments/f5.py new file mode 100644 index 0000000000..b8cbf9d694 --- /dev/null +++ b/lib/ansible/utils/module_docs_fragments/f5.py @@ -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 +''' |