fortios_router_setting – Configure router settings in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- router_setting - Configure router settings. type: dict more...
- bgp_debug_flags - bgp_debug_flags type: str more...
- hostname - Hostname for this virtual domain router. type: str more...
- igmp_debug_flags - igmp_debug_flags type: str more...
- imi_debug_flags - imi_debug_flags type: str more...
- isis_debug_flags - isis_debug_flags type: str more...
- ospf_debug_events_flags - ospf_debug_events_flags type: str more...
- ospf_debug_ifsm_flags - ospf_debug_ifsm_flags type: str more...
- ospf_debug_lsa_flags - ospf_debug_lsa_flags type: str more...
- ospf_debug_nfsm_flags - ospf_debug_nfsm_flags type: str more...
- ospf_debug_nsm_flags - ospf_debug_nsm_flags type: str more...
- ospf_debug_packet_flags - ospf_debug_packet_flags type: str more...
- ospf_debug_route_flags - ospf_debug_route_flags type: str more...
- ospf6_debug_events_flags - ospf6_debug_events_flags type: str more...
- ospf6_debug_ifsm_flags - ospf6_debug_ifsm_flags type: str more...
- ospf6_debug_lsa_flags - ospf6_debug_lsa_flags type: str more...
- ospf6_debug_nfsm_flags - ospf6_debug_nfsm_flags type: str more...
- ospf6_debug_nsm_flags - ospf6_debug_nsm_flags type: str more...
- ospf6_debug_packet_flags - ospf6_debug_packet_flags type: str more...
- ospf6_debug_route_flags - ospf6_debug_route_flags type: str more...
- pimdm_debug_flags - pimdm_debug_flags type: str more...
- pimsm_debug_joinprune_flags - pimsm_debug_joinprune_flags type: str more...
- pimsm_debug_simple_flags - pimsm_debug_simple_flags type: str more...
- pimsm_debug_timer_flags - pimsm_debug_timer_flags type: str more...
- rip_debug_flags - rip_debug_flags type: str more...
- ripng_debug_flags - ripng_debug_flags type: str more...
- show_filter - Prefix-list as filter for showing routes. Source router.prefix-list.name. type: str more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure router settings.
fortinet.fortios.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>"
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>"
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>"
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.