fortinet.fortios.fortios_router_static module – Configure IPv4 static routing tables in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.8).

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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_router_static.

New in fortinet.fortios 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 static 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

Parameters

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
member_path string	Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: "present" "absent"
router_static dictionary	Configure IPv4 static routing tables.
bfd string	Enable/disable Bidirectional Forwarding Detection (BFD). Choices: "enable" "disable"
blackhole string	Enable/disable black hole. Choices: "enable" "disable"
comment string	Optional comments.
device string	Gateway out interface or tunnel. Source system.interface.name.
distance integer	Administrative distance (1 - 255).
dst string	Destination IP and mask for this route.
dstaddr string	Name of firewall address or address group. Source firewall.address.name firewall.addrgrp.name.
dynamic_gateway string	Enable use of dynamic gateway retrieved from a DHCP or PPP server. Choices: "enable" "disable"
gateway string	Gateway IP for this route.
internet_service integer	Application ID in the Internet service database. Source firewall.internet-service.id.
internet_service_custom string	Application name in the Internet service custom database. Source firewall.internet-service-custom.name.
link_monitor_exempt string	Enable/disable withdrawal of this static route when link monitor or health check is down. Choices: "enable" "disable"
preferred_source string	Preferred source IP for this route.
priority integer	Administrative priority (1 - 65535).
sdwan string	Enable/disable egress through SD-WAN. Choices: "enable" "disable"
sdwan_zone list / elements=dictionary	Choose SD-WAN Zone.
name string / required	SD-WAN zone name. Source system.sdwan.zone.name.
seq_num integer / required	Sequence number. see <a href=’#notes’>Notes</a>.
src string	Source prefix for this route.
status string	Enable/disable this static route. Choices: "enable" "disable"
tag integer	Route tag.
virtual_wan_link string	Enable/disable egress through the virtual-wan-link. Choices: "enable" "disable"
vrf integer	Virtual Routing Forwarding ID.
weight integer	Administrative weight (0 - 255).
state string / required	Indicates whether to create or remove the object. Choices: "present" "absent"
vdom string	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. Default: "root"

Notes

Note

• We highly recommend using your own value as the seq_num instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

• The module supports check_mode.

Examples

- name: Configure IPv4 static routing tables.
  fortinet.fortios.fortios_router_static:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      router_static:
          bfd: "enable"
          blackhole: "enable"
          comment: "Optional comments."
          device: "<your_own_value> (source system.interface.name)"
          distance: "10"
          dst: "<your_own_value>"
          dstaddr: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
          dynamic_gateway: "enable"
          gateway: "<your_own_value>"
          internet_service: "0"
          internet_service_custom: "<your_own_value> (source firewall.internet-service-custom.name)"
          link_monitor_exempt: "enable"
          preferred_source: "<your_own_value>"
          priority: "1"
          sdwan: "enable"
          sdwan_zone:
              -
                  name: "default_name_19 (source system.sdwan.zone.name)"
          seq_num: "<you_own_value>"
          src: "<your_own_value>"
          status: "enable"
          tag: "0"
          virtual_wan_link: "enable"
          vrf: "unspecified"
          weight: "0"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
build string	Build number of the fortigate image Returned: always Sample: "1547"
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: "PUT"
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: "200"
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: "id"
name string	Name of the table used to fulfill the request Returned: always Sample: "urlfilter"
path string	Path of the table used to fulfill the request Returned: always Sample: "webfilter"
revision string	Internal revision number Returned: always Sample: "17.0.2.10658"
serial string	Serial number of the unit Returned: always Sample: "FGVMEVYYQT3AB5352"
status string	Indication of the operation’s result Returned: always Sample: "success"
vdom string	Virtual domain used Returned: always Sample: "root"
version string	Version of the FortiGate Returned: always 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)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)