# fortios_router_static – Configure IPv4 static routing tables in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## 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.5

## Requirements

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.

https
boolean

Choices:
- no
- yes ←

Indicates if the requests towards FortiGate must use HTTPS protocol.

password string | Default: "" | FortiOS or FortiGate password.
router_static dictionary | Default: null | Configure IPv4 static routing tables.

bfd
string

Choices:
- enable
- disable

Enable/disable Bidirectional Forwarding Detection (BFD).

blackhole
string

Choices:
- enable
- disable

Enable/disable black hole.

| 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

Choices:
- enable
- disable

Enable use of dynamic gateway retrieved from a DHCP or PPP server.

| 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

Choices:
- enable
- disable

Enable/disable withdrawing this route when link monitor or health check is down.

| priority integer |  | Administrative priority (0 - 4294967295).
| seq_num integer |  | Sequence number.
| src string |  | Source prefix for this route.

state
string

Choices:
- present
- absent

Deprecated
Starting with Ansible 2.9 we recommend using the top-level 'state' parameter.

Indicates whether to create or remove the object.

status
string

Choices:
- enable
- disable

Enable/disable this static route.

virtual_wan_link
string

Choices:
- enable
- disable

Enable/disable egress through the virtual-wan-link.

| vrf integer |  | Virtual Routing Forwarding ID.
| weight integer |  | Administrative weight (0 - 255).

ssl_verify
boolean
added in 2.9

Choices:
- no
- yes ←

Ensures FortiGate certificate must be verified by a proper CA.

state
string
added in 2.9

Choices:
- present
- absent

Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.

username string |  | FortiOS or FortiGate username.
vdom string | Default: "root" | 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.

## Notes

Note

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
       ssl_verify: "False"
      tasks:
      - name: Configure IPv4 static routing tables.
        fortios_router_static:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          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"
            seq_num: "16"
            src: "<your_own_value>"
            status: "enable"
            virtual_wan_link: "enable"
            vrf: "20"
            weight: "21"

## Return Values

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

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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.