W3cubDocs

/Ansible 2.10

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

Note

This plugin is part of the fortinet.fortios collection.

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.8: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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			Choices/Defaults	Comments
host string				FortiOS or FortiGate IP address.
https boolean			Choices: no yes ←	Indicates if the requests towards FortiGate must use HTTPS protocol.
password string			Default: ""	FortiOS or FortiGate password.
router_rip dictionary				Configure RIP.
	default_information_originate string		Choices: enable disable	Enable/disable generation of default route.
	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	Choices: in out	Distribute list direction.
		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	Choices: enable disable	status
	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	Choices: none text md5	Authentication mode.
		auth_string string		Authentication string/password.
		flags integer		flags
		name string / required		Interface name. Source system.interface.name.
		receive_version string	Choices: 1 2	Receive version.
		send_version string	Choices: 1 2	Send version.
		send_version2_broadcast string	Choices: disable enable	Enable/disable broadcast version 1 compatible packets.
		split_horizon string	Choices: poisoned regular	Enable/disable split horizon.
		split_horizon_status string	Choices: enable disable	Enable/disable split horizon.
	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	Choices: in out	Offset list direction.
		id integer / required		Offset-list ID.
		interface string		Interface name. Source system.interface.name.
		offset integer		offset
		status string	Choices: enable disable	status
	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	Choices: enable disable	status
	timeout_timer integer			Timeout timer in seconds.
	update_timer integer			Update timer in seconds.
	version string		Choices: 1 2	RIP version.
ssl_verify boolean added in 2.9 of fortinet.fortios			Choices: no yes ←	Ensures FortiGate certificate must be verified by a proper CA.
username string				FortiOS or FortiGate username.
vdom string			Default: "root"	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.

Notes

Note

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

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 here, the following are the fields unique to this module:

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

Authors

Link Zheng (@chillancezen)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Jie Xue (@JieX19)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_router_rip_module.html