Create document fragment for enos modules (#31512)
This commit is contained in:
Anil Kumar Muraleedharan
John R Barker
parent
ead00e9cae
commit
295a0e9225
1 changed files with 98 additions and 0 deletions
98
lib/ansible/utils/module_docs_fragments/enos.py
Normal file
98
lib/ansible/utils/module_docs_fragments/enos.py
Normal file
|
|
@ -0,0 +1,98 @@
|
||||||
|
# Copyright (C) 2017 Lenovo, Inc.
|
||||||
|
#
|
||||||
|
# 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:
|
||||||
|
authorize:
|
||||||
|
description:
|
||||||
|
- Instructs the module to enter privileged mode on the remote device
|
||||||
|
before sending any commands. If not specified, the device will
|
||||||
|
attempt to execute all commands in non-privileged mode. If the value
|
||||||
|
is not specified in the task, the value of environment variable
|
||||||
|
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
|
||||||
|
default: no
|
||||||
|
choices: ['yes', 'no']
|
||||||
|
auth_pass:
|
||||||
|
description:
|
||||||
|
- Specifies the password to use if required to enter privileged mode
|
||||||
|
on the remote device. If I(authorize) is false, then this argument
|
||||||
|
does nothing. If the value is not specified in the task, the value of
|
||||||
|
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
|
||||||
|
default: none
|
||||||
|
provider:
|
||||||
|
description:
|
||||||
|
- A dict object containing connection details.
|
||||||
|
default: null
|
||||||
|
suboptions:
|
||||||
|
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.
|
||||||
|
default: 22
|
||||||
|
username:
|
||||||
|
description:
|
||||||
|
- Configures the username to use to authenticate the connection to
|
||||||
|
the remote device. This value is used to authenticate
|
||||||
|
the SSH session. If the value is not specified in the task, the
|
||||||
|
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
|
||||||
|
password:
|
||||||
|
description:
|
||||||
|
- Specifies the password to use to authenticate the connection to
|
||||||
|
the remote device. This value is used to authenticate
|
||||||
|
the SSH session. If the value is not specified in the task, the
|
||||||
|
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
|
||||||
|
default: null
|
||||||
|
timeout:
|
||||||
|
description:
|
||||||
|
- Specifies the timeout in seconds for communicating with the network device
|
||||||
|
for either connecting or sending commands. If the timeout is
|
||||||
|
exceeded before the operation is completed, the module will error.
|
||||||
|
default: 10
|
||||||
|
ssh_keyfile:
|
||||||
|
description:
|
||||||
|
- Specifies the SSH key to use to authenticate the connection to
|
||||||
|
the remote device. This value is the path to the
|
||||||
|
key used to authenticate the SSH session. If the value is not specified
|
||||||
|
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
|
||||||
|
will be used instead.
|
||||||
|
authorize:
|
||||||
|
description:
|
||||||
|
- Instructs the module to enter privileged mode on the remote device
|
||||||
|
before sending any commands. If not specified, the device will
|
||||||
|
attempt to execute all commands in non-privileged mode. If the value
|
||||||
|
is not specified in the task, the value of environment variable
|
||||||
|
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
|
||||||
|
default: no
|
||||||
|
choices: ['yes', 'no']
|
||||||
|
auth_pass:
|
||||||
|
description:
|
||||||
|
- Specifies the password to use if required to enter privileged mode
|
||||||
|
on the remote device. If I(authorize) is false, then this argument
|
||||||
|
does nothing. If the value is not specified in the task, the value of
|
||||||
|
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
|
||||||
|
default: none
|
||||||
|
'''
|
||||||
Loading…
Reference in a new issue