fortios_config – Manage config on Fortinet FortiOS firewall devices
fortios_config – Manage config on Fortinet FortiOS firewall devices
New in version 2.3.
Synopsis
- This module provides management of FortiOS Devices configuration.
Requirements
The below requirements are needed on the host that executes this module.
- pyFG
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
backup boolean |
|
This argument will cause the module to create a backup of the current |
backup_filename string |
Specifies the backup filename. If omitted filename will be formatted like HOST_config.YYYY-MM-DD@HH:MM:SS | |
backup_path path |
Specifies where to store backup files. Required if backup=yes. | |
config_file path added in 2.4 |
Path to configuration file. Required when file_mode is True. | |
file_mode boolean added in 2.4 |
|
Don't connect to any device, only use config_file as input and Output. |
filter - |
Default: "" |
Only for partial backup, you can restrict by giving expected configuration path (ex. firewall address). |
host string |
Specifies the DNS hostname or IP address for connecting to the remote fortios device. Required when file_mode is False. | |
password string |
Specifies the password used to authenticate to the remote device. Required when file_mode is True. | |
src - |
The src argument provides a path to the configuration template to load into the remote device. | |
timeout integer |
Default: 60 |
Timeout in seconds for connecting to the remote device. |
username string |
Configures the username used to authenticate to the remote device. Required when file_mode is True. | |
vdom string |
Specifies on which vdom to apply configuration |
Examples
- name: Backup current config
fortios_config:
host: 192.168.0.254
username: admin
password: password
backup: yes
- name: Backup only address objects
fortios_config:
host: 192.168.0.254
username: admin
password: password
backup: yes
backup_path: /tmp/forti_backup/
filter: "firewall address"
- name: Update configuration from file
fortios_config:
host: 192.168.0.254
username: admin
password: password
src: new_configuration.conf.j2
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
change_string string |
only if config changed |
The commands really executed by the module
|
running_config string |
always |
full config string
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Benjamin Jolivot (@bjolivot)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/fortios_config_module.html