community.fortios.fmgr_device_config – Edit device configurations
Note
This plugin is part of the community.fortios collection (version 1.0.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.fortios.
To use it in a playbook, specify: community.fortios.fmgr_device_config.
Synopsis
- Edit device configurations from FortiManager Device Manager using JSON RPC API.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| adom
string
|
Default:
"root"
|
The ADOM the configuration should belong to.
|
| device_hostname
string
|
The device's new hostname.
|
|
| device_unique_name
string / required
|
The unique device's name that you are editing. A.K.A. Friendly name of the device in FortiManager.
|
|
| install_config
string
|
Default:
"disable"
|
Tells FMGR to attempt to install the config after making it.
|
| interface
string
|
The interface/port number you are editing.
|
|
| interface_allow_access
string
|
Specify what protocols are allowed on the interface, comma-separated list (see examples).
|
|
| interface_ip
string
|
The IP and subnet of the interface/port you are editing.
|
Notes
Note
- Full Documentation at https://ftnt-ansible-docs.readthedocs.io/en/latest/.
Examples
- name: CHANGE HOSTNAME
community.fortios.fmgr_device_config:
device_hostname: "ChangedbyAnsible"
device_unique_name: "FGT1"
- name: EDIT INTERFACE INFORMATION
community.fortios.fmgr_device_config:
adom: "root"
device_unique_name: "FGT2"
interface: "port3"
interface_ip: "10.1.1.1/24"
interface_allow_access: "ping, telnet, https"
- name: INSTALL CONFIG
community.fortios.fmgr_device_config:
adom: "root"
device_unique_name: "FGT1"
install_config: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| api_result
string
|
always |
full API response, includes status code and message
|
Authors
- Luke Weighall (@lweighall)
- Andrew Welsh (@Ghilli3)
- Jim Huber (@p4r4n0y1ng)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/fortios/fmgr_device_config_module.html