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_rip
-
|
Default: null
|
Configure RIP.
|
||
default-information-originate
-
|
|
Enable/disable generation of default route.
|
||
default-metric
-
|
Default metric.
|
|||
distance
-
|
distance
|
|||
access-list
-
|
Access list for route destination. Source router.access-list.name.
|
|||
distance
-
|
Distance (1 - 255).
|
|||
id
-
/ required
|
Distance ID.
|
|||
prefix
-
|
Distance prefix.
|
|||
distribute-list
-
|
Distribute list.
|
|||
direction
-
|
|
Distribute list direction.
|
||
id
-
/ required
|
Distribute list ID.
|
|||
interface
-
|
Distribute list interface name. Source system.interface.name.
|
|||
listname
-
|
Distribute access/prefix list name. Source router.access-list.name router.prefix-list.name.
|
|||
status
-
|
|
status
|
||
garbage-timer
-
|
Garbage timer in seconds.
|
|||
interface
-
|
RIP interface configuration.
|
|||
auth-keychain
-
|
Authentication key-chain name. Source router.key-chain.name.
|
|||
auth-mode
-
|
|
Authentication mode.
|
||
auth-string
-
|
Authentication string/password.
|
|||
flags
-
|
flags
|
|||
name
-
/ required
|
Interface name. Source system.interface.name.
|
|||
receive-version
-
|
|
Receive version.
|
||
send-version
-
|
|
Send version.
|
||
send-version2-broadcast
-
|
|
Enable/disable broadcast version 1 compatible packets.
|
||
split-horizon
-
|
|
Enable/disable split horizon.
|
||
split-horizon-status
-
|
|
Enable/disable split horizon.
|
||
max-out-metric
-
|
Maximum metric allowed to output(0 means 'not set').
|
|||
neighbor
-
|
neighbor
|
|||
id
-
/ required
|
Neighbor entry ID.
|
|||
ip
-
|
IP address.
|
|||
network
-
|
network
|
|||
id
-
/ required
|
Network entry ID.
|
|||
prefix
-
|
Network prefix.
|
|||
offset-list
-
|
Offset list.
|
|||
access-list
-
|
Access list name. Source router.access-list.name.
|
|||
direction
-
|
|
Offset list direction.
|
||
id
-
/ required
|
Offset-list ID.
|
|||
interface
-
|
Interface name. Source system.interface.name.
|
|||
offset
-
|
offset
|
|||
status
-
|
|
status
|
||
passive-interface
-
|
Passive interface configuration.
|
|||
name
-
/ required
|
Passive interface name. Source system.interface.name.
|
|||
recv-buffer-size
-
|
Receiving buffer size.
|
|||
redistribute
-
|
Redistribute configuration.
|
|||
metric
-
|
Redistribute metric setting.
|
|||
name
-
/ required
|
Redistribute name.
|
|||
routemap
-
|
Route map name. Source router.route-map.name.
|
|||
status
-
|
|
status
|
||
timeout-timer
-
|
Timeout timer in seconds.
|
|||
update-timer
-
|
Update timer in seconds.
|
|||
version
-
|
|
RIP version.
|
||
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 RIP.
fortios_router_rip:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
router_rip:
default-information-originate: "enable"
default-metric: "4"
distance:
-
access-list: "<your_own_value> (source router.access-list.name)"
distance: "7"
id: "8"
prefix: "<your_own_value>"
distribute-list:
-
direction: "in"
id: "12"
interface: "<your_own_value> (source system.interface.name)"
listname: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
status: "enable"
garbage-timer: "16"
interface:
-
auth-keychain: "<your_own_value> (source router.key-chain.name)"
auth-mode: "none"
auth-string: "<your_own_value>"
flags: "21"
name: "default_name_22 (source system.interface.name)"
receive-version: "1"
send-version: "1"
send-version2-broadcast: "disable"
split-horizon: "poisoned"
split-horizon-status: "enable"
max-out-metric: "28"
neighbor:
-
id: "30"
ip: "<your_own_value>"
network:
-
id: "33"
prefix: "<your_own_value>"
offset-list:
-
access-list: "<your_own_value> (source router.access-list.name)"
direction: "in"
id: "38"
interface: "<your_own_value> (source system.interface.name)"
offset: "40"
status: "enable"
passive-interface:
-
name: "default_name_43 (source system.interface.name)"
recv-buffer-size: "44"
redistribute:
-
metric: "46"
name: "default_name_47"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
timeout-timer: "50"
update-timer: "51"
version: "1"
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.