fortinet.fortios.fortios_router_rip module – Configure RIP in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_router_rip.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and rip 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.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Configure RIP. |
|
Enable/disable generation of default route. Choices:
|
|
Default metric. |
|
Distance. |
|
Access list for route destination. Source router.access-list.name. |
|
Distance (1 - 255). |
|
Distance ID. see <a href=’#notes’>Notes</a>. |
|
Distance prefix. |
|
Distribute list. |
|
Distribute list direction. Choices:
|
|
Distribute list ID. see <a href=’#notes’>Notes</a>. |
|
Distribute list interface name. Source system.interface.name. |
|
Distribute access/prefix list name. Source router.access-list.name router.prefix-list.name. |
|
Status. Choices:
|
|
Garbage timer in seconds. |
|
RIP interface configuration. |
|
Authentication key-chain name. Source router.key-chain.name. |
|
Authentication mode. Choices:
|
|
Authentication string/password. |
|
Flags. |
|
Interface name. Source system.interface.name. |
|
Receive version. Choices:
|
|
Send version. Choices:
|
|
Enable/disable broadcast version 1 compatible packets. Choices:
|
|
Enable/disable split horizon. Choices:
|
|
Enable/disable split horizon. Choices:
|
|
Maximum metric allowed to output(0 means “not set”). |
|
Neighbor. |
|
Neighbor entry ID. see <a href=’#notes’>Notes</a>. |
|
IP address. |
|
Network. |
|
Network entry ID. see <a href=’#notes’>Notes</a>. |
|
Network prefix. |
|
Offset list. |
|
Access list name. Source router.access-list.name. |
|
Offset list direction. Choices:
|
|
Offset-list ID. see <a href=’#notes’>Notes</a>. |
|
Interface name. Source system.interface.name. |
|
Offset. |
|
Status. Choices:
|
|
Passive interface configuration. |
|
Passive interface name. Source system.interface.name. |
|
Receiving buffer size. |
|
Redistribute configuration. |
|
Redistribute metric setting. |
|
Redistribute name. |
|
Route map name. Source router.route-map.name. |
|
Status. Choices:
|
|
Timeout timer in seconds. |
|
Update timer in seconds. |
|
RIP version. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure RIP.
fortinet.fortios.fortios_router_rip:
vdom: "{{ vdom }}"
router_rip:
default_information_originate: "enable"
default_metric: "1"
distance:
-
access_list: "<your_own_value> (source router.access-list.name)"
distance: "0"
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: "120"
interface:
-
auth_keychain: "<your_own_value> (source router.key-chain.name)"
auth_mode: "none"
auth_string: "<your_own_value>"
flags: "8"
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: "0"
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: "0"
status: "enable"
passive_interface:
-
name: "default_name_43 (source system.interface.name)"
recv_buffer_size: "655360"
redistribute:
-
metric: "0"
name: "default_name_47"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
timeout_timer: "180"
update_timer: "30"
version: "1"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |