diff options
Diffstat (limited to 'lib/ansible/utils/module_docs_fragments/dnos10.py')
-rw-r--r-- | lib/ansible/utils/module_docs_fragments/dnos10.py | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/lib/ansible/utils/module_docs_fragments/dnos10.py b/lib/ansible/utils/module_docs_fragments/dnos10.py new file mode 100644 index 0000000000..567de5fa82 --- /dev/null +++ b/lib/ansible/utils/module_docs_fragments/dnos10.py @@ -0,0 +1,67 @@ +# 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 files documentation fragment + DOCUMENTATION = """ +options: + host: + description: + - Specifies the DNS host name or address for connecting to the remote + device over the specified transport. The value of host is used as + the destination address for the transport. + required: true + port: + description: + - Specifies the port to use when building the connection to the remote + device. + required: false + default: 22 + username: + description: + - This value I(username) is used to authenticate the SSH session to the + remote device. If the value is not specified in the task, the + value of environment variable ANSIBLE_NET_USERNAME will be used instead. + required: false + password: + description: + - This value I(password) is used to authenticate the SSH session to + the remote device. If the value is not specified in the task, the + value of environment variable ANSIBLE_NET_PASSWORD will be used instead. + required: false + default: null + ssh_keyfile: + description: + - This value I(ssh_keyfile) is the path to the key used to authenticate + the SSH session to the remote device. If the value is not specified + in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE + will be used instead. + required: false + timeout: + description: + - Specifies idle timeout (in seconds) for the connection. Useful if the + console freezes before continuing. For example when saving + configurations. + required: false + default: 10 + provider: + description: + - Convenience method that allows all M(dnos10) arguments to be passed as + a dict object. All constraints (required, choices, etc) must be + met either by individual arguments or values in this dict. + required: false + default: null +""" |