ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-05-15 13:39:10 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

doc_fragments: Clean up parameter types (network) (#52176)

Browse source 
* module_utils: Clean up parameter types

This PR includes:
- Parameter types added
- Copyright format fixes
- Short license statement
- Description fixes (only for a few files, then I stopped :-))

* More network stuff

* Fix typo

* Fix PEP8

* Fix booleans

* Fix typo
This commit is contained in:
Dag Wieers 2019-02-15 10:52:48 +01:00 • committed by John R Barker
parent 2f3960558d
commit 9c1033422b
31 changed files with 411 additions and 535 deletions
Download patch file Download diff file Expand all files Collapse all files

49
lib/ansible/plugins/doc_fragments/eos.py
View file

@ -1,26 +1,13 @@
#
# (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/>.
# -*- coding: utf-8 -*-
# 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 = """
DOCUMENTATION = r'''
options:
authorize:
description:
@ -35,7 +22,7 @@ options:
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool
default: 'no'
default: no
auth_pass:
description:
- B(Deprecated)
@ -47,6 +34,7 @@ options:
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
provider:
description:
- B(Deprecated)
@ -55,12 +43,14 @@ options:
- For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html).
- 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
required: true
port:
description:
@ -68,6 +58,7 @@ options:
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).
type: int
default: 0 (use common port)
username:
description:
@ -76,17 +67,20 @@ options:
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.
type: str
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.
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:
@ -94,6 +88,7 @@ options:
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.
type: path
authorize:
description:
- Instructs the module to enter privileged mode on the remote device
@ -102,29 +97,29 @@ options:
is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool
default: 'no'
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
transport:
description:
- Configures the transport connection to use when connecting to the
remote device.
required: true
choices:
- eapi
- cli
type: str
choices: [ cli, eapi ]
default: cli
use_ssl:
description:
- Configures the I(transport) to use SSL if set to true only when the
- Configures the I(transport) to use SSL if set to C(yes) only when the
C(transport=eapi). If the transport
argument is not eapi, this value is ignored.
type: bool
default: 'yes'
default: yes
validate_certs:
description:
- If C(no), SSL certificates will not be validated. This should only be used
@ -135,7 +130,7 @@ options:
description:
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored.
type: bool
default: 'yes'
default: yes
version_added: "2.5"
notes:
@ -143,4 +138,4 @@ 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 Arista EOS devices see the `Arista integration page <https://www.ansible.com/ansible-arista-networks>`_.
"""
'''