fortinet.fortios.fortios_router_multicast6 – Configure IPv6 multicast 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_multicast6
.
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 multicast6 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 |
| Enable/Disable logging for task. | |||
router_multicast6 dictionary | Configure IPv6 multicast. | ||||
interface list / elements=string | Protocol Independent Multicast (PIM) interfaces. | ||||
hello_holdtime integer | Time before old neighbour information expires (1 - 65535 sec). | ||||
hello_interval integer | Interval between sending PIM hello messages (1 - 65535 sec).. | ||||
name string / required | Interface name. Source system.interface.name. | ||||
multicast_pmtu string |
| Enable/disable PMTU for IPv6 multicast. | |||
multicast_routing string |
| Enable/disable IPv6 multicast routing. | |||
pim_sm_global dictionary | PIM sparse-mode global settings. | ||||
register_rate_limit integer | Limit of packets/sec per source registered through this RP (0 means unlimited). | ||||
rp_address list / elements=string | Statically configured RP addresses. | ||||
id integer / required | ID of the entry. | ||||
ip6_address string | RP router IPv6 address. | ||||
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 multicast. fortios_router_multicast6: vdom: "{{ vdom }}" router_multicast6: interface: - hello_holdtime: "4" hello_interval: "5" name: "default_name_6 (source system.interface.name)" multicast_pmtu: "enable" multicast_routing: "enable" pim_sm_global: register_rate_limit: "10" rp_address: - id: "12" ip6_address: "<your_own_value>"
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_multicast6_module.html