fortios_router_multicast – Configure router multicast in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- router_multicast - Configure router multicast. type: dict more...
- interface - PIM interfaces. type: list member_path: interface:name more...
- bfd - Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD). type: str choices: enable, disable more...
- cisco_exclude_genid - Exclude GenID from hello packets (compatibility with old Cisco IOS). type: str choices: enable, disable more...
- dr_priority - DR election priority. type: int more...
- hello_holdtime - Time before old neighbor information expires (0 - 65535 sec). type: int more...
- hello_interval - Interval between sending PIM hello messages (0 - 65535 sec). type: int more...
- igmp - IGMP configuration options. type: dict more...
- access_group - Groups IGMP hosts are allowed to join. Source router.access-list.name. type: str more...
- immediate_leave_group - Groups to drop membership for immediately after receiving IGMPv2 leave. Source router.access-list.name. type: str more...
- last_member_query_count - Number of group specific queries before removing group (2 - 7). type: int more...
- last_member_query_interval - Timeout between IGMPv2 leave and removing group (1 - 65535 msec). type: int more...
- query_interval - Interval between queries to IGMP hosts (1 - 65535 sec). type: int more...
- query_max_response_time - Maximum time to wait for a IGMP query response (1 - 25 sec). type: int more...
- query_timeout - Timeout between queries before becoming querying unit for network (60 - 900). type: int more...
- router_alert_check - Enable/disable require IGMP packets contain router alert option. type: str choices: enable, disable more...
- version - Maximum version of IGMP to support. type: str choices: 3, 2, 1 more...
- join_group - Join multicast groups. type: list member_path: interface:name/join_group:address more...
- address - Multicast group IP address. type: str required: true more...
- multicast_flow - Acceptable source for multicast group. Source router.multicast-flow.name. type: str more...
- name - Interface name. Source system.interface.name. type: str required: true more...
- neighbour_filter - Routers acknowledged as neighbor routers. Source router.access-list.name. type: str more...
- passive - Enable/disable listening to IGMP but not participating in PIM. type: str choices: enable, disable more...
- pim_mode - PIM operation mode. type: str choices: sparse-mode, dense-mode more...
- propagation_delay - Delay flooding packets on this interface (100 - 5000 msec). type: int more...
- rp_candidate - Enable/disable compete to become RP in elections. type: str choices: enable, disable more...
- rp_candidate_group - Multicast groups managed by this RP. Source router.access-list.name. type: str more...
- rp_candidate_interval - RP candidate advertisement interval (1 - 16383 sec). type: int more...
- rp_candidate_priority - Router"s priority as RP. type: int more...
- rpf_nbr_fail_back - Enable/disable fail back for RPF neighbor query. type: str choices: enable, disable more...
- rpf_nbr_fail_back_filter - Filter for fail back RPF neighbors. Source router.access-list.name. type: str more...
- state_refresh_interval - Interval between sending state-refresh packets (1 - 100 sec). type: int more...
- static_group - Statically set multicast groups to forward out. Source router.multicast-flow.name. type: str more...
- ttl_threshold - Minimum TTL of multicast packets that will be forwarded (applied only to new multicast routes) (1 - 255). type: int more...
- multicast_routing - Enable/disable IP multicast routing. type: str choices: enable, disable more...
- pim_sm_global - PIM sparse-mode global settings. type: dict more...
- accept_register_list - Sources allowed to register packets with this Rendezvous Point (RP). Source router.access-list.name. type: str more...
- accept_source_list - Sources allowed to send multicast traffic. Source router.access-list.name. type: str more...
- bsr_allow_quick_refresh - Enable/disable accept BSR quick refresh packets from neighbors. type: str choices: enable, disable more...
- bsr_candidate - Enable/disable allowing this router to become a bootstrap router (BSR). type: str choices: enable, disable more...
- bsr_hash - BSR hash length (0 - 32). type: int more...
- bsr_interface - Interface to advertise as candidate BSR. Source system.interface.name. type: str more...
- bsr_priority - BSR priority (0 - 255). type: int more...
- cisco_crp_prefix - Enable/disable making candidate RP compatible with old Cisco IOS. type: str choices: enable, disable more...
- cisco_ignore_rp_set_priority - Use only hash for RP selection (compatibility with old Cisco IOS). type: str choices: enable, disable more...
- cisco_register_checksum - Checksum entire register packet(for old Cisco IOS compatibility). type: str choices: enable, disable more...
- cisco_register_checksum_group - Cisco register checksum only these groups. Source router.access-list.name. type: str more...
- join_prune_holdtime - Join/prune holdtime (1 - 65535). type: int more...
- message_interval - Period of time between sending periodic PIM join/prune messages in seconds (1 - 65535). type: int more...
- null_register_retries - Maximum retries of null register (1 - 20). type: int more...
- pim_use_sdwan - Enable/disable use of SDWAN when checking RPF neighbor and sending of REG packet. type: str choices: enable, disable more...
- register_rate_limit - Limit of packets/sec per source registered through this RP (0 - 65535). type: int more...
- register_rp_reachability - Enable/disable check RP is reachable before registering packets. type: str choices: enable, disable more...
- register_source - Override source address in register packets. type: str choices: disable, interface, ip-address more...
- register_source_interface - Override with primary interface address. Source system.interface.name. type: str more...
- register_source_ip - Override with local IP address. type: str more...
- register_supression - Period of time to honor register-stop message (1 - 65535 sec). type: int more...
- rp_address - Statically configure RP addresses. type: list member_path: pim_sm_global/rp_address:id more...
- group - Groups to use this RP. Source router.access-list.name. type: str more...
- id - ID. see Notes. type: int required: true more...
- ip_address - RP router address. type: str more...
- rp_register_keepalive - Timeout for RP receiving data on (S,G) tree (1 - 65535 sec). type: int more...
- spt_threshold - Enable/disable switching to source specific trees. type: str choices: enable, disable more...
- spt_threshold_group - Groups allowed to switch to source tree. Source router.access-list.name. type: str more...
- ssm - Enable/disable source specific multicast. type: str choices: enable, disable more...
- ssm_range - Groups allowed to source specific multicast. Source router.access-list.name. type: str more...
- route_limit - Maximum number of multicast routes. type: int more...
- route_threshold - Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit. type: int more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.