04c4baad7f
* adding OS9 ansible collections * adding OS9 collections * adding licensing, documentation changes * fix for bugs reported by ansible sanity test * fix for bugs reported by ansible sanity test * adding documentation review changes and sanity folder Co-authored-by: Patil <Komal_uttamrao_Patil@Dell.com>
74 lines
2.9 KiB
Python
74 lines
2.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2020, Peter Sprygada <psprygada@ansible.com>
|
|
# Copyright: (c) 2020, Dell Inc.
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
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
|
|
port:
|
|
description:
|
|
- Specifies the port to use when building the connection to the remote
|
|
device.
|
|
type: int
|
|
username:
|
|
description:
|
|
- User to authenticate the SSH session to the remote device. 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:
|
|
- Password to authenticate the SSH session to the remote device. If the
|
|
value is not specified in the task, the value of environment variable
|
|
C(ANSIBLE_NET_PASSWORD) will be used instead.
|
|
type: str
|
|
ssh_keyfile:
|
|
description:
|
|
- Path to an ssh 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 C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
|
|
type: path
|
|
timeout:
|
|
description:
|
|
- Specifies idle timeout (in seconds) for the connection. Useful if the
|
|
console freezes before continuing. For example when saving
|
|
configurations.
|
|
type: int
|
|
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: false
|
|
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
|
|
notes:
|
|
- For more information on using Ansible to manage Dell EMC Network devices see U(https://www.ansible.com/ansible-dell-networking).
|
|
'''
|