mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 19:31:26 -07:00
b88304f211
* eos - Support use_proxy argument Running ansible with a proxy set in the environment causes the eos module to attempt to connect to devices via the proxy. To prevent this behaviour the only way is to unset the proxy out of the environment, either by wrapping the ansible calls or doing it in a piece of code executed before connect, such as a vars_module (though this is very hacky). This change allows you to set `use_proxy: no` under the provider config. The default value is set to True, which mirrors the behaviour seen today. * nexos - Support use_proxy argument Running ansible with a proxy set in the environment causes the nexos module to attempt to connect to devices via the proxy. To prevent this behaviour the only way is to unset the proxy out of the environment, either by wrapping the ansible calls or doing it in a piece of code executed before connect, such as a vars_module (though this is very hacky). This change allows you to set `use_proxy: no` under the provider config. The default value is set to True, which mirrors the behaviour seen today.
133 lines
5.7 KiB
Python
133 lines
5.7 KiB
Python
#
|
|
# (c) 2015, Peter Sprygada <psprygada@ansible.com>
|
|
#
|
|
# 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. This value applies to either I(cli) or I(eapi). The port
|
|
value will default to the appropriate transport common port if
|
|
none is provided in the task. (cli=22, http=80, https=443).
|
|
default: 0 (use common port)
|
|
username:
|
|
description:
|
|
- Configures the username to use to authenticate the connection to
|
|
the remote device. This value is used to authenticate
|
|
either the CLI login or the eAPI authentication depending on which
|
|
transport is used. 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 is a common argument used for either I(cli)
|
|
or I(eapi) transports. 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 keyfile to use to authenticate the connection to
|
|
the remote device. This argument is only used for I(cli) transports.
|
|
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
|
|
transport:
|
|
description:
|
|
- Configures the transport connection to use when connecting to the
|
|
remote device.
|
|
required: true
|
|
choices:
|
|
- eapi
|
|
- cli
|
|
default: cli
|
|
use_ssl:
|
|
description:
|
|
- Configures the I(transport) to use SSL if set to true only when the
|
|
C(transport=eapi). If the transport
|
|
argument is not eapi, this value is ignored.
|
|
default: yes
|
|
choices: ['yes', 'no']
|
|
validate_certs:
|
|
description:
|
|
- If C(no), SSL certificates will not be validated. This should only be used
|
|
on personally controlled sites using self-signed certificates. If the transport
|
|
argument is not eapi, this value is ignored.
|
|
choices: ['yes', 'no']
|
|
use_proxy:
|
|
description:
|
|
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored.
|
|
default: 'yes'
|
|
choices: ['yes', 'no']
|
|
version_added: "2.5"
|
|
|
|
notes:
|
|
- For more information on using Ansible to manage Arista EOS devices see U(https://www.ansible.com/ansible-arista-networks).
|
|
|
|
"""
|