fmgr_pkg_firewall_policy6 – Configure IPv6 policies.

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • pkg - The parameter in requested url type: str required: true
  • pkg_firewall_policy6 - Configure IPv6 policies. type: dict
    • action Policy action (allow/deny/ipsec). type: str choices: [deny, accept, ipsec, ssl-vpn] more...
    • app_category (Alias name: app-category) Application category id list. type: list or str more...
    • application Application id list. type: list more...
    • application_list (Alias name: application-list) Name of an existing application list. type: str more...
    • auto_asic_offload (Alias name: auto-asic-offload) Enable/disable policy traffic asic offloading. type: str choices: [disable, enable] more...
    • av_profile (Alias name: av-profile) Name of an existing antivirus profile. type: str more...
    • comments Comment. type: str more...
    • custom_log_fields (Alias name: custom-log-fields) Log field index numbers to append custom log fields to log messages for this policy. type: list or str more...
    • devices Names of devices or device groups that can be matched by the policy. type: list or str more...
    • diffserv_forward (Alias name: diffserv-forward) Enable to change packets diffserv values to the specified diffservcode-forward value. type: str choices: [disable, enable] more...
    • diffserv_reverse (Alias name: diffserv-reverse) Enable to change packets reverse (reply) diffserv values to the specified diffservcode-rev value. type: str choices: [disable, enable] more...
    • diffservcode_forward (Alias name: diffservcode-forward) Change packets diffserv to this value. type: str more...
    • diffservcode_rev (Alias name: diffservcode-rev) Change packets reverse (reply) diffserv to this value. type: str more...
    • dlp_sensor (Alias name: dlp-sensor) Name of an existing dlp sensor. type: str more...
    • dscp_match (Alias name: dscp-match) Enable dscp check. type: str choices: [disable, enable] more...
    • dscp_negate (Alias name: dscp-negate) Enable negated dscp match. type: str choices: [disable, enable] more...
    • dscp_value (Alias name: 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: list or str more...
    • dstaddr_negate (Alias name: dstaddr-negate) When enabled dstaddr specifies what the destination address must not be. type: str choices: [disable, enable] more...
    • dstintf Outgoing (egress) interface. type: list or str more...
    • firewall_session_dirty (Alias name: 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 (Alias name: 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: list or str more...
    • icap_profile (Alias name: 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 (Alias name: 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 (Alias name: logtraffic-start) Record logs when a session starts and ends. type: str choices: [disable, enable] more...
    • mms_profile (Alias name: 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 (Alias name: 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 (Alias name: per-ip-shaper) Per-ip traffic shaper. type: str more...
    • policyid Policy id. type: int more...
    • poolname Ip pool names. type: list or str more...
    • profile_group (Alias name: profile-group) Name of profile group. type: str more...
    • profile_protocol_options (Alias name: profile-protocol-options) Name of an existing protocol options profile. type: str more...
    • profile_type (Alias name: profile-type) Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: [single, group] more...
    • replacemsg_override_group (Alias name: 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 (Alias name: send-deny-packet) Enable/disable return of deny-packet. type: str choices: [disable, enable] more...
    • service Service and service group names. type: list or str more...
    • service_negate (Alias name: service-negate) When enabled service specifies what the service must not be. type: str choices: [disable, enable] more...
    • session_ttl (Alias name: session-ttl) Session ttl in seconds for sessions accepted by this policy. type: int or str more...
    • spamfilter_profile (Alias name: spamfilter-profile) Name of an existing spam filter profile. type: str more...
    • srcaddr Source address and address group names. type: list or str more...
    • srcaddr_negate (Alias name: srcaddr-negate) When enabled srcaddr specifies what the source address must not be. type: str choices: [disable, enable] more...
    • srcintf Incoming (ingress) interface. type: list or str more...
    • ssl_mirror (Alias name: ssl-mirror) Enable to copy decrypted ssl traffic to a fortigate interface (called ssl mirroring). type: str choices: [disable, enable] more...
    • ssl_mirror_intf (Alias name: ssl-mirror-intf) Ssl mirror interface name. type: list or str more...
    • ssl_ssh_profile (Alias name: 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 (Alias name: tcp-mss-receiver) Receiver tcp maximum segment size (mss). type: int more...
    • tcp_mss_sender (Alias name: tcp-mss-sender) Sender tcp maximum segment size (mss). type: int more...
    • tcp_session_without_syn (Alias name: tcp-session-without-syn) Enable/disable creation of tcp session without syn flag. type: str choices: [all, data-only, disable] more...
    • timeout_send_rst (Alias name: timeout-send-rst) Enable/disable sending rst packets when tcp sessions expire. type: str choices: [disable, enable] more...
    • traffic_shaper (Alias name: traffic-shaper) Reverse traffic shaper. type: str more...
    • traffic_shaper_reverse (Alias name: traffic-shaper-reverse) Reverse traffic shaper. type: str more...
    • url_category (Alias name: url-category) Url category id list. type: list or str more...
    • users Names of individual users that can authenticate with this policy. type: list or str more...
    • utm_status (Alias name: 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 (Alias name: vlan-cos-fwd) Vlan forward direction user priority: 255 passthrough, 0 lowest, 7 highest type: int more...
    • vlan_cos_rev (Alias name: vlan-cos-rev) Vlan reverse direction user priority: 255 passthrough, 0 lowest, 7 highest type: int more...
    • voip_profile (Alias name: 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 (Alias name: webfilter-profile) Name of an existing web filter profile. type: str more...
    • anti_replay (Alias name: anti-replay) Enable/disable anti-replay check. type: str choices: [disable, enable] more...
    • app_group (Alias name: app-group) Application group names. type: list or str more...
    • cifs_profile (Alias name: cifs-profile) Name of an existing cifs profile. type: str more...
    • dnsfilter_profile (Alias name: dnsfilter-profile) Name of an existing dns filter profile. type: str more...
    • emailfilter_profile (Alias name: emailfilter-profile) Name of an existing email filter profile. type: str more...
    • http_policy_redirect (Alias name: http-policy-redirect) Redirect http(s) traffic to matching transparent web proxy policy. type: str choices: [disable, enable] more...
    • inspection_mode (Alias name: inspection-mode) Policy inspection mode (flow/proxy). type: str choices: [proxy, flow] more...
    • np_acceleration (Alias name: np-acceleration) Enable/disable utm network processor acceleration. type: str choices: [disable, enable] more...
    • ssh_filter_profile (Alias name: ssh-filter-profile) Name of an existing ssh filter profile. type: str more...
    • ssh_policy_redirect (Alias name: 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 (Alias name: tos-mask) Non-zero bit positions are used for comparison while zero bit positions are ignored. type: str more...
    • tos_negate (Alias name: tos-negate) Enable negated tos match. type: str choices: [disable, enable] more...
    • vlan_filter (Alias name: vlan-filter) Set vlan filters. type: str more...
    • waf_profile (Alias name: 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 (Alias name: webcache-https) Enable/disable web cache for https. type: str choices: [disable, enable] more...
    • webproxy_forward_server (Alias name: webproxy-forward-server) Web proxy forward server name. type: str more...
    • webproxy_profile (Alias name: webproxy-profile) Webproxy profile name. type: str more...
    • casi_profile (Alias name: casi-profile) Casi profile. type: str more...
    • fsso_groups (Alias name: fsso-groups) Names of fsso groups. type: list or str more...
    • decrypted_traffic_mirror (Alias name: decrypted-traffic-mirror) Decrypted traffic mirror. type: str more...
    • cgn_log_server_grp (Alias name: cgn-log-server-grp) Np log server group name type: str more...
    • policy_offload (Alias name: policy-offload) Enable/disable offloading policy configuration to cp processors. type: str choices: [disable, enable] more...
    • _policy_block Assigned policy block. type: int 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: 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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)