W3cubDocs

/Ansible

fortinet.fortios.fortios_router_ospf6 – Configure IPv6 OSPF in Fortinet’s FortiOS and FortiGate.

Note

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

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_ospf6.

New in version 2.10: 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 ospf6 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
access_token string						Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean					Choices: no ← yes	Enable/Disable logging for task.
router_ospf6 dictionary						Configure IPv6 OSPF.
	abr_type string				Choices: cisco ibm standard	Area border router type.
	area list / elements=string					OSPF6 area configuration.
		authentication string			Choices: none ah esp	Authentication mode.
		default_cost integer				Summary default cost of stub or NSSA area.
		id string / required				Area entry IP address.
		ipsec_auth_alg string			Choices: md5 sha1 sha256 sha384 sha512	Authentication algorithm.
		ipsec_enc_alg string			Choices: None ← des 3des aes128 aes192 aes256	Encryption algorithm.
		ipsec_keys list / elements=string				IPsec authentication and encryption keys.
			auth_key string			Authentication key.
			enc_key string			Encryption key.
			spi integer / required			Security Parameters Index.
		key_rollover_interval integer				Key roll-over interval.
		nssa_default_information_originate string			Choices: enable disable	Enable/disable originate type 7 default into NSSA area.
		nssa_default_information_originate_metric integer				OSPFv3 default metric.
		nssa_default_information_originate_metric_type string			Choices: 1 2	OSPFv3 metric type for default routes.
		nssa_redistribution string			Choices: enable disable	Enable/disable redistribute into NSSA area.
		nssa_translator_role string			Choices: candidate never always	NSSA translator role type.
		range list / elements=string				OSPF6 area range configuration.
			advertise string		Choices: disable enable	Enable/disable advertise status.
			id integer / required			Range entry ID.
			prefix6 string			IPv6 prefix.
		stub_type string			Choices: no-summary summary	Stub summary setting.
		type string			Choices: regular nssa stub	Area type setting.
		virtual_link list / elements=string				OSPF6 virtual link configuration.
			authentication string		Choices: none ah esp area	Authentication mode.
			dead_interval integer			Dead interval.
			hello_interval integer			Hello interval.
			ipsec_auth_alg string		Choices: md5 sha1 sha256 sha384 sha512	Authentication algorithm.
			ipsec_enc_alg string		Choices: None ← des 3des aes128 aes192 aes256	Encryption algorithm.
			ipsec_keys list / elements=string			IPsec authentication and encryption keys.
				auth_key string		Authentication key.
				enc_key string		Encryption key.
				spi integer / required		Security Parameters Index.
			key_rollover_interval integer			Key roll-over interval.
			name string / required			Virtual link entry name.
			peer string			A.B.C.D, peer router ID.
			retransmit_interval integer			Retransmit interval.
			transmit_delay integer			Transmit delay.
	auto_cost_ref_bandwidth integer					Reference bandwidth in terms of megabits per second.
	bfd string				Choices: enable disable	Enable/disable Bidirectional Forwarding Detection (BFD).
	default_information_metric integer					Default information metric.
	default_information_metric_type string				Choices: 1 2	Default information metric type.
	default_information_originate string				Choices: enable always disable	Enable/disable generation of default route.
	default_information_route_map string					Default information route map. Source router.route-map.name.
	default_metric integer					Default metric of redistribute routes.
	log_neighbour_changes string				Choices: enable disable	Enable logging of OSPFv3 neighbour"s changes
	ospf6_interface list / elements=string					OSPF6 interface configuration.
		area_id string				A.B.C.D, in IPv4 address format.
		authentication string			Choices: none ah esp area	Authentication mode.
		bfd string			Choices: global enable disable	Enable/disable Bidirectional Forwarding Detection (BFD).
		cost integer				Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
		dead_interval integer				Dead interval.
		hello_interval integer				Hello interval.
		interface string				Configuration interface name. Source system.interface.name.
		ipsec_auth_alg string			Choices: md5 sha1 sha256 sha384 sha512	Authentication algorithm.
		ipsec_enc_alg string			Choices: None ← des 3des aes128 aes192 aes256	Encryption algorithm.
		ipsec_keys list / elements=string				IPsec authentication and encryption keys.
			auth_key string			Authentication key.
			enc_key string			Encryption key.
			spi integer / required			Security Parameters Index.
		key_rollover_interval integer				Key roll-over interval.
		mtu integer				MTU for OSPFv3 packets.
		mtu_ignore string			Choices: enable disable	Enable/disable ignoring MTU field in DBD packets.
		name string / required				Interface entry name.
		neighbor list / elements=string				OSPFv3 neighbors are used when OSPFv3 runs on non-broadcast media
			cost integer			Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
			ip6 string / required			IPv6 link local address of the neighbor.
			poll_interval integer			Poll interval time in seconds.
			priority integer			priority
		network_type string			Choices: broadcast point-to-point non-broadcast point-to-multipoint point-to-multipoint-non-broadcast	Network type.
		priority integer				priority
		retransmit_interval integer				Retransmit interval.
		status string			Choices: disable enable	Enable/disable OSPF6 routing on this interface.
		transmit_delay integer				Transmit delay.
	passive_interface list / elements=string					Passive interface configuration.
		name string / required				Passive interface name. Source system.interface.name.
	redistribute list / elements=string					Redistribute configuration.
		metric integer				Redistribute metric setting.
		metric_type string			Choices: 1 2	Metric type.
		name string / required				Redistribute name.
		routemap string				Route map name. Source router.route-map.name.
		status string			Choices: enable disable	status
	router_id string					A.B.C.D, in IPv4 address format.
	spf_timers string					SPF calculation frequency.
	summary_address list / elements=string					IPv6 address summary configuration.
		advertise string			Choices: disable enable	Enable/disable advertise status.
		id integer / required				Summary address entry ID.
		prefix6 string				IPv6 prefix.
		tag integer				Tag value.
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 IPv6 OSPF.
    fortios_router_ospf6:
      vdom:  "{{ vdom }}"
      router_ospf6:
        abr_type: "cisco"
        area:
         -
            authentication: "none"
            default_cost: "6"
            id:  "7"
            ipsec_auth_alg: "md5"
            ipsec_enc_alg: "null"
            ipsec_keys:
             -
                auth_key: "<your_own_value>"
                enc_key: "<your_own_value>"
                spi: "13"
            key_rollover_interval: "14"
            nssa_default_information_originate: "enable"
            nssa_default_information_originate_metric: "16"
            nssa_default_information_originate_metric_type: "1"
            nssa_redistribution: "enable"
            nssa_translator_role: "candidate"
            range:
             -
                advertise: "disable"
                id:  "22"
                prefix6: "<your_own_value>"
            stub_type: "no-summary"
            type: "regular"
            virtual_link:
             -
                authentication: "none"
                dead_interval: "28"
                hello_interval: "29"
                ipsec_auth_alg: "md5"
                ipsec_enc_alg: "null"
                ipsec_keys:
                 -
                    auth_key: "<your_own_value>"
                    enc_key: "<your_own_value>"
                    spi: "35"
                key_rollover_interval: "36"
                name: "default_name_37"
                peer: "<your_own_value>"
                retransmit_interval: "39"
                transmit_delay: "40"
        auto_cost_ref_bandwidth: "41"
        bfd: "enable"
        default_information_metric: "43"
        default_information_metric_type: "1"
        default_information_originate: "enable"
        default_information_route_map: "<your_own_value> (source router.route-map.name)"
        default_metric: "47"
        log_neighbour_changes: "enable"
        ospf6_interface:
         -
            area_id: "<your_own_value>"
            authentication: "none"
            bfd: "global"
            cost: "53"
            dead_interval: "54"
            hello_interval: "55"
            interface: "<your_own_value> (source system.interface.name)"
            ipsec_auth_alg: "md5"
            ipsec_enc_alg: "null"
            ipsec_keys:
             -
                auth_key: "<your_own_value>"
                enc_key: "<your_own_value>"
                spi: "62"
            key_rollover_interval: "63"
            mtu: "64"
            mtu_ignore: "enable"
            name: "default_name_66"
            neighbor:
             -
                cost: "68"
                ip6: "<your_own_value>"
                poll_interval: "70"
                priority: "71"
            network_type: "broadcast"
            priority: "73"
            retransmit_interval: "74"
            status: "disable"
            transmit_delay: "76"
        passive_interface:
         -
            name: "default_name_78 (source system.interface.name)"
        redistribute:
         -
            metric: "80"
            metric_type: "1"
            name: "default_name_82"
            routemap: "<your_own_value> (source router.route-map.name)"
            status: "enable"
        router_id: "<your_own_value>"
        spf_timers: "<your_own_value>"
        summary_address:
         -
            advertise: "disable"
            id:  "89"
            prefix6: "<your_own_value>"
            tag: "91"

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)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

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