fortinet.fortios.fortios_router_multicast module – Configure router multicast in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.9).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_router_multicast.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and multicast 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.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Configure router multicast. |
|
PIM interfaces. |
|
Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD). Choices:
|
|
Exclude GenID from hello packets (compatibility with old Cisco IOS). Choices:
|
|
DR election priority. |
|
Time before old neighbor information expires (0 - 65535 sec). |
|
Interval between sending PIM hello messages (0 - 65535 sec). |
|
IGMP configuration options. |
|
Groups IGMP hosts are allowed to join. Source router.access-list.name. |
|
Groups to drop membership for immediately after receiving IGMPv2 leave. Source router.access-list.name. |
|
Number of group specific queries before removing group (2 - 7). |
|
Timeout between IGMPv2 leave and removing group (1 - 65535 msec). |
|
Interval between queries to IGMP hosts (1 - 65535 sec). |
|
Maximum time to wait for a IGMP query response (1 - 25 sec). |
|
Timeout between queries before becoming querying unit for network (60 - 900). |
|
Enable/disable require IGMP packets contain router alert option. Choices:
|
|
Maximum version of IGMP to support. Choices:
|
|
Join multicast groups. |
|
Multicast group IP address. |
|
Acceptable source for multicast group. Source router.multicast-flow.name. |
|
Interface name. Source system.interface.name. |
|
Routers acknowledged as neighbor routers. Source router.access-list.name. |
|
Enable/disable listening to IGMP but not participating in PIM. Choices:
|
|
PIM operation mode. Choices:
|
|
Delay flooding packets on this interface (100 - 5000 msec). |
|
Enable/disable compete to become RP in elections. Choices:
|
|
Multicast groups managed by this RP. Source router.access-list.name. |
|
RP candidate advertisement interval (1 - 16383 sec). |
|
Router”s priority as RP. |
|
Enable/disable fail back for RPF neighbor query. Choices:
|
|
Filter for fail back RPF neighbors. Source router.access-list.name. |
|
Interval between sending state-refresh packets (1 - 100 sec). |
|
Statically set multicast groups to forward out. Source router.multicast-flow.name. |
|
Minimum TTL of multicast packets that will be forwarded (applied only to new multicast routes) (1 - 255). |
|
Enable/disable IP multicast routing. Choices:
|
|
PIM sparse-mode global settings. |
|
Sources allowed to register packets with this Rendezvous Point (RP). Source router.access-list.name. |
|
Sources allowed to send multicast traffic. Source router.access-list.name. |
|
Enable/disable accept BSR quick refresh packets from neighbors. Choices:
|
|
Enable/disable allowing this router to become a bootstrap router (BSR). Choices:
|
|
BSR hash length (0 - 32). |
|
Interface to advertise as candidate BSR. Source system.interface.name. |
|
BSR priority (0 - 255). |
|
Enable/disable making candidate RP compatible with old Cisco IOS. Choices:
|
|
Use only hash for RP selection (compatibility with old Cisco IOS). Choices:
|
|
Checksum entire register packet(for old Cisco IOS compatibility). Choices:
|
|
Cisco register checksum only these groups. Source router.access-list.name. |
|
Join/prune holdtime (1 - 65535). |
|
Period of time between sending periodic PIM join/prune messages in seconds (1 - 65535). |
|
Maximum retries of null register (1 - 20). |
|
Enable/disable use of SDWAN when checking RPF neighbor and sending of REG packet. Choices:
|
|
Limit of packets/sec per source registered through this RP (0 - 65535). |
|
Enable/disable check RP is reachable before registering packets. Choices:
|
|
Override source address in register packets. Choices:
|
|
Override with primary interface address. Source system.interface.name. |
|
Override with local IP address. |
|
Period of time to honor register-stop message (1 - 65535 sec). |
|
Statically configure RP addresses. |
|
Groups to use this RP. Source router.access-list.name. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
RP router address. |
|
Timeout for RP receiving data on (S,G) tree (1 - 65535 sec). |
|
Enable/disable switching to source specific trees. Choices:
|
|
Groups allowed to switch to source tree. Source router.access-list.name. |
|
Enable/disable source specific multicast. Choices:
|
|
Groups allowed to source specific multicast. Source router.access-list.name. |
|
Maximum number of multicast routes. |
|
Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit. |
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure router multicast.
fortinet.fortios.fortios_router_multicast:
vdom: "{{ vdom }}"
router_multicast:
interface:
-
bfd: "enable"
cisco_exclude_genid: "enable"
dr_priority: "1"
hello_holdtime: "105"
hello_interval: "30"
igmp:
access_group: "<your_own_value> (source router.access-list.name)"
immediate_leave_group: "<your_own_value> (source router.access-list.name)"
last_member_query_count: "2"
last_member_query_interval: "1000"
query_interval: "125"
query_max_response_time: "10"
query_timeout: "255"
router_alert_check: "enable"
version: "3"
join_group:
-
address: "<your_own_value>"
multicast_flow: "<your_own_value> (source router.multicast-flow.name)"
name: "default_name_22 (source system.interface.name)"
neighbour_filter: "<your_own_value> (source router.access-list.name)"
passive: "enable"
pim_mode: "sparse-mode"
propagation_delay: "500"
rp_candidate: "enable"
rp_candidate_group: "<your_own_value> (source router.access-list.name)"
rp_candidate_interval: "60"
rp_candidate_priority: "192"
rpf_nbr_fail_back: "enable"
rpf_nbr_fail_back_filter: "<your_own_value> (source router.access-list.name)"
state_refresh_interval: "60"
static_group: "<your_own_value> (source router.multicast-flow.name)"
ttl_threshold: "1"
multicast_routing: "enable"
pim_sm_global:
accept_register_list: "<your_own_value> (source router.access-list.name)"
accept_source_list: "<your_own_value> (source router.access-list.name)"
bsr_allow_quick_refresh: "enable"
bsr_candidate: "enable"
bsr_hash: "10"
bsr_interface: "<your_own_value> (source system.interface.name)"
bsr_priority: "0"
cisco_crp_prefix: "enable"
cisco_ignore_rp_set_priority: "enable"
cisco_register_checksum: "enable"
cisco_register_checksum_group: "<your_own_value> (source router.access-list.name)"
join_prune_holdtime: "210"
message_interval: "60"
null_register_retries: "1"
pim_use_sdwan: "enable"
register_rate_limit: "0"
register_rp_reachability: "enable"
register_source: "disable"
register_source_interface: "<your_own_value> (source system.interface.name)"
register_source_ip: "<your_own_value>"
register_supression: "60"
rp_address:
-
group: "<your_own_value> (source router.access-list.name)"
id: "61"
ip_address: "<your_own_value>"
rp_register_keepalive: "185"
spt_threshold: "enable"
spt_threshold_group: "<your_own_value> (source router.access-list.name)"
ssm: "enable"
ssm_range: "<your_own_value> (source router.access-list.name)"
route_limit: "2147483647"
route_threshold: ""
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |