mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 04:11:25 -07:00
Fortios_config PR (#21409)
* Remove state & change backup strategy & fix doc fragment * Missing __init__.py * Move backup to module_utils + add backup_path & backup_filename params * Fix pep8 * Change backup_path type from str to path * Change license from gpl to bsd * Fix doc and backup param leftover * Fix Doc
This commit is contained in:
parent
dd9a39b27b
commit
1e84c401f1
4 changed files with 320 additions and 0 deletions
59
lib/ansible/utils/module_docs_fragments/fortios.py
Normal file
59
lib/ansible/utils/module_docs_fragments/fortios.py
Normal file
|
@ -0,0 +1,59 @@
|
|||
#
|
||||
# (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/>.
|
||||
#
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
|
||||
# Standard files documentation fragment
|
||||
DOCUMENTATION = """
|
||||
options:
|
||||
host:
|
||||
description:
|
||||
- Specifies the DNS hostname or IP address for connecting to the remote fortios device.
|
||||
required: true
|
||||
username:
|
||||
description:
|
||||
- Configures the username used to authenticate to the remote device.
|
||||
required: true
|
||||
password:
|
||||
description:
|
||||
- Specifies the password used to authenticate to the remote device.
|
||||
required: true
|
||||
timeout:
|
||||
description:
|
||||
- Timeout in seconds for connecting to the remote device.
|
||||
default: 60
|
||||
vdom:
|
||||
description:
|
||||
- Specifies on which vdom to apply configuration
|
||||
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
|
||||
choices: ['yes', 'no']
|
||||
backup_path:
|
||||
description:
|
||||
- Specifies where to store backup files. Required if I(backup=yes).
|
||||
backup_filename:
|
||||
description:
|
||||
- Specifies the backup filename. If omitted filename will be
|
||||
formated like HOST_config.YYYY-MM-DD@HH:MM:SS
|
||||
"""
|
Loading…
Add table
Add a link
Reference in a new issue