mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-08 09:24:01 -07:00
doc_fragments: Clean up parameter types (network) (#52176)
* 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:
parent
2f3960558d
commit
9c1033422b
31 changed files with 411 additions and 535 deletions
|
@ -1,25 +1,12 @@
|
|||
# Copyright (C) 2017 Lenovo, Inc.
|
||||
#
|
||||
# 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) 2017, Lenovo, Inc.
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
# Standard CNOS documentation fragment
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
options:
|
||||
outputfile:
|
||||
description:
|
||||
|
@ -28,8 +15,9 @@ options:
|
|||
template file and each response from the device are saved here.
|
||||
Usually the location is the results folder, but you can
|
||||
choose another location based on your write permission.
|
||||
type: path
|
||||
required: true
|
||||
version_added: 2.3
|
||||
version_added: '2.3'
|
||||
host:
|
||||
description:
|
||||
- This is the variable used to search the hosts file at
|
||||
|
@ -38,8 +26,9 @@ options:
|
|||
keyword {{ inventory_hostname }} is specified in the playbook as
|
||||
an abstraction of the group of network elements that need to be
|
||||
configured.
|
||||
type: str
|
||||
required: true
|
||||
version_added: 2.3
|
||||
version_added: '2.3'
|
||||
username:
|
||||
description:
|
||||
- Configures the username used to authenticate the connection to
|
||||
|
@ -48,8 +37,9 @@ options:
|
|||
come from the inventory file, you can also specify it as a
|
||||
variable. This parameter is optional. If it is not specified, no
|
||||
default value will be used.
|
||||
type: str
|
||||
required: true
|
||||
version_added: 2.3
|
||||
version_added: '2.3'
|
||||
password:
|
||||
description:
|
||||
- Configures the password used to authenticate the connection to
|
||||
|
@ -58,8 +48,9 @@ options:
|
|||
come from the inventory file, you can also specify it as a
|
||||
variable. This parameter is optional. If it is not specified, no
|
||||
default value will be used.
|
||||
type: str
|
||||
required: true
|
||||
version_added: 2.3
|
||||
version_added: '2.3'
|
||||
enablePassword:
|
||||
description:
|
||||
- Configures the password used to enter Global Configuration
|
||||
|
@ -68,16 +59,26 @@ options:
|
|||
should come from the inventory file, you can also specify it as a
|
||||
variable. This parameter is optional. If it is not specified,
|
||||
no default value will be used.
|
||||
version_added: 2.3
|
||||
type: str
|
||||
version_added: '2.3'
|
||||
deviceType:
|
||||
description:
|
||||
- This specifies the type of device where the method is executed.
|
||||
The choices NE1072T,NE1032,NE1032T,NE10032,NE2572 are added
|
||||
since version 2.4. The choice NE0152T is added since 2.8
|
||||
required: Yes
|
||||
choices: [g8272_cnos,g8296_cnos,g8332_cnos,NE1072T,NE1032,
|
||||
NE1032T,NE10032,NE2572,NE0152T]
|
||||
version_added: 2.3
|
||||
since Ansible 2.4. The choice NE0152T is added since 2.8
|
||||
type: str
|
||||
required: true
|
||||
choices:
|
||||
- g8272_cnos
|
||||
- g8296_cnos
|
||||
- g8332_cnos
|
||||
- NE0152T
|
||||
- NE1072T
|
||||
- NE1032
|
||||
- NE1032T
|
||||
- NE10032
|
||||
- NE2572
|
||||
version_added: '2.3'
|
||||
notes:
|
||||
- For more information on using Ansible to manage Lenovo Network devices see U(https://www.ansible.com/ansible-lenovo).
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue