fortios_firewall_policy46.rst

source:	fortios_firewall_policy46.py
orphan:

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

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and policy46 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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_firewall_policy46	v6.0.0 -> v7.0.0

Parameters

• 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_policy46 - Configure IPv4 to IPv6 policies. type: dict more...

  	Supported Version Ranges
  firewall_policy46	v6.0.0 -> v7.0.0

• action - Accept or deny traffic matching the policy. type: str choices: accept, deny more...

  	Supported Version Ranges
  action	v6.0.0 -> v7.0.0
  [accept]	v6.0.0 -> latest
  [deny]	v6.0.0 -> latest

• comments - Comment. type: str more...

  	Supported Version Ranges
  comments	v6.0.0 -> v7.0.0

• dstaddr - Destination address objects. type: list member_path: dstaddr:name more...

  	Supported Version Ranges
  dstaddr	v6.0.0 -> v7.0.0

• name - Address name. Source firewall.vip46.name firewall.vipgrp46.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> v7.0.0

• dstintf - Destination interface name. Source system.interface.name system.zone.name. type: str more...

  	Supported Version Ranges
  dstintf	v6.0.0 -> v7.0.0

• fixedport - Enable/disable fixed port for this policy. type: str choices: enable, disable more...

  	Supported Version Ranges
  fixedport	v6.0.0 -> v7.0.0
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• ippool - Enable/disable use of IP Pools for source NAT. type: str choices: enable, disable more...

  	Supported Version Ranges
  ippool	v6.0.0 -> v7.0.0
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• logtraffic - Enable/disable traffic logging for this policy. type: str choices: enable, disable more...

  	Supported Version Ranges
  logtraffic	v6.0.0 -> v7.0.0
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• logtraffic_start - Record logs when a session starts and ends. type: str choices: enable, disable more...

  	Supported Version Ranges
  logtraffic_start	v6.2.0 -> v7.0.0
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• name - Policy name. type: str more...

  	Supported Version Ranges
  name	v6.4.0 -> v6.4.0	v6.4.4 -> v7.0.0

• per_ip_shaper - Per IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. type: str more...

  	Supported Version Ranges
  per_ip_shaper	v6.0.0 -> v7.0.0

• permit_any_host - Enable/disable allowing any host. type: str choices: enable, disable more...

  	Supported Version Ranges
  permit_any_host	v6.0.0 -> v7.0.0
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• policyid - Policy ID (0 - 4294967294). see Notes. type: int required: true more...

  	Supported Version Ranges
  policyid	v6.0.0 -> v7.0.0

• poolname - IP Pool names. type: list member_path: poolname:name more...

  	Supported Version Ranges
  poolname	v6.0.0 -> v7.0.0

• name - IP pool name. Source firewall.ippool6.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> v7.0.0

• schedule - Schedule name. Source firewall.schedule.onetime.name firewall.schedule.recurring.name firewall.schedule.group.name. type: str more...

  	Supported Version Ranges
  schedule	v6.0.0 -> v7.0.0

• service - Service name. type: list member_path: service:name more...

  	Supported Version Ranges
  service	v6.0.0 -> v7.0.0

• name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> v7.0.0

• srcaddr - Source address objects. type: list member_path: srcaddr:name more...

  	Supported Version Ranges
  srcaddr	v6.0.0 -> v7.0.0

• name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> v7.0.0

• srcintf - Source interface name. Source system.zone.name system.interface.name. type: str more...

  	Supported Version Ranges
  srcintf	v6.0.0 -> v7.0.0

• status - Enable/disable this policy. type: str choices: enable, disable more...

  	Supported Version Ranges
  status	v6.0.0 -> v7.0.0
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• tcp_mss_receiver - TCP Maximum Segment Size value of receiver (0 - 65535) type: int more...

  	Supported Version Ranges
  tcp_mss_receiver	v6.0.0 -> v7.0.0

• tcp_mss_sender - TCP Maximum Segment Size value of sender (0 - 65535). type: int more...

  	Supported Version Ranges
  tcp_mss_sender	v6.0.0 -> v7.0.0

• traffic_shaper - Traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str more...

  	Supported Version Ranges
  traffic_shaper	v6.0.0 -> v7.0.0

• traffic_shaper_reverse - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. type: str more...

  	Supported Version Ranges
  traffic_shaper_reverse	v6.0.0 -> v7.0.0

• uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...

  	Supported Version Ranges
  uuid	v6.0.0 -> v7.0.0

Notes

Note

• We highly recommend using your own value as the policyid instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure IPv4 to IPv6 policies.
  fortinet.fortios.fortios_firewall_policy46:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_policy46:
          action: "accept"
          comments: "<your_own_value>"
          dstaddr:
              -
                  name: "default_name_6 (source firewall.vip46.name firewall.vipgrp46.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.ippool6.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.address.name firewall.addrgrp.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>"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, 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: 17.0.2.10658
• 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

Status

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

Authors

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

Hint

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