You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortios.fortios_router_rip – Configure RIP in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_router_rip.

New in version 2.10: of fortinet.fortios

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

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
member_path string	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.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
router_rip dictionary	Configure RIP.
default_information_originate string	Enable/disable generation of default route. Choices: enable disable
default_metric integer	Default metric.
distance list / elements=string	distance
access_list string	Access list for route destination. Source router.access-list.name.
distance integer	Distance (1 - 255).
id integer / required	Distance ID.
prefix string	Distance prefix.
distribute_list list / elements=string	Distribute list.
direction string	Distribute list direction. Choices: in out
id integer / required	Distribute list ID.
interface string	Distribute list interface name. Source system.interface.name.
listname string	Distribute access/prefix list name. Source router.access-list.name router.prefix-list.name.
status string	status Choices: enable disable
garbage_timer integer	Garbage timer in seconds.
interface list / elements=string	RIP interface configuration.
auth_keychain string	Authentication key-chain name. Source router.key-chain.name.
auth_mode string	Authentication mode. Choices: none text md5
auth_string string	Authentication string/password.
flags integer	flags
name string / required	Interface name. Source system.interface.name.
receive_version list / elements=string	Receive version. Choices: 1 2
send_version list / elements=string	Send version. Choices: 1 2
send_version2_broadcast string	Enable/disable broadcast version 1 compatible packets. Choices: disable enable
split_horizon string	Enable/disable split horizon. Choices: poisoned regular
split_horizon_status string	Enable/disable split horizon. Choices: enable disable
max_out_metric integer	Maximum metric allowed to output(0 means “not set”).
neighbor list / elements=string	neighbor
id integer / required	Neighbor entry ID.
ip string	IP address.
network list / elements=string	network
id integer / required	Network entry ID.
prefix string	Network prefix.
offset_list list / elements=string	Offset list.
access_list string	Access list name. Source router.access-list.name.
direction string	Offset list direction. Choices: in out
id integer / required	Offset-list ID.
interface string	Interface name. Source system.interface.name.
offset integer	offset
status string	status Choices: enable disable
passive_interface list / elements=string	Passive interface configuration.
name string / required	Passive interface name. Source system.interface.name.
recv_buffer_size integer	Receiving buffer size.
redistribute list / elements=string	Redistribute configuration.
metric integer	Redistribute metric setting.
name string / required	Redistribute name.
routemap string	Route map name. Source router.route-map.name.
status string	status Choices: enable disable
timeout_timer integer	Timeout timer in seconds.
update_timer integer	Update timer in seconds.
version string	RIP version. Choices: 1 2
vdom string	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: “root”

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_router_rip
    fortios_router_rip:
      vdom: root
      router_rip:
        default_information_originate: disable
        default_metric: 1
        garbage_timer: 120
        max_out_metric: 0
        recv_buffer_size: 655360
        timeout_timer: 180
        update_timer: 30
        version: '2'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
build string	Build number of the fortigate image Returned: always Sample: “1547”
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: “PUT”
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: “200”
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: “id”
name string	Name of the table used to fulfill the request Returned: always Sample: “urlfilter”
path string	Path of the table used to fulfill the request Returned: always Sample: “webfilter”
revision string	Internal revision number Returned: always Sample: “17.0.2.10658”
serial string	Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352”
status string	Indication of the operation’s result Returned: always Sample: “success”
vdom string	Virtual domain used Returned: always Sample: “root”
version string	Version of the FortiGate Returned: always Sample: “v5.6.3”

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)