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:
Dag Wieers 2019-02-15 10:52:48 +01:00 committed by John R Barker
commit 9c1033422b
31 changed files with 411 additions and 535 deletions

View file

@ -1,67 +1,61 @@
#
# (c) 2017, Benjamin Jolivot <bjolivot@gmail.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) 2017, Benjamin Jolivot <bjolivot@gmail.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:
file_mode:
description:
- Don't connect to any device, only use I(config_file) as input and Output.
default: false
type: bool
default: no
version_added: "2.4"
config_file:
description:
- Path to configuration file. Required when I(file_mode) is True.
type: path
version_added: "2.4"
host:
description:
- Specifies the DNS hostname or IP address for connecting to the remote fortios device. Required when I(file_mode) is False.
type: str
username:
description:
- Configures the username used to authenticate to the remote device. Required when I(file_mode) is True.
type: str
password:
description:
- Specifies the password used to authenticate to the remote device. Required when I(file_mode) is True.
type: str
timeout:
description:
- Timeout in seconds for connecting to the remote device.
type: int
default: 60
vdom:
description:
- Specifies on which vdom to apply configuration
type: str
backup:
description:
- This argument will cause the module to create a backup of
the current C(running-config) from the remote device before any
changes are made. The backup file is written to the i(backup)
folder.
default: no
type: bool
default: no
backup_path:
description:
- Specifies where to store backup files. Required if I(backup=yes).
type: path
backup_filename:
description:
- Specifies the backup filename. If omitted filename will be
formatted like HOST_config.YYYY-MM-DD@HH:MM:SS
"""
type: str
'''