fortios_firewall_multicast_address – Configure multicast addresses in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.


  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and multicast_address category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


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

  • ansible>=2.9

FortiOS Version Compatibility

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.2.0 v7.2.1 v7.2.2
fortios_firewall_multicast_address yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes


  • 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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • firewall_multicast_address - Configure multicast addresses. type: dict more...
    • associated_interface - Interface associated with the address object. When setting up a policy, only addresses associated with this interface are available. Source type: str more...
    • color - Integer value to determine the color of the icon in the GUI (1 - 32). type: int more...
    • comment - Comment. type: str more...
    • end_ip - Final IPv4 address (inclusive) in the range for the address. type: str more...
    • name - Multicast address name. type: str required: true more...
    • start_ip - First IPv4 address (inclusive) in the range for the address. type: str more...
    • subnet - Broadcast address and subnet. type: str more...
    • tagging - Config object tagging. type: list more...
      • category - Tag category. Source system.object-tagging.category. type: str more...
      • name - Tagging entry name. type: str more...
      • tags - Tags. type: list more...
        • name - Tag name. Source type: str more...
    • type - Type of address object: multicast IP address range or broadcast IP/mask to be treated as a multicast address. type: str choices: multicastrange, broadcastmask more...
    • visibility - Enable/disable visibility of the multicast address on the GUI. type: str choices: enable, disable more...



  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks


- hosts: fortigates
    - fortinet.fortios
  connection: httpapi
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  - name: Configure multicast addresses.
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
        associated_interface: "<your_own_value> (source"
        color: "0"
        comment: "Comment."
        end_ip: "<your_own_value>"
        name: "default_name_7"
        start_ip: "<your_own_value>"
        subnet: "<your_own_value>"
            category: "<your_own_value> (source system.object-tagging.category)"
            name: "default_name_12"
                name: "default_name_14 (source"
        type: "multicastrange"
        visibility: "enable"

Return Values

Common return values are documented:, 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:
  • 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


  • This module is not guaranteed to have a backwards compatible interface.


  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)


If you notice any issues in this documentation, you can create a pull request to improve it.