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.1.7).

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.9

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.

string

Enable/disable withdrawal of this static route when link monitor or health check is down.

Choices:

  • "enable"

  • "disable"

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

SD-WAN zone name. Source system.sdwan.zone.name.

seq_num

integer

Sequence number.

src

string

Source prefix for this route.

status

string

Enable/disable this static route.

Choices:

  • "enable"

  • "disable"

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

  • 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 IPv4 static routing tables.
    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: "7"
        dst: "<your_own_value>"
        dstaddr: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
        dynamic_gateway: "enable"
        gateway: "<your_own_value>"
        internet_service: "12 (source firewall.internet-service.id)"
        internet_service_custom: "<your_own_value> (source firewall.internet-service-custom.name)"
        link_monitor_exempt: "enable"
        priority: "15"
        sdwan: "enable"
        sdwan_zone:
         -
            name: "default_name_18 (source system.sdwan.zone.name)"
        seq_num: "19"
        src: "<your_own_value>"
        status: "enable"
        virtual_wan_link: "enable"
        vrf: "23"
        weight: "24"

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)