lix_fortinet.fortios.fortios_firewall_multicast_policy (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Requirements

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 multicast NAT policies.
    fortios_firewall_multicast_policy:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_multicast_policy:
        action: "accept"
        auto_asic_offload: "enable"
        comments: "<your_own_value>"
        dnat: "<your_own_value>"
        dstaddr:
         -
            name: "default_name_8 (source firewall.multicast-address.name)"
        dstintf: "<your_own_value> (source system.interface.name system.zone.name)"
        end_port: "65535"
        id:  "11"
        logtraffic: "enable"
        name: "default_name_13"
        protocol: "0"
        snat: "enable"
        snat_ip: "<your_own_value>"
        srcaddr:
         -
            name: "default_name_18 (source firewall.address.name firewall.addrgrp.name)"
        srcintf: "<your_own_value> (source system.interface.name system.zone.name)"
        start_port: "1"
        status: "enable"
        traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        uuid: "<your_own_value>"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

firewall_multicast_policy:
    default: null
    description:
    - Configure multicast NAT policies.
    suboptions:
      action:
        choices:
        - accept
        - deny
        description:
        - Accept or deny traffic matching the policy.
        type: str
      auto_asic_offload:
        choices:
        - enable
        - disable
        description:
        - Enable/disable offloading policy traffic for hardware acceleration.
        type: str
      comments:
        description:
        - Comment.
        type: str
      dnat:
        description:
        - IPv4 DNAT address used for multicast destination addresses.
        type: str
      dstaddr:
        description:
        - Destination address objects.
        elements: dict
        suboptions:
          name:
            description:
            - Destination address objects. Source firewall.multicast-address.name.
            type: str
        type: list
      dstintf:
        description:
        - Destination interface name. Source system.interface.name system.zone.name.
        type: str
      end_port:
        description:
        - Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535).
        type: int
      id:
        description:
        - Policy ID ((0 - 4294967294).
        required: true
        type: int
      logtraffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable logging traffic accepted by this policy.
        type: str
      name:
        description:
        - Policy name.
        type: str
      protocol:
        description:
        - Integer value for the protocol type as defined by IANA (0 - 255).
        type: int
      snat:
        choices:
        - enable
        - disable
        description:
        - Enable/disable substitution of the outgoing interface IP address for the original
          source IP address (called source NAT or SNAT).
        type: str
      snat_ip:
        description:
        - IPv4 address to be used as the source address for NATed traffic.
        type: str
      srcaddr:
        description:
        - Source address objects.
        elements: dict
        suboptions:
          name:
            description:
            - Source address objects. Source firewall.address.name firewall.addrgrp.name.
            type: str
        type: list
      srcintf:
        description:
        - Source interface name. Source system.interface.name system.zone.name.
        type: str
      start_port:
        description:
        - Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535).
        type: int
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this policy.
        type: str
      traffic_shaper:
        description:
        - Traffic shaper to apply to traffic forwarded by the multicast policy. Source
          firewall.shaper.traffic-shaper.name.
        type: str
      uuid:
        description:
        - Universally Unique Identifier (UUID; automatically assigned but can be manually
          reset).
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str