mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
74 lines
3 KiB
Python
74 lines
3 KiB
Python
|
# -*- coding: utf-8 -*-
|
||
|
|
|
||
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||
|
|
|
||
|
|
|
||
|
|
class ModuleDocFragment(object):
|
||
|
|
|
||
|
|
# Standard files documentation fragment
|
||
|
|
DOCUMENTATION = r'''
|
||
|
|
options:
|
||
|
|
provider:
|
||
|
|
description:
|
||
|
|
- A dict object containing connection details.
|
||
|
|
type: dict
|
||
|
|
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.
|
||
|
|
type: str
|
||
|
|
required: true
|
||
|
|
port:
|
||
|
|
description:
|
||
|
|
- Specifies the port to use when building the connection to the remote device.
|
||
|
|
type: int
|
||
|
|
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.
|
||
|
|
type: str
|
||
|
|
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.
|
||
|
|
type: str
|
||
|
|
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.
|
||
|
|
type: int
|
||
|
|
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.
|
||
|
|
type: path
|
||
|
|
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.
|
||
|
|
type: bool
|
||
|
|
default: 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.
|
||
|
|
type: str
|
||
|
|
'''
|