fortinet.fortios.fortios_router_static – Configure IPv4 static routing tables in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
To install it use: ansible-galaxy collection install fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_router_static.
New in version 2.8: of fortinet.fortios
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.0
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| access_token  string  | Token-based authentication. Generated from GUI of Fortigate. | ||
| router_static  dictionary  | Configure IPv4 static routing tables. | ||
| bfd  string  | 
 | Enable/disable Bidirectional Forwarding Detection (BFD). | |
| blackhole  string  | 
 | 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  | 
 | 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  | 
 | 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  | 
 | Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object. | |
| status  string  | 
 | Enable/disable this static route. | |
| virtual_wan_link  string  | 
 | Enable/disable egress through the virtual-wan-link. | |
| vrf  integer  | Virtual Routing Forwarding ID. | ||
| weight  integer  | Administrative weight (0 - 255). | ||
| state  string   added in 2.9 of fortinet.fortios  | 
 | 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. | |
| 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
- 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"
        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 | 
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
    © 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_router_static_module.html