74 lines
2.9 KiB
Python
74 lines
2.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
# Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com>
|
|
# 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:
|
|
- B(Deprecated)
|
|
- 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
|
|
- For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).
|
|
- HORIZONTALLINE
|
|
- 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
|
|
port:
|
|
description:
|
|
- Specifies the port to use when building the connection to the remote device.
|
|
type: int
|
|
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
|
|
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
|
|
transport:
|
|
description:
|
|
- Specifies the type of connection based transport.
|
|
type: str
|
|
default: cli
|
|
choices:
|
|
- cli
|
|
- netconf
|
|
notes:
|
|
- For more information on using Ansible to manage network devices see the :ref:`Ansible
|
|
Network Guide <network_guide>`
|
|
- For more information on using Ansible to manage Cisco devices see the `Cisco integration
|
|
page <https://www.ansible.com/integrations/networks/cisco>`_.
|
|
"""
|