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.4).
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.14
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Configure IPv4 static routing tables. |
|
Enable/disable Bidirectional Forwarding Detection (BFD). Choices:
|
|
Enable/disable black hole. Choices:
|
|
Optional comments. |
|
Gateway out interface or tunnel. Source system.interface.name. |
|
Administrative distance (1 - 255). |
|
Destination IP and mask for this route. |
|
Name of firewall address or address group. Source firewall.address.name firewall.addrgrp.name. |
|
Enable use of dynamic gateway retrieved from a DHCP or PPP server. Choices:
|
|
Gateway IP for this route. |
|
Application ID in the Internet service database. Source firewall.internet-service.id. |
|
Application name in the Internet service custom database. Source firewall.internet-service-custom.name. |
|
Enable/disable withdrawal of this static route when link monitor or health check is down. Choices:
|
|
Preferred source IP for this route. |
|
Administrative priority (1 - 65535). |
|
Enable/disable egress through SD-WAN. Choices:
|
|
Choose SD-WAN Zone. |
|
SD-WAN zone name. Source system.sdwan.zone.name. |
|
Sequence number. see <a href=’#notes’>Notes</a>. |
|
Source prefix for this route. |
|
Enable/disable this static route. Choices:
|
|
Route tag. |
|
Enable/disable egress through the virtual-wan-link. Choices:
|
|
Virtual Routing Forwarding ID. |
|
Administrative weight (0 - 255). |
|
Indicates whether to create or remove the object. Choices:
|
|
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: |
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
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: "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 number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |