fortinet.fortios.fortios_firewall_policy64 (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

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

- name: Configure IPv6 to IPv4 policies.
  fortinet.fortios.fortios_firewall_policy64:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_policy64:
          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"
          logtraffic_start: "enable"
          name: "default_name_12"
          per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
          permit_any_host: "enable"
          policyid: "<you_own_value>"
          poolname:
              -
                  name: "default_name_17 (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_20 (source firewall.service.custom.name firewall.service.group.name)"
          srcaddr:
              -
                  name: "default_name_22 (source firewall.address6.name firewall.addrgrp6.name)"
          srcintf: "<your_own_value> (source system.zone.name system.interface.name)"
          status: "enable"
          tcp_mss_receiver: "0"
          tcp_mss_sender: "0"
          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

    
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_policy64:
    default: null
    description:
    - Configure IPv6 to IPv4 policies.
    suboptions:
      action:
        choices:
        - accept
        - deny
        description:
        - Policy action.
        type: str
      comments:
        description:
        - Comment.
        type: str
      dstaddr:
        description:
        - Destination address name.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name firewall.vip64.name
              firewall.vipgrp64.name.
            required: true
            type: str
        type: list
      dstintf:
        description:
        - Destination interface name. Source system.interface.name system.zone.name.
        type: str
      fixedport:
        choices:
        - enable
        - disable
        description:
        - Enable/disable policy fixed port.
        type: str
      ippool:
        choices:
        - enable
        - disable
        description:
        - Enable/disable policy64 IP pool.
        type: str
      logtraffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable policy log traffic.
        type: str
      logtraffic_start:
        choices:
        - enable
        - disable
        description:
        - Record logs when a session starts and ends.
        type: str
      name:
        description:
        - Policy name.
        type: str
      per_ip_shaper:
        description:
        - Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name.
        type: str
      permit_any_host:
        choices:
        - enable
        - disable
        description:
        - Enable/disable permit any host in.
        type: str
      policyid:
        description:
        - Policy ID (0 - 4294967294). see <a href='#notes'>Notes</a>.
        required: true
        type: int
      poolname:
        description:
        - Policy IP pool names.
        elements: dict
        suboptions:
          name:
            description:
            - IP pool name. Source firewall.ippool.name.
            required: true
            type: str
        type: list
      schedule:
        description:
        - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name
          firewall.schedule.group.name.
        type: str
      service:
        description:
        - Service name.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.service.custom.name firewall.service.group.name.
            required: true
            type: str
        type: list
      srcaddr:
        description:
        - Source address name.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address6.name firewall.addrgrp6.name.
            required: true
            type: str
        type: list
      srcintf:
        description:
        - Source interface name. Source system.zone.name system.interface.name.
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable policy status.
        type: str
      tcp_mss_receiver:
        description:
        - TCP MSS value of receiver.
        type: int
      tcp_mss_sender:
        description:
        - TCP MSS value of sender.
        type: int
      traffic_shaper:
        description:
        - Traffic shaper. Source firewall.shaper.traffic-shaper.name.
        type: str
      traffic_shaper_reverse:
        description:
        - Reverse traffic shaper. 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