ansible.builtin.fortios_firewall_policy64 (v2.8.20) — module

Configure IPv6 to IPv4 policies in Fortinet's FortiOS and FortiGate.

| "added in version" 2.8 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure firewall feature and policy64 category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure IPv6 to IPv4 policies.
    fortios_firewall_policy64:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      firewall_policy64:
        state: "present"
        action: "accept"
        comments: "<your_own_value>"
        dstaddr:
         -
            name: "default_name_6 (source firewall.address.name firewall.addrgrp.name firewall.vip64.name firewall.vipgrp64.name)"
        dstintf: "<your_own_value> (source system.interface.name system.zone.name)"
        fixedport: "enable"
        ippool: "enable"
        logtraffic: "enable"
        per-ip-shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
        permit-any-host: "enable"
        policyid: "13"
        poolname:
         -
            name: "default_name_15 (source firewall.ippool.name)"
        schedule: "<your_own_value> (source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name)"
        service:
         -
            name: "default_name_18 (source firewall.service.custom.name firewall.service.group.name)"
        srcaddr:
         -
            name: "default_name_20 (source firewall.address6.name firewall.addrgrp6.name)"
        srcintf: "<your_own_value> (source system.zone.name system.interface.name)"
        status: "enable"
        tcp-mss-receiver: "23"
        tcp-mss-sender: "24"
        traffic-shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        traffic-shaper-reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
        uuid: "<your_own_value>"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

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.

https:
    default: false
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

firewall_policy64:
    default: null
    description:
    - Configure IPv6 to IPv4 policies.
    suboptions:
      action:
        choices:
        - accept
        - deny
        description:
        - Policy action.
      comments:
        description:
        - Comment.
      dstaddr:
        description:
        - Destination address name.
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip64.name
              firewall.vipgrp64.name.
            required: true
      dstintf:
        description:
        - Destination interface name. Source system.interface.name system.zone.name.
      fixedport:
        choices:
        - enable
        - disable
        description:
        - Enable/disable policy fixed port.
      ippool:
        choices:
        - enable
        - disable
        description:
        - Enable/disable policy64 IP pool.
      logtraffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable policy log traffic.
      per-ip-shaper:
        description:
        - Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name.
      permit-any-host:
        choices:
        - enable
        - disable
        description:
        - Enable/disable permit any host in.
      policyid:
        description:
        - Policy ID.
        required: true
      poolname:
        description:
        - Policy IP pool names.
        suboptions:
          name:
            description:
            - IP pool name. Source firewall.ippool.name.
            required: true
      schedule:
        description:
        - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name
          firewall.schedule.group.name.
      service:
        description:
        - Service name.
        suboptions:
          name:
            description:
            - Address name. Source firewall.service.custom.name firewall.service.group.name.
            required: true
      srcaddr:
        description:
        - Source address name.
        suboptions:
          name:
            description:
            - Address name. Source firewall.address6.name firewall.addrgrp6.name.
            required: true
      srcintf:
        description:
        - Source interface name. Source system.zone.name system.interface.name.
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable policy status.
      tcp-mss-receiver:
        description:
        - TCP MSS value of receiver.
      tcp-mss-sender:
        description:
        - TCP MSS value of sender.
      traffic-shaper:
        description:
        - Traffic shaper. Source firewall.shaper.traffic-shaper.name.
      traffic-shaper-reverse:
        description:
        - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name.
      uuid:
        description:
        - Universally Unique Identifier (UUID; automatically assigned but can be manually
          reset).

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