fortinet.fortimanager.fmgr_pkg_firewall_policy6 module – Configure IPv6 policies.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_firewall_policy6.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

pkg

string / required

The parameter (pkg) in requested url.

pkg_firewall_policy6

dictionary

The top level parameters set.

_policy_block

integer

Assigned policy block.

action

string

Policy action

Choices:

  • "deny"

  • "accept"

  • "ipsec"

  • "ssl-vpn"

anti-replay

string

Deprecated, please rename it to anti_replay. Enable/disable anti-replay check.

Choices:

  • "disable"

  • "enable"

app-category

any

(list or str) Deprecated, please rename it to app_category. Application category ID list.

app-group

any

(list or str) Deprecated, please rename it to app_group. Application group names.

application

any

(list) Application ID list.

application-list

string

Deprecated, please rename it to application_list. Name of an existing Application list.

auto-asic-offload

string

Deprecated, please rename it to auto_asic_offload. Enable/disable policy traffic ASIC offloading.

Choices:

  • "disable"

  • "enable"

av-profile

string

Deprecated, please rename it to av_profile. Name of an existing Antivirus profile.

casi-profile

string

Deprecated, please rename it to casi_profile. CASI profile.

cgn-log-server-grp

string

Deprecated, please rename it to cgn_log_server_grp. NP log server group name

cifs-profile

string

Deprecated, please rename it to cifs_profile. Name of an existing CIFS profile.

comments

string

Comment.

custom-log-fields

any

(list or str) Deprecated, please rename it to custom_log_fields. Log field index numbers to append custom log fields to lo…

decrypted-traffic-mirror

string

Deprecated, please rename it to decrypted_traffic_mirror. Decrypted traffic mirror.

devices

any

(list or str) Names of devices or device groups that can be matched by the policy.

diffserv-forward

string

Deprecated, please rename it to diffserv_forward. Enable to change packets DiffServ values to the specified diffservcode-f…

Choices:

  • "disable"

  • "enable"

diffserv-reverse

string

Deprecated, please rename it to diffserv_reverse. Enable to change packets reverse

Choices:

  • "disable"

  • "enable"

diffservcode-forward

string

Deprecated, please rename it to diffservcode_forward. Change packets DiffServ to this value.

diffservcode-rev

string

Deprecated, please rename it to diffservcode_rev. Change packets reverse

dlp-sensor

string

Deprecated, please rename it to dlp_sensor. Name of an existing DLP sensor.

dnsfilter-profile

string

Deprecated, please rename it to dnsfilter_profile. Name of an existing DNS filter profile.

dscp-match

string

Deprecated, please rename it to dscp_match. Enable DSCP check.

Choices:

  • "disable"

  • "enable"

dscp-negate

string

Deprecated, please rename it to dscp_negate. Enable negated DSCP match.

Choices:

  • "disable"

  • "enable"

dscp-value

string

Deprecated, please rename it to dscp_value. DSCP value.

dsri

string

Enable DSRI to ignore HTTP server responses.

Choices:

  • "disable"

  • "enable"

dstaddr

any

(list or str) Destination address and address group names.

dstaddr-negate

string

Deprecated, please rename it to dstaddr_negate. When enabled dstaddr specifies what the destination address must NOT be.

Choices:

  • "disable"

  • "enable"

dstintf

any

(list or str) Outgoing

emailfilter-profile

string

Deprecated, please rename it to emailfilter_profile. Name of an existing email filter profile.

firewall-session-dirty

string

Deprecated, please rename it to firewall_session_dirty. How to handle sessions if the configuration of this firewall polic…

Choices:

  • "check-all"

  • "check-new"

fixedport

string

Enable to prevent source NAT from changing a sessions source port.

Choices:

  • "disable"

  • "enable"

fsso-groups

any

(list or str) Deprecated, please rename it to fsso_groups. Names of FSSO groups.

global-label

string

Deprecated, please rename it to global_label. Label for the policy that appears when the GUI is in Global View mode.

groups

any

(list or str) Names of user groups that can authenticate with this policy.

http-policy-redirect

string

Deprecated, please rename it to http_policy_redirect. Redirect HTTP

Choices:

  • "disable"

  • "enable"

icap-profile

string

Deprecated, please rename it to icap_profile. Name of an existing ICAP profile.

inbound

string

Policy-based IPsec VPN

Choices:

  • "disable"

  • "enable"

inspection-mode

string

Deprecated, please rename it to inspection_mode. Policy inspection mode

Choices:

  • "proxy"

  • "flow"

ippool

string

Enable to use IP Pools for source NAT.

Choices:

  • "disable"

  • "enable"

ips-sensor

string

Deprecated, please rename it to ips_sensor. Name of an existing IPS sensor.

label

string

Label for the policy that appears when the GUI is in Section View mode.

logtraffic

string

Enable or disable logging.

Choices:

  • "disable"

  • "enable"

  • "all"

  • "utm"

logtraffic-start

string

Deprecated, please rename it to logtraffic_start. Record logs when a session starts and ends.

Choices:

  • "disable"

  • "enable"

mms-profile

string

Deprecated, please rename it to mms_profile. Name of an existing MMS profile.

name

string

Policy name.

nat

string

Enable/disable source NAT.

Choices:

  • "disable"

  • "enable"

natinbound

string

Policy-based IPsec VPN

Choices:

  • "disable"

  • "enable"

natoutbound

string

Policy-based IPsec VPN

Choices:

  • "disable"

  • "enable"

np-accelation

string

Deprecated, please rename it to np_accelation. Enable/disable UTM Network Processor acceleration.

Choices:

  • "disable"

  • "enable"

np-acceleration

string

Deprecated, please rename it to np_acceleration. Enable/disable UTM Network Processor acceleration.

Choices:

  • "disable"

  • "enable"

outbound

string

Policy-based IPsec VPN

Choices:

  • "disable"

  • "enable"

per-ip-shaper

string

Deprecated, please rename it to per_ip_shaper. Per-IP traffic shaper.

policy-offload

string

Deprecated, please rename it to policy_offload. Enable/disable offloading policy configuration to CP processors.

Choices:

  • "disable"

  • "enable"

policyid

integer / required

Policy ID.

poolname

any

(list or str) IP Pool names.

profile-group

string

Deprecated, please rename it to profile_group. Name of profile group.

profile-protocol-options

string

Deprecated, please rename it to profile_protocol_options. Name of an existing Protocol options profile.

profile-type

string

Deprecated, please rename it to profile_type. Determine whether the firewall policy allows security profile groups or sing…

Choices:

  • "single"

  • "group"

replacemsg-override-group

string

Deprecated, please rename it to replacemsg_override_group. Override the default replacement message group for this policy.

rsso

string

Enable/disable RADIUS single sign-on

Choices:

  • "disable"

  • "enable"

schedule

string

Schedule name.

send-deny-packet

string

Deprecated, please rename it to send_deny_packet. Enable/disable return of deny-packet.

Choices:

  • "disable"

  • "enable"

service

any

(list or str) Service and service group names.

service-negate

string

Deprecated, please rename it to service_negate. When enabled service specifies what the service must NOT be.

Choices:

  • "disable"

  • "enable"

session-ttl

any

(int or str) Deprecated, please rename it to session_ttl. Session TTL in seconds for sessions accepted by this policy.

spamfilter-profile

string

Deprecated, please rename it to spamfilter_profile. Name of an existing Spam filter profile.

srcaddr

any

(list or str) Source address and address group names.

srcaddr-negate

string

Deprecated, please rename it to srcaddr_negate. When enabled srcaddr specifies what the source address must NOT be.

Choices:

  • "disable"

  • "enable"

srcintf

any

(list or str) Incoming

ssh-filter-profile

string

Deprecated, please rename it to ssh_filter_profile. Name of an existing SSH filter profile.

ssh-policy-redirect

string

Deprecated, please rename it to ssh_policy_redirect. Redirect SSH traffic to matching transparent proxy policy.

Choices:

  • "disable"

  • "enable"

ssl-mirror

string

Deprecated, please rename it to ssl_mirror. Enable to copy decrypted SSL traffic to a FortiGate interface

Choices:

  • "disable"

  • "enable"

ssl-mirror-intf

any

(list or str) Deprecated, please rename it to ssl_mirror_intf. SSL mirror interface name.

ssl-ssh-profile

string

Deprecated, please rename it to ssl_ssh_profile. Name of an existing SSL SSH profile.

status

string

Enable or disable this policy.

Choices:

  • "disable"

  • "enable"

tags

string

Names of object-tags applied to this policy.

tcp-mss-receiver

integer

Deprecated, please rename it to tcp_mss_receiver. Receiver TCP maximum segment size

tcp-mss-sender

integer

Deprecated, please rename it to tcp_mss_sender. Sender TCP maximum segment size

tcp-session-without-syn

string

Deprecated, please rename it to tcp_session_without_syn. Enable/disable creation of TCP session without SYN flag.

Choices:

  • "all"

  • "data-only"

  • "disable"

timeout-send-rst

string

Deprecated, please rename it to timeout_send_rst. Enable/disable sending RST packets when TCP sessions expire.

Choices:

  • "disable"

  • "enable"

tos

string

ToS

tos-mask

string

Deprecated, please rename it to tos_mask. Non-zero bit positions are used for comparison while zero bit positions are ignored.

tos-negate

string

Deprecated, please rename it to tos_negate. Enable negated TOS match.

Choices:

  • "disable"

  • "enable"

traffic-shaper

string

Deprecated, please rename it to traffic_shaper. Reverse traffic shaper.

traffic-shaper-reverse

string

Deprecated, please rename it to traffic_shaper_reverse. Reverse traffic shaper.

url-category

any

(list or str) Deprecated, please rename it to url_category. URL category ID list.

users

any

(list or str) Names of individual users that can authenticate with this policy.

utm-status

string

Deprecated, please rename it to utm_status. Enable AV/web/ips protection profile.

Choices:

  • "disable"

  • "enable"

uuid

string

Universally Unique Identifier

vlan-cos-fwd

integer

Deprecated, please rename it to vlan_cos_fwd. VLAN forward direction user priority

vlan-cos-rev

integer

Deprecated, please rename it to vlan_cos_rev. VLAN reverse direction user priority

vlan-filter

string

Deprecated, please rename it to vlan_filter. Set VLAN filters.

voip-profile

string

Deprecated, please rename it to voip_profile. Name of an existing VoIP profile.

vpntunnel

string

Policy-based IPsec VPN

waf-profile

string

Deprecated, please rename it to waf_profile. Name of an existing Web application firewall profile.

webcache

string

Enable/disable web cache.

Choices:

  • "disable"

  • "enable"

webcache-https

string

Deprecated, please rename it to webcache_https. Enable/disable web cache for HTTPS.

Choices:

  • "disable"

  • "enable"

webfilter-profile

string

Deprecated, please rename it to webfilter_profile. Name of an existing Web filter profile.

webproxy-forward-server

string

Deprecated, please rename it to webproxy_forward_server. Web proxy forward server name.

webproxy-profile

string

Deprecated, please rename it to webproxy_profile. Webproxy profile name.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv6 policies.
      fortinet.fortimanager.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

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the IPv6 policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_policy6"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            policy6: "your_value"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)