fmgr_pkg_firewall_policy6 – Configure IPv6 policies.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0
pkg_firewall_policy6 yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • pkg - The parameter in requested url type: str required: true
  • pkg_firewall_policy6 - no description type: dict
    • action - Policy action (allow/deny/ipsec). type: str choices: [deny, accept, ipsec, ssl-vpn] more...
    • app-category - Application category ID list. type: str more...
    • application - Application ID list. type: int more...
    • application-list - Name of an existing Application list. type: str more...
    • auto-asic-offload - Enable/disable policy traffic ASIC offloading. type: str choices: [disable, enable] more...
    • av-profile - Name of an existing Antivirus profile. type: str more...
    • comments - Comment. type: str more...
    • custom-log-fields - Log field index numbers to append custom log fields to log messages for this policy. type: str more...
    • devices - Names of devices or device groups that can be matched by the policy. type: str more...
    • diffserv-forward - Enable to change packets DiffServ values to the specified diffservcode-forward value. type: str choices: [disable, enable] more...
    • diffserv-reverse - Enable to change packets reverse (reply) DiffServ values to the specified diffservcode-rev value. type: str choices: [disable, enable] more...
    • diffservcode-forward - Change packets DiffServ to this value. type: str more...
    • diffservcode-rev - Change packets reverse (reply) DiffServ to this value. type: str more...
    • dlp-sensor - Name of an existing DLP sensor. type: str more...
    • dscp-match - Enable DSCP check. type: str choices: [disable, enable] more...
    • dscp-negate - Enable negated DSCP match. type: str choices: [disable, enable] more...
    • dscp-value - DSCP value. type: str more...
    • dsri - Enable DSRI to ignore HTTP server responses. type: str choices: [disable, enable] more...
    • dstaddr - Destination address and address group names. type: str more...
    • dstaddr-negate - When enabled dstaddr specifies what the destination address must NOT be. type: str choices: [disable, enable] more...
    • dstintf - Outgoing (egress) interface. type: str more...
    • firewall-session-dirty - How to handle sessions if the configuration of this firewall policy changes. type: str choices: [check-all, check-new] more...
    • fixedport - Enable to prevent source NAT from changing a sessions source port. type: str choices: [disable, enable] more...
    • global-label - Label for the policy that appears when the GUI is in Global View mode. type: str more...
    • groups - Names of user groups that can authenticate with this policy. type: str more...
    • icap-profile - Name of an existing ICAP profile. type: str more...
    • inbound - Policy-based IPsec VPN: only traffic from the remote network can initiate a VPN. type: str choices: [disable, enable] more...
    • ippool - Enable to use IP Pools for source NAT. type: str choices: [disable, enable] more...
    • ips-sensor - Name of an existing IPS sensor. type: str more...
    • label - Label for the policy that appears when the GUI is in Section View mode. type: str more...
    • logtraffic - Enable or disable logging. type: str choices: [disable, enable, all, utm] more...
    • logtraffic-start - Record logs when a session starts and ends. type: str choices: [disable, enable] more...
    • mms-profile - Name of an existing MMS profile. type: str more...
    • name - Policy name. type: str more...
    • nat - Enable/disable source NAT. type: str choices: [disable, enable] more...
    • natinbound - Policy-based IPsec VPN: apply destination NAT to inbound traffic. type: str choices: [disable, enable] more...
    • natoutbound - Policy-based IPsec VPN: apply source NAT to outbound traffic. type: str choices: [disable, enable] more...
    • np-accelation - Enable/disable UTM Network Processor acceleration. type: str choices: [disable, enable] more...
    • outbound - Policy-based IPsec VPN: only traffic from the internal network can initiate a VPN. type: str choices: [disable, enable] more...
    • per-ip-shaper - Per-IP traffic shaper. type: str more...
    • policyid - Policy ID. type: int more...
    • poolname - IP Pool names. type: str more...
    • profile-group - Name of profile group. type: str more...
    • profile-protocol-options - Name of an existing Protocol options profile. type: str more...
    • profile-type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: [single, group] more...
    • replacemsg-override-group - Override the default replacement message group for this policy. type: str more...
    • rsso - Enable/disable RADIUS single sign-on (RSSO). type: str choices: [disable, enable] more...
    • schedule - Schedule name. type: str more...
    • send-deny-packet - Enable/disable return of deny-packet. type: str choices: [disable, enable] more...
    • service - Service and service group names. type: str more...
    • service-negate - When enabled service specifies what the service must NOT be. type: str choices: [disable, enable] more...
    • session-ttl - Session TTL in seconds for sessions accepted by this policy. type: int more...
    • spamfilter-profile - Name of an existing Spam filter profile. type: str more...
    • srcaddr - Source address and address group names. type: str more...
    • srcaddr-negate - When enabled srcaddr specifies what the source address must NOT be. type: str choices: [disable, enable] more...
    • srcintf - Incoming (ingress) interface. type: str more...
    • ssl-mirror - Enable to copy decrypted SSL traffic to a FortiGate interface (called SSL mirroring). type: str choices: [disable, enable] more...
    • ssl-mirror-intf - SSL mirror interface name. type: str more...
    • ssl-ssh-profile - Name of an existing SSL SSH profile. type: str more...
    • status - Enable or disable this policy. type: str choices: [disable, enable] more...
    • tags - Names of object-tags applied to this policy. type: str more...
    • tcp-mss-receiver - Receiver TCP maximum segment size (MSS). type: int more...
    • tcp-mss-sender - Sender TCP maximum segment size (MSS). type: int more...
    • tcp-session-without-syn - Enable/disable creation of TCP session without SYN flag. type: str choices: [all, data-only, disable] more...
    • timeout-send-rst - Enable/disable sending RST packets when TCP sessions expire. type: str choices: [disable, enable] more...
    • traffic-shaper - Reverse traffic shaper. type: str more...
    • traffic-shaper-reverse - Reverse traffic shaper. type: str more...
    • url-category - URL category ID list. type: str more...
    • users - Names of individual users that can authenticate with this policy. type: str more...
    • utm-status - Enable AV/web/ips protection profile. type: str choices: [disable, enable] more...
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
    • vlan-cos-fwd - VLAN forward direction user priority: 255 passthrough, 0 lowest, 7 highest type: int more...
    • vlan-cos-rev - VLAN reverse direction user priority: 255 passthrough, 0 lowest, 7 highest type: int more...
    • voip-profile - Name of an existing VoIP profile. type: str more...
    • vpntunnel - Policy-based IPsec VPN: name of the IPsec VPN Phase 1. type: str more...
    • webfilter-profile - Name of an existing Web filter profile. type: str more...
    • anti-replay - Enable/disable anti-replay check. type: str choices: [disable, enable] more...
    • app-group - Application group names. type: str more...
    • cifs-profile - Name of an existing CIFS profile. type: str more...
    • dnsfilter-profile - Name of an existing DNS filter profile. type: str more...
    • emailfilter-profile - Name of an existing email filter profile. type: str more...
    • http-policy-redirect - Redirect HTTP(S) traffic to matching transparent web proxy policy. type: str choices: [disable, enable] more...
    • inspection-mode - Policy inspection mode (Flow/proxy). type: str choices: [proxy, flow] more...
    • np-acceleration - Enable/disable UTM Network Processor acceleration. type: str choices: [disable, enable] more...
    • ssh-filter-profile - Name of an existing SSH filter profile. type: str more...
    • ssh-policy-redirect - Redirect SSH traffic to matching transparent proxy policy. type: str choices: [disable, enable] more...
    • tos - ToS (Type of Service) value used for comparison. type: str more...
    • tos-mask - Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str more...
    • tos-negate - Enable negated TOS match. type: str choices: [disable, enable] more...
    • vlan-filter - Set VLAN filters. type: str more...
    • waf-profile - Name of an existing Web application firewall profile. type: str more...
    • webcache - Enable/disable web cache. type: str choices: [disable, enable] more...
    • webcache-https - Enable/disable web cache for HTTPS. type: str choices: [disable, enable] more...
    • webproxy-forward-server - Web proxy forward server name. type: str more...
    • webproxy-profile - Webproxy profile name. type: str more...
    • fsso-groups - Names of FSSO groups. type: str more...
    • decrypted-traffic-mirror - Decrypted traffic mirror. type: str more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the IPv6 policies
     fmgr_fact:
       facts:
           selector: 'pkg_firewall_policy6'
           params:
               adom: 'ansible'
               pkg: 'ansible' # package name
               policy6: 'your_value'
- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv6 policies.
     fmgr_pkg_firewall_policy6:
        bypass_validation: False
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_policy6:
           action: accept #<value in [deny, accept, ipsec, ...]>
           comments: ansible-comment
           dstaddr: all
           dstintf: any
           name: ansible-test-policy6
           nat: disable
           policyid: 1
           schedule: always
           service: ALL
           srcaddr: all
           srcintf: any
           status: disable

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:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

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