fortinet.fortios.fortios_router_setting – Configure router settings in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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 fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_router_setting.
New in version 2.10: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and setting category. 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 | |
|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
|
| router_setting
dictionary
|
Configure router settings.
|
||
| bgp_debug_flags
string
|
bgp_debug_flags
|
||
| hostname
string
|
Hostname for this virtual domain router.
|
||
| igmp_debug_flags
string
|
igmp_debug_flags
|
||
| imi_debug_flags
string
|
imi_debug_flags
|
||
| isis_debug_flags
string
|
isis_debug_flags
|
||
| ospf6_debug_events_flags
string
|
ospf6_debug_events_flags
|
||
| ospf6_debug_ifsm_flags
string
|
ospf6_debug_ifsm_flags
|
||
| ospf6_debug_lsa_flags
string
|
ospf6_debug_lsa_flags
|
||
| ospf6_debug_nfsm_flags
string
|
ospf6_debug_nfsm_flags
|
||
| ospf6_debug_nsm_flags
string
|
ospf6_debug_nsm_flags
|
||
| ospf6_debug_packet_flags
string
|
ospf6_debug_packet_flags
|
||
| ospf6_debug_route_flags
string
|
ospf6_debug_route_flags
|
||
| ospf_debug_events_flags
string
|
ospf_debug_events_flags
|
||
| ospf_debug_ifsm_flags
string
|
ospf_debug_ifsm_flags
|
||
| ospf_debug_lsa_flags
string
|
ospf_debug_lsa_flags
|
||
| ospf_debug_nfsm_flags
string
|
ospf_debug_nfsm_flags
|
||
| ospf_debug_nsm_flags
string
|
ospf_debug_nsm_flags
|
||
| ospf_debug_packet_flags
string
|
ospf_debug_packet_flags
|
||
| ospf_debug_route_flags
string
|
ospf_debug_route_flags
|
||
| pimdm_debug_flags
string
|
pimdm_debug_flags
|
||
| pimsm_debug_joinprune_flags
string
|
pimsm_debug_joinprune_flags
|
||
| pimsm_debug_simple_flags
string
|
pimsm_debug_simple_flags
|
||
| pimsm_debug_timer_flags
string
|
pimsm_debug_timer_flags
|
||
| rip_debug_flags
string
|
rip_debug_flags
|
||
| ripng_debug_flags
string
|
ripng_debug_flags
|
||
| show_filter
string
|
Prefix-list as filter for showing routes. Source router.prefix-list.name.
|
||
| vdom
string
|
Default:
"root"
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.
|
|
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure router settings.
fortios_router_setting:
vdom: "{{ vdom }}"
router_setting:
bgp_debug_flags: "<your_own_value>"
hostname: "myhostname"
igmp_debug_flags: "<your_own_value>"
imi_debug_flags: "<your_own_value>"
isis_debug_flags: "<your_own_value>"
ospf6_debug_events_flags: "<your_own_value>"
ospf6_debug_ifsm_flags: "<your_own_value>"
ospf6_debug_lsa_flags: "<your_own_value>"
ospf6_debug_nfsm_flags: "<your_own_value>"
ospf6_debug_nsm_flags: "<your_own_value>"
ospf6_debug_packet_flags: "<your_own_value>"
ospf6_debug_route_flags: "<your_own_value>"
ospf_debug_events_flags: "<your_own_value>"
ospf_debug_ifsm_flags: "<your_own_value>"
ospf_debug_lsa_flags: "<your_own_value>"
ospf_debug_nfsm_flags: "<your_own_value>"
ospf_debug_nsm_flags: "<your_own_value>"
ospf_debug_packet_flags: "<your_own_value>"
ospf_debug_route_flags: "<your_own_value>"
pimdm_debug_flags: "<your_own_value>"
pimsm_debug_joinprune_flags: "<your_own_value>"
pimsm_debug_simple_flags: "<your_own_value>"
pimsm_debug_timer_flags: "<your_own_value>"
rip_debug_flags: "<your_own_value>"
ripng_debug_flags: "<your_own_value>"
show_filter: "<your_own_value> (source router.prefix-list.name)"
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)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 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/fortinet/fortios/fortios_router_setting_module.html