mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-15 04:39:12 -07:00
doc_fragments: Clean up parameter types (cloud) (#52177)
* module_utils: Clean up parameter types (cloud) This PR includes: - Parameter types added - Copyright format fixes - Short license statement - Description fixes (only for a few files, then I stopped :-)) * More cloud stuff * Fix reported issue * Fix quotes * Use correct type * Fix quotes * Fix quotes * Fix quotes * Fix typo * Fix boolean
This commit is contained in:
parent
203caf2570
commit
25323155d2
28 changed files with 337 additions and 412 deletions
|
@ -1,25 +1,12 @@
|
|||
#
|
||||
#
|
||||
# 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 -*-
|
||||
|
||||
# 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:
|
||||
provider:
|
||||
description:
|
||||
|
@ -30,6 +17,7 @@ options:
|
|||
- 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:
|
||||
|
@ -37,6 +25,7 @@ options:
|
|||
device. This value applies to either I(cli) or I(netconf). The port
|
||||
value will default to the appropriate transport common port if
|
||||
none is provided in the task. (cli=22, netconf=22).
|
||||
type: int
|
||||
default: 0 (use common port)
|
||||
username:
|
||||
description:
|
||||
|
@ -44,25 +33,28 @@ options:
|
|||
the remote device. This value is used to authenticate the CLI login.
|
||||
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 cli
|
||||
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
|
||||
ssh_keyfile:
|
||||
description:
|
||||
- Specifies the SSH key to use to authenticate the connection to
|
||||
the remote device. This argument is used for the I(cli)
|
||||
transport. 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:
|
||||
- Configures the transport connection to use when connecting to the
|
||||
remote device. The transport argument supports connectivity to the
|
||||
device over cli (ssh).
|
||||
type: str
|
||||
required: true
|
||||
choices: [ cli, netconf ]
|
||||
default: cli
|
||||
|
||||
"""
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue