fortiswitch_router_rip – RIP configuration in Fortinet’s FortiSwitch
New in version 1.0.0.
Synopsis
This module is able to configure a FortiSwitch 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 v7.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.14
FortiSW Version Compatibility
| Supported Version Ranges | |
| fortiswitch_router_rip | v7.0.0 -> latest |
Parameters
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- 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 - RIP configuration. type: dict
- bfd - Bidirectional Forwarding Detection (BFD). type: str choices: enable, disable
- default_information_originate - Generate a default route. type: str choices: enable, disable
- default_metric - Default metric of redistribute routes (Except connected). type: int
- distance - Set admin distance based on route source ip. type: list
- access_list - Access list for route destination. type: str
- distance - Distance. type: int
- id - Distance id. type: int
- prefix - IP source prefix. type: str
- distribute_list - Filter networks in routing updates. type: list
- direction - Distribute list direction. type: str choices: in, out
- id - Distribute-list id. type: int
- interface - Distribute list interface name. type: str
- listname - Distribute access/prefix list name. type: str
- status - Status. type: str choices: enable, disable
- garbage_timer - Garbage collection timer. type: int
- interface - RIP interface configuration type: list
- auth_keychain - Authentication keychain 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 type: str
- receive_version - Receive version. type: str choices: global, 1, 2, both
- send_version - Send version. type: str choices: global, 1, 2, both
- send_version2_broadcast - broadcast version 1 compatible packets type: str choices: disable, enable
- split_horizon - Split horizon method. type: str choices: poisoned, regular
- split_horizon_status - Split horizon status. type: str choices: enable, disable
- name - Vrf name. type: str
- neighbor - Specify a neighbor router. Required only for non-multicast networks. type: list
- id - Neighbor entry id. type: int
- ip - IP address. type: str
- network - Enable RIP routing on an IP network. type: list
- id - Network entry id. type: int
- prefix - Network prefix. type: str
- offset_list - Offset list to modify RIP metric. type: list
- access_list - Access list name. type: str
- direction - Offset list direction. type: str choices: in, out
- id - Offset-list id. type: int
- interface - Interface to match. type: str
- offset - Metric value. type: int
- status - Status. type: str choices: enable, disable
- passive_interface - Passive interface configuration. type: list
- name - Passive interface name. type: str
- recv_buffer_size - receiving buffer size type: int
- redistribute - Redistribute configuration. type: list
- flags - flags type: int
- metric - Redistribute metric setting. type: int
- name - Redistribute name. type: str
- routemap - Route map name. type: str
- status - status type: str choices: enable, disable
- timeout_timer - Routing information timeout timer. type: int
- update_timer - Routing table update timer. type: int
- version - RIP version type: str choices: 1, 2
- vrf - Enable RIP on VRF. type: list
- default_information_originate - Generate a default route. type: str choices: enable, disable
- default_metric - Default metric of redistribute routes (Except connected). type: int
- distance - Set admin distance based on route source ip. type: list
- access_list - Access list for route destination. type: str
- distance - Distance. type: int
- id - Distance id. type: int
- prefix - IP source prefix. type: str
- distribute_list - Filter networks in routing updates. type: list
- direction - Distribute list direction. type: str choices: in, out
- id - Distribute-list id. type: int
- interface - Distribute list interface name. type: str
- listname - Distribute access/prefix list name. type: str
- status - Status. type: str choices: enable, disable
- garbage_timer - Garbage collection timer. type: int
- interface - RIP interface configuration type: list
- auth_keychain - Authentication keychain 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 type: str
- receive_version - Receive version. type: str choices: global, 1, 2, both
- send_version - Send version. type: str choices: global, 1, 2, both
- send_version2_broadcast - broadcast version 1 compatible packets type: str choices: disable, enable
- split_horizon - Split horizon method. type: str choices: poisoned, regular
- split_horizon_status - Split horizon status. type: str choices: enable, disable
- name - Vrf name. type: str
- neighbor - Specify a neighbor router. Required only for non-multicast networks. type: list
- id - Neighbor entry id. type: int
- ip - IP address. type: str
- network - Enable RIP routing on an IP network. type: list
- id - Network entry id. type: int
- prefix - Network prefix. type: str
- offset_list - Offset list to modify RIP metric. type: list
- access_list - Access list name. type: str
- direction - Offset list direction. type: str choices: in, out
- id - Offset-list id. type: int
- interface - Interface to match. type: str
- offset - Metric value. type: int
- status - Status. type: str choices: enable, disable
- passive_interface - Passive interface configuration. type: list
- name - Passive interface name. type: str
- recv_buffer_size - receiving buffer size type: int
- redistribute - Redistribute configuration. type: list
- flags - flags type: int
- metric - Redistribute metric setting. type: int
- name - Redistribute name. type: str
- routemap - Route map name. type: str
- status - status type: str choices: enable, disable
- timeout_timer - Routing information timeout timer. type: int
- update_timer - Routing table update timer. type: int
- version - RIP version type: str choices: 1, 2
Examples
- name: RIP configuration.
fortinet.fortiswitch.fortiswitch_router_rip:
router_rip:
bfd: "enable"
default_information_originate: "enable"
default_metric: "5"
distance:
-
access_list: "<your_own_value> (source router.access-list.name)"
distance: "8"
id: "9"
prefix: "<your_own_value>"
distribute_list:
-
direction: "in"
id: "13"
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: "17"
interface:
-
auth_keychain: "<your_own_value> (source router.key-chain.name)"
auth_mode: "none"
auth_string: "<your_own_value>"
flags: "22"
name: "default_name_23 (source system.interface.name)"
receive_version: "global"
send_version: "global"
send_version2_broadcast: "disable"
split_horizon: "poisoned"
split_horizon_status: "enable"
name: "default_name_29"
neighbor:
-
id: "31"
ip: "<your_own_value>"
network:
-
id: "34"
prefix: "<your_own_value>"
offset_list:
-
access_list: "<your_own_value> (source router.access-list.name)"
direction: "in"
id: "39"
interface: "<your_own_value> (source system.interface.name)"
offset: "41"
status: "enable"
passive_interface:
-
name: "default_name_44 (source system.interface.name)"
recv_buffer_size: "45"
redistribute:
-
flags: "47"
metric: "48"
name: "default_name_49"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
timeout_timer: "52"
update_timer: "53"
version: "1"
vrf:
-
default_information_originate: "enable"
default_metric: "57"
distance:
-
access_list: "<your_own_value> (source router.access-list.name)"
distance: "60"
id: "61"
prefix: "<your_own_value>"
distribute_list:
-
direction: "in"
id: "65"
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: "69"
interface:
-
auth_keychain: "<your_own_value> (source router.key-chain.name)"
auth_mode: "none"
auth_string: "<your_own_value>"
flags: "74"
name: "default_name_75 (source system.interface.name)"
receive_version: "global"
send_version: "global"
send_version2_broadcast: "disable"
split_horizon: "poisoned"
split_horizon_status: "enable"
name: "default_name_81 (source router.vrf.name)"
neighbor:
-
id: "83"
ip: "<your_own_value>"
network:
-
id: "86"
prefix: "<your_own_value>"
offset_list:
-
access_list: "<your_own_value> (source router.access-list.name)"
direction: "in"
id: "91"
interface: "<your_own_value> (source system.interface.name)"
offset: "93"
status: "enable"
passive_interface:
-
name: "default_name_96 (source system.interface.name)"
recv_buffer_size: "97"
redistribute:
-
flags: "99"
metric: "100"
name: "default_name_101"
routemap: "<your_own_value> (source router.route-map.name)"
status: "enable"
timeout_timer: "104"
update_timer: "105"
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 fortiSwitch image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
- http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiSwitch 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
- serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
- status - Indication of the operation's result returned: always type: str sample: success
- version - Version of the FortiSwitch returned: always type: str sample: v7.0.0
Status
This module is not guaranteed to have a backwards compatible interface.