fortios_router_rip – Configure RIP in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- router_rip - Configure RIP. type: dict
- default_information_originate - Enable/disable generation of default route. type: str choices: enable, disable
- default_metric - Default metric. type: int
- distance - distance type: list
- access_list - Access list for route destination. Source router.access-list.name. type: str
- distance - Distance (1 - 255). type: int
- id - Distance ID. type: int required: True
- prefix - Distance prefix. type: str
- distribute_list - Distribute list. type: list
- direction - Distribute list direction. type: str choices: in, out
- id - Distribute list ID. type: int required: True
- interface - Distribute list interface name. Source system.interface.name. type: str
- listname - Distribute access/prefix list name. Source router.access-list.name router.prefix-list.name. type: str
- status - status type: str choices: enable, disable
- garbage_timer - Garbage timer in seconds. type: int
- interface - RIP interface configuration. type: list
- auth_keychain - Authentication key-chain name. Source router.key-chain.name. type: str
- auth_mode - Authentication mode. type: str choices: none, text, md5
- auth_string - Authentication string/password. type: str
- flags - flags type: int
- name - Interface name. Source system.interface.name. type: str required: True
- receive_version - Receive version. type: str choices: 1, 2
- send_version - Send version. type: str choices: 1, 2
- send_version2_broadcast - Enable/disable broadcast version 1 compatible packets. type: str choices: disable, enable
- split_horizon - Enable/disable split horizon. type: str choices: poisoned, regular
- split_horizon_status - Enable/disable split horizon. type: str choices: enable, disable
- max_out_metric - Maximum metric allowed to output(0 means "not set"). type: int
- neighbor - neighbor type: list
- id - Neighbor entry ID. type: int required: True
- ip - IP address. type: str
- network - network type: list
- id - Network entry ID. type: int required: True
- prefix - Network prefix. type: str
- offset_list - Offset list. type: list
- access_list - Access list name. Source router.access-list.name. type: str
- direction - Offset list direction. type: str choices: in, out
- id - Offset-list ID. type: int required: True
- interface - Interface name. Source system.interface.name. type: str
- offset - offset type: int
- status - status type: str choices: enable, disable
- passive_interface - Passive interface configuration. type: list
- name - Passive interface name. Source system.interface.name. type: str required: True
- recv_buffer_size - Receiving buffer size. type: int
- redistribute - Redistribute configuration. type: list
- metric - Redistribute metric setting. type: int
- name - Redistribute name. type: str required: True
- routemap - Route map name. Source router.route-map.name. type: str
- status - status type: str choices: enable, disable
- timeout_timer - Timeout timer in seconds. type: int
- update_timer - Update timer in seconds. type: int
- version - RIP version. type: str choices: 1, 2
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: "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"
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