New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
host
-
/ required
|
FortiOS or FortiGate ip address.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
|
router_static
-
|
Default: null
|
Configure IPv4 static routing tables.
|
|
bfd
-
|
|
Enable/disable Bidirectional Forwarding Detection (BFD).
|
|
blackhole
-
|
|
Enable/disable black hole.
|
|
comment
-
|
Optional comments.
|
||
device
-
|
Gateway out interface or tunnel. Source system.interface.name.
|
||
distance
-
|
Administrative distance (1 - 255).
|
||
dst
-
|
Destination IP and mask for this route.
|
||
dstaddr
-
|
Name of firewall address or address group. Source firewall.address.name firewall.addrgrp.name.
|
||
dynamic-gateway
-
|
|
Enable use of dynamic gateway retrieved from a DHCP or PPP server.
|
|
gateway
-
|
Gateway IP for this route.
|
||
internet-service
-
|
Application ID in the Internet service database. Source firewall.internet-service.id.
|
||
internet-service-custom
-
|
Application name in the Internet service custom database. Source firewall.internet-service-custom.name.
|
||
link-monitor-exempt
-
|
|
Enable/disable withdrawing this route when link monitor or health check is down.
|
|
priority
-
|
Administrative priority (0 - 4294967295).
|
||
seq-num
-
/ required
|
Sequence number.
|
||
src
-
|
Source prefix for this route.
|
||
state
-
|
|
Indicates whether to create or remove the object
|
|
status
-
|
|
Enable/disable this static route.
|
|
virtual-wan-link
-
|
|
Enable/disable egress through the virtual-wan-link.
|
|
vrf
-
|
Virtual Routing Forwarding ID.
|
||
weight
-
|
Administrative weight (0 - 255).
|
||
username
-
/ required
|
FortiOS or FortiGate username.
|
||
vdom
-
|
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.
|
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure IPv4 static routing tables.
fortios_router_static:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
router_static:
state: "present"
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"
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.