mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-06 00:14:02 -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,23 +1,11 @@
|
|||
# Copyright (c) 2018, Ingate Systems AB
|
||||
#
|
||||
# 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) 2018, Ingate Systems AB
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
options:
|
||||
client:
|
||||
description:
|
||||
|
@ -26,39 +14,43 @@ options:
|
|||
version:
|
||||
description:
|
||||
- REST API version.
|
||||
choices: [v1]
|
||||
type: str
|
||||
choices: [ v1 ]
|
||||
default: v1
|
||||
required: true
|
||||
scheme:
|
||||
description:
|
||||
- Which HTTP protocol to use.
|
||||
choices: [http, https]
|
||||
type: str
|
||||
required: true
|
||||
choices: [ http, https ]
|
||||
address:
|
||||
description:
|
||||
- The hostname or IP address to the unit.
|
||||
type: str
|
||||
required: true
|
||||
username:
|
||||
description:
|
||||
- The username of the REST API user.
|
||||
type: str
|
||||
required: true
|
||||
password:
|
||||
description:
|
||||
- The password for the REST API user.
|
||||
type: str
|
||||
required: true
|
||||
port:
|
||||
description:
|
||||
- Which HTTP(S) port to connect to.
|
||||
required: false
|
||||
type: int
|
||||
timeout:
|
||||
description:
|
||||
- The timeout (in seconds) for REST API requests.
|
||||
required: false
|
||||
type: int
|
||||
verify_ssl:
|
||||
description:
|
||||
- Verify the unit's HTTPS certificate.
|
||||
default: true
|
||||
required: false
|
||||
type: bool
|
||||
default: yes
|
||||
notes:
|
||||
- This module requires that the Ingate Python SDK is installed on the
|
||||
host. To install the SDK use the pip command from your shell
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue