fortios_router_multicast – Configure router multicast in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_router_multicast – Configure router multicast in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- This module is able to configure a FortiGate or FortiOS 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.2

## Requirements

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host - / required |  | FortiOS or FortiGate ip address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol
password - | Default: "" | FortiOS or FortiGate password.
router_multicast - | Default: null | Configure router multicast.
| interface - |  | PIM interfaces.
|  | bfd - | Choices: enable disable | Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).
|  | cisco-exclude-genid - | Choices: enable disable | Exclude GenID from hello packets (compatibility with old Cisco IOS).
|  | dr-priority - |  | DR election priority.
|  | hello-holdtime - |  | Time before old neighbor information expires (0 - 65535 sec, default = 105).
|  | hello-interval - |  | Interval between sending PIM hello messages (0 - 65535 sec, default = 30).
|  | igmp - |  | IGMP configuration options.
|  |  | access-group - |  | Groups IGMP hosts are allowed to join. Source router.access-list.name.
|  |  | immediate-leave-group - |  | Groups to drop membership for immediately after receiving IGMPv2 leave. Source router.access-list.name.
|  |  | last-member-query-count - |  | Number of group specific queries before removing group (2 - 7, default = 2).
|  |  | last-member-query-interval - |  | Timeout between IGMPv2 leave and removing group (1 - 65535 msec, default = 1000).
|  |  | query-interval - |  | Interval between queries to IGMP hosts (1 - 65535 sec, default = 125).
|  |  | query-max-response-time - |  | Maximum time to wait for a IGMP query response (1 - 25 sec, default = 10).
|  |  | query-timeout - |  | Timeout between queries before becoming querier for network (60 - 900, default = 255).
|  |  | router-alert-check - | Choices: enable disable | Enable/disable require IGMP packets contain router alert option.
|  |  | version - | Choices: 3 2 1 | Maximum version of IGMP to support.
|  | join-group - |  | Join multicast groups.
|  |  | address - / required |  | Multicast group IP address.
|  | multicast-flow - |  | Acceptable source for multicast group. Source router.multicast-flow.name.
|  | name - / required |  | Interface name. Source system.interface.name.
|  | neighbour-filter - |  | Routers acknowledged as neighbor routers. Source router.access-list.name.
|  | passive - | Choices: enable disable | Enable/disable listening to IGMP but not participating in PIM.
|  | pim-mode - | Choices: sparse-mode dense-mode | PIM operation mode.
|  | propagation-delay - |  | Delay flooding packets on this interface (100 - 5000 msec, default = 500).
|  | rp-candidate - | Choices: enable disable | Enable/disable compete to become RP in elections.
|  | rp-candidate-group - |  | Multicast groups managed by this RP. Source router.access-list.name.
|  | rp-candidate-interval - |  | RP candidate advertisement interval (1 - 16383 sec, default = 60).
|  | rp-candidate-priority - |  | Router's priority as RP.
|  | state-refresh-interval - |  | Interval between sending state-refresh packets (1 - 100 sec, default = 60).
|  | static-group - |  | Statically set multicast groups to forward out. Source router.multicast-flow.name.
|  | ttl-threshold - |  | Minimum TTL of multicast packets that will be forwarded (applied only to new multicast routes) (1 - 255, default = 1).
| multicast-routing - | Choices: enable disable | Enable/disable IP multicast routing.
| pim-sm-global - |  | PIM sparse-mode global settings.
|  | accept-register-list - |  | Sources allowed to register packets with this Rendezvous Point (RP). Source router.access-list.name.
|  | accept-source-list - |  | Sources allowed to send multicast traffic. Source router.access-list.name.
|  | bsr-allow-quick-refresh - | Choices: enable disable | Enable/disable accept BSR quick refresh packets from neighbors.
|  | bsr-candidate - | Choices: enable disable | Enable/disable allowing this router to become a bootstrap router (BSR).
|  | bsr-hash - |  | BSR hash length (0 - 32, default = 10).
|  | bsr-interface - |  | Interface to advertise as candidate BSR. Source system.interface.name.
|  | bsr-priority - |  | BSR priority (0 - 255, default = 0).
|  | cisco-crp-prefix - | Choices: enable disable | Enable/disable making candidate RP compatible with old Cisco IOS.
|  | cisco-ignore-rp-set-priority - | Choices: enable disable | Use only hash for RP selection (compatibility with old Cisco IOS).
|  | cisco-register-checksum - | Choices: enable disable | Checksum entire register packet(for old Cisco IOS compatibility).
|  | cisco-register-checksum-group - |  | Cisco register checksum only these groups. Source router.access-list.name.
|  | join-prune-holdtime - |  | Join/prune holdtime (1 - 65535, default = 210).
|  | message-interval - |  | Period of time between sending periodic PIM join/prune messages in seconds (1 - 65535, default = 60).
|  | null-register-retries - |  | Maximum retries of null register (1 - 20, default = 1).
|  | register-rate-limit - |  | Limit of packets/sec per source registered through this RP (0 - 65535, default = 0 which means unlimited).
|  | register-rp-reachability - | Choices: enable disable | Enable/disable check RP is reachable before registering packets.
|  | register-source - | Choices: disable interface ip-address | Override source address in register packets.
|  | register-source-interface - |  | Override with primary interface address. Source system.interface.name.
|  | register-source-ip - |  | Override with local IP address.
|  | register-supression - |  | Period of time to honor register-stop message (1 - 65535 sec, default = 60).
|  | rp-address - |  | Statically configure RP addresses.
|  |  | group - |  | Groups to use this RP. Source router.access-list.name.
|  |  | id - / required |  | ID.
|  |  | ip-address - |  | RP router address.
|  | rp-register-keepalive - |  | Timeout for RP receiving data on (S,G) tree (1 - 65535 sec, default = 185).
|  | spt-threshold - | Choices: enable disable | Enable/disable switching to source specific trees.
|  | spt-threshold-group - |  | Groups allowed to switch to source tree. Source router.access-list.name.
|  | ssm - | Choices: enable disable | Enable/disable source specific multicast.
|  | ssm-range - |  | Groups allowed to source specific multicast. Source router.access-list.name.
| route-limit - |  | Maximum number of multicast routes.
| route-threshold - |  | Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit.
username - / required |  | FortiOS or FortiGate username.
vdom - | 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

- 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"
      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:

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

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