fortinet.fortios.fortios_system_config_backup_restore – Backup/restore fortigate configuration
fortinet.fortios.fortios_system_config_backup_restore – Backup/restore fortigate configuration
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
To install it use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_system_config_backup_restore
.
New in version 2.10: of fortinet.fortios
Synopsis
- This module is able to backup or restore the global or particial settings of the fortigate Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
backup string |
content to backup | |
commands string |
the command | |
config string |
configuration to restore | |
description string |
descriptive text | |
filename string / required |
the file name | |
host string |
host of fortigate | |
https boolean |
|
use https or not |
mkey string |
primary key | |
password string |
password of fortigate | |
scope string / required |
scope to operation on | |
ssl_verify boolean |
|
enable ssl verification or not |
username string |
username of fortigate | |
vdom string |
Default: "root" |
vdom to operate on |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- But this module relies on fortiosapi, please make sure fortiosapi is installed before using it
Examples
- hosts: localhost
connection: httpapi
collections:
- fortinet.fortios
vars:
vdom: "root"
host: "192.168.122.60"
username: "admin"
password: ""
tasks:
- name: backup global or a_specific_vdom settings
fortios_system_config_backup_restore:
config: "system config backup"
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
backup: "yes"
https: True
ssl_verify: False
scope: "global or vdom"
filename: "/tmp/backup_test"
- name: Restore global or a_specific_vdom settings
fortios_system_config_backup_restore:
config: "system config restore"
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: True
ssl_verify: False
scope: "global or vdom"
filename: "/tmp/backup_test"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string |
always |
Build number of the fortigate image
Sample: 1547 |
http_method string |
always |
Last method used to provision the content into FortiGate
Sample: PUT |
http_status string |
always |
Last result given by FortiGate on last operation applied
Sample: 200 |
mkey string |
success |
Master key (id) used in the last call to FortiGate
Sample: id |
name string |
always |
Name of the table used to fulfill the request
Sample: urlfilter |
path string |
always |
Path of the table used to fulfill the request
Sample: webfilter |
revision string |
always |
Internal revision number
Sample: 17.0.2.10658 |
serial string |
always |
Serial number of the unit
Sample: FGVMEVYYQT3AB5352 |
status string |
always |
Indication of the operation's result
Sample: success |
vdom string |
always |
Virtual domain used
Sample: root |
version string |
always |
Version of the FortiGate
Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Jie Xue (@JieX19)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_system_config_backup_restore_module.html