source:	fortios_router_static.py
orphan:

fortios_router_static -- Configure IPv4 static routing tables in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis
Requirements
Tips
FortiOS Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_router_static	`v6.0.0 -> latest`

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
state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
router_static - Configure IPv4 static routing tables. type: dict more...

Supported Version Ranges

router_static v6.0.0 -> latest

bfd - Enable/disable Bidirectional Forwarding Detection (BFD). type: str choices: enable, disable more...

Supported Version Ranges

bfd v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
blackhole - Enable/disable black hole. type: str choices: enable, disable more...

Supported Version Ranges

blackhole v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
comment - Optional comments. type: str more...

Supported Version Ranges

comment v6.0.0 -> latest
device - Gateway out interface or tunnel. Source system.interface.name. type: str more...

Supported Version Ranges

device v6.0.0 -> latest
distance - Administrative distance (1 - 255). type: int more...

Supported Version Ranges

distance v6.0.0 -> latest
dst - Destination IP and mask for this route. type: str more...

Supported Version Ranges

dst v6.0.0 -> latest
dstaddr - Name of firewall address or address group. Source firewall.address.name firewall.addrgrp.name. type: str more...

Supported Version Ranges

dstaddr v6.0.0 -> latest
dynamic_gateway - Enable use of dynamic gateway retrieved from a DHCP or PPP server. type: str choices: enable, disable more...

Supported Version Ranges

dynamic_gateway v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
gateway - Gateway IP for this route. type: str more...

Supported Version Ranges

gateway v6.0.0 -> latest
internet_service - Application ID in the Internet service database. Source firewall.internet-service.id. type: int more...

Supported Version Ranges

internet_service v6.0.0 -> latest
internet_service_custom - Application name in the Internet service custom database. Source firewall.internet-service-custom.name. type: str more...

Supported Version Ranges

internet_service_custom v6.0.0 -> latest
link_monitor_exempt - Enable/disable withdrawal of this static route when link monitor or health check is down. type: str choices: enable, disable more...

Supported Version Ranges

link_monitor_exempt v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
preferred_source - Preferred source IP for this route. type: str more...

Supported Version Ranges

preferred_source v7.4.0 -> latest
priority - Administrative priority (1 - 65535). type: int more...

Supported Version Ranges

priority v6.0.0 -> latest
sdwan - Enable/disable egress through SD-WAN. type: str choices: enable, disable more...

Supported Version Ranges

sdwan v6.4.0 -> v7.0.0

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
sdwan_zone - Choose SD-WAN Zone. type: list member_path: sdwan_zone:name more...

Supported Version Ranges

sdwan_zone v7.0.1 -> latest

name - SD-WAN zone name. Source system.sdwan.zone.name. type: str required: true more...

Supported Version Ranges

name v7.0.1 -> latest

seq_num - Sequence number. see Notes. type: int required: true more...

Supported Version Ranges

seq_num v6.0.0 -> latest
src - Source prefix for this route. type: str more...

Supported Version Ranges

src v6.0.0 -> latest
status - Enable/disable this static route. type: str choices: enable, disable more...

Supported Version Ranges

status v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
tag - Route tag. type: int more...

Supported Version Ranges

tag v7.2.4 -> latest
virtual_wan_link - Enable/disable egress through the virtual-wan-link. type: str choices: enable, disable more...

Supported Version Ranges

virtual_wan_link v6.0.0 -> v6.2.7

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
vrf - Virtual Routing Forwarding ID. type: int more...

Supported Version Ranges

vrf v6.0.0 -> latest
weight - Administrative weight (0 - 255). type: int more...

Supported Version Ranges

weight v6.0.0 -> latest

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

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

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fortios_router_static.rst

fortios_router_static.rst

fortios_router_static -- Configure IPv4 static routing tables in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

	Supported Version Ranges
bfd	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
blackhole	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
dynamic_gateway	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
internet_service_custom	`v6.0.0 -> latest`

	Supported Version Ranges
link_monitor_exempt	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
sdwan	`v6.4.0 -> v7.0.0`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
virtual_wan_link	`v6.0.0 -> v6.2.7`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

Files

fortios_router_static.rst

Latest commit

History

fortios_router_static.rst

File metadata and controls

fortios_router_static -- Configure IPv4 static routing tables in Fortinet's FortiOS and FortiGate.