fortinet.fortios.fortios_firewall_multicast_policy6 – Configure IPv6 multicast NAT policies in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_multicast_policy6.
New in version 2.10: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and multicast_policy6 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.9.0
 
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
|   access_token    string    |    Token-based authentication. Generated from GUI of Fortigate.   |  |||
|   enable_log    boolean    |   
  |    Enable/Disable logging for task.   |  ||
|   firewall_multicast_policy6    dictionary    |    Configure IPv6 multicast NAT policies.   |  |||
|   action    string    |   
  |    Accept or deny traffic matching the policy.   |  ||
|   auto_asic_offload    string    |   
  |    Enable/disable offloading policy traffic for hardware acceleration.   |  ||
|   comments    string    |    Comment.   |  |||
|   dstaddr    list / elements=string    |    IPv6 destination address name.   |  |||
|   name    string / required    |    Address name. Source firewall.multicast-address6.name.   |  |||
|   dstintf    string    |    IPv6 destination interface name. Source system.interface.name system.zone.name.   |  |||
|   end_port    integer    |    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535).   |  |||
|   id    integer / required    |    Policy ID.   |  |||
|   logtraffic    string    |   
  |    Enable/disable logging traffic accepted by this policy.   |  ||
|   name    string    |    Policy name.   |  |||
|   protocol    integer    |    Integer value for the protocol type as defined by IANA (0 - 255).   |  |||
|   srcaddr    list / elements=string    |    IPv6 source address name.   |  |||
|   name    string / required    |    Address name. Source firewall.address6.name firewall.addrgrp6.name.   |  |||
|   srcintf    string    |    IPv6 source interface name. Source system.interface.name system.zone.name.   |  |||
|   start_port    integer    |    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535).   |  |||
|   status    string    |   
  |    Enable/disable this policy.   |  ||
|   uuid    string    |    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).   |  |||
|   state    string / required    |   
  |    Indicates whether to create or remove the object.   |  ||
|   vdom    string    |   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
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
 
Examples
- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure IPv6 multicast NAT policies.
    fortios_firewall_multicast_policy6:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_multicast_policy6:
        action: "accept"
        auto_asic_offload: "enable"
        comments: "<your_own_value>"
        dstaddr:
         -
            name: "default_name_7 (source firewall.multicast-address6.name)"
        dstintf: "<your_own_value> (source system.interface.name system.zone.name)"
        end_port: "9"
        id:  "10"
        logtraffic: "enable"
        name: "default_name_12"
        protocol: "13"
        srcaddr:
         -
            name: "default_name_15 (source firewall.address6.name firewall.addrgrp6.name)"
        srcintf: "<your_own_value> (source system.interface.name system.zone.name)"
        start_port: "17"
        status: "enable"
        uuid: "<your_own_value>"
   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   |  
Authors
- Link Zheng (@chillancezen)
 - Jie Xue (@JieX19)
 - Hongbin Lu (@fgtdev-hblu)
 - Frank Shen (@frankshen01)
 - Miguel Angel Munoz (@mamunozgonzalez)
 - Nicolas Thomas (@thomnico)
 
    © 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_multicast_policy6_module.html