fortios_router_rip – Configure RIP in Fortinet’s FortiOS and FortiGate.¶
New in version 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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
| fortios_router_rip | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- router_rip - Configure RIP. type: dict more...
- default_information_originate - Enable/disable generation of default route. type: str choices: enable, disable more...
- default_metric - Default metric. type: int more...
- distance - Distance. type: list more...
- access_list - Access list for route destination. Source router.access-list.name. type: str more...
- distance - Distance (1 - 255). type: int more...
- id - Distance ID. type: int more...
- prefix - Distance prefix. type: str more...
- distribute_list - Distribute list. type: list more...
- direction - Distribute list direction. type: str choices: in, out more...
- id - Distribute list ID. type: int more...
- interface - Distribute list interface name. Source system.interface.name. type: str more...
- listname - Distribute access/prefix list name. Source router.access-list.name router.prefix-list.name. type: str more...
- status - Status. type: str choices: enable, disable more...
- garbage_timer - Garbage timer in seconds. type: int more...
- interface - RIP interface configuration. type: list more...
- auth_keychain - Authentication key-chain name. Source router.key-chain.name. type: str more...
- auth_mode - Authentication mode. type: str choices: none, text, md5 more...
- auth_string - Authentication string/password. type: str more...
- flags - Flags. type: int more...
- name - Interface name. Source system.interface.name. type: str more...
- receive_version - Receive version. type: list choices: 1, 2 more...
- send_version - Send version. type: list choices: 1, 2 more...
- send_version2_broadcast - Enable/disable broadcast version 1 compatible packets. type: str choices: disable, enable more...
- split_horizon - Enable/disable split horizon. type: str choices: poisoned, regular more...
- split_horizon_status - Enable/disable split horizon. type: str choices: enable, disable more...
- max_out_metric - Maximum metric allowed to output(0 means "not set"). type: int more...
- neighbor - Neighbor. type: list more...
- network - Network. type: list more...
- offset_list - Offset list. type: list more...
- access_list - Access list name. Source router.access-list.name. type: str more...
- direction - Offset list direction. type: str choices: in, out more...
- id - Offset-list ID. type: int more...
- interface - Interface name. Source system.interface.name. type: str more...
- offset - Offset. type: int more...
- status - Status. type: str choices: enable, disable more...
- passive_interface - Passive interface configuration. type: list more...
- name - Passive interface name. Source system.interface.name. type: str more...
- recv_buffer_size - Receiving buffer size. type: int more...
- redistribute - Redistribute configuration. type: list more...
- metric - Redistribute metric setting. type: int more...
- name - Redistribute name. type: str more...
- routemap - Route map name. Source router.route-map.name. type: str more...
- status - Status. type: str choices: enable, disable more...
- timeout_timer - Timeout timer in seconds. type: int more...
- update_timer - Update timer in seconds. type: int more...
- version - RIP version. type: str choices: 1, 2 more...
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 RIP.
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3