fortios_router_multicast – Configure router multicast in Fortinet’s FortiOS and FortiGate¶
New in version 2.8.
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.5
Requirements¶
The below requirements are needed on the host that executes this module.
fortiosapi>=0.9.8
Parameters¶
Notes¶
Note
Requires fortiosapi library developed by Fortinet
Run as a local_action in your playbook
Examples¶
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure router multicast.
fortios_router_multicast:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
router_multicast:
interface:
-
bfd: "enable"
cisco_exclude_genid: "enable"
dr_priority: "6"
hello_holdtime: "7"
hello_interval: "8"
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: "12"
last_member_query_interval: "13"
query_interval: "14"
query_max_response_time: "15"
query_timeout: "16"
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: "26"
rp_candidate: "enable"
rp_candidate_group: "<your_own_value> (source router.access-list.name)"
rp_candidate_interval: "29"
rp_candidate_priority: "30"
state_refresh_interval: "31"
static_group: "<your_own_value> (source router.multicast-flow.name)"
ttl_threshold: "33"
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: "40"
bsr_interface: "<your_own_value> (source system.interface.name)"
bsr_priority: "42"
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: "47"
message_interval: "48"
null_register_retries: "49"
register_rate_limit: "50"
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: "55"
rp_address:
-
group: "<your_own_value> (source router.access-list.name)"
id: "58"
ip_address: "<your_own_value>"
rp_register_keepalive: "60"
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: "65"
route_threshold: "66"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Authors¶
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.