From 525b672c0c8725d87ae316eaf1d62eda0dd7df62 Mon Sep 17 00:00:00 2001 From: John R Barker Date: Tue, 25 Oct 2016 16:03:25 +0100 Subject: [PATCH] Docs fragment for common a10 options (#18163) --- .../utils/module_docs_fragments/a10.py | 62 +++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 lib/ansible/utils/module_docs_fragments/a10.py diff --git a/lib/ansible/utils/module_docs_fragments/a10.py b/lib/ansible/utils/module_docs_fragments/a10.py new file mode 100644 index 0000000000..7e5a8bb40a --- /dev/null +++ b/lib/ansible/utils/module_docs_fragments/a10.py @@ -0,0 +1,62 @@ +# +# (c) 2016, John Barker +# +# 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 . + + +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. + required: true + default: null + username: + description: + - An account with administrator privileges. + required: true + aliases: ['user', 'admin'] + default: null + password: + description: + - Password for the C(username) account. + required: true + aliases: ['pass', 'pwd'] + default: null + 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). + required: false + version_added: 2.2 + default: "no" + choices: ["yes", "no"] + 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. + required: false + version_added: 2.2 + default: 'yes' + choices: ['yes', 'no'] +"""