fortinet.fortimanager.fmgr_pkg_firewall_policy6 (2.4.0) — module

Configure IPv6 policies.

| "added in version" 2.0.0 of fortinet.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"

Inputs

    
pkg:
    description: The parameter (pkg) in requested url.
    required: true
    type: str

adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

pkg_firewall_policy6:
    description: The top level parameters set.
    required: false
    suboptions:
      _policy_block:
        description: Assigned policy block.
        type: int
      action:
        choices:
        - deny
        - accept
        - ipsec
        - ssl-vpn
        description: Policy action
        type: str
      anti-replay:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to anti_replay. Enable/disable anti-replay
          check.
        type: str
      app-category:
        description: (list or str) Deprecated, please rename it to app_category. Application
          category ID list.
        type: raw
      app-group:
        description: (list or str) Deprecated, please rename it to app_group. Application
          group names.
        type: raw
      application:
        description: (list) Application ID list.
        type: raw
      application-list:
        description: Deprecated, please rename it to application_list. Name of an existing
          Application list.
        type: str
      auto-asic-offload:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to auto_asic_offload. Enable/disable
          policy traffic ASIC offloading.
        type: str
      av-profile:
        description: Deprecated, please rename it to av_profile. Name of an existing Antivirus
          profile.
        type: str
      casi-profile:
        description: Deprecated, please rename it to casi_profile. CASI profile.
        type: str
      cgn-log-server-grp:
        description: Deprecated, please rename it to cgn_log_server_grp. NP log server
          group name
        type: str
      cifs-profile:
        description: Deprecated, please rename it to cifs_profile. Name of an existing
          CIFS profile.
        type: str
      comments:
        description: Comment.
        type: str
      custom-log-fields:
        description: (list or str) Deprecated, please rename it to custom_log_fields.
          Log field index numbers to append custom log fields to lo...
        type: raw
      decrypted-traffic-mirror:
        description: Deprecated, please rename it to decrypted_traffic_mirror. Decrypted
          traffic mirror.
        type: str
      devices:
        description: (list or str) Names of devices or device groups that can be matched
          by the policy.
        type: raw
      diffserv-forward:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to diffserv_forward. Enable to change
          packets DiffServ values to the specified diffservcode-f...
        type: str
      diffserv-reverse:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to diffserv_reverse. Enable to change
          packets reverse
        type: str
      diffservcode-forward:
        description: Deprecated, please rename it to diffservcode_forward. Change packets
          DiffServ to this value.
        type: str
      diffservcode-rev:
        description: Deprecated, please rename it to diffservcode_rev. Change packets
          reverse
        type: str
      dlp-sensor:
        description: Deprecated, please rename it to dlp_sensor. Name of an existing DLP
          sensor.
        type: str
      dnsfilter-profile:
        description: Deprecated, please rename it to dnsfilter_profile. Name of an existing
          DNS filter profile.
        type: str
      dscp-match:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dscp_match. Enable DSCP check.
        type: str
      dscp-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dscp_negate. Enable negated DSCP
          match.
        type: str
      dscp-value:
        description: Deprecated, please rename it to dscp_value. DSCP value.
        type: str
      dsri:
        choices:
        - disable
        - enable
        description: Enable DSRI to ignore HTTP server responses.
        type: str
      dstaddr:
        description: (list or str) Destination address and address group names.
        type: raw
      dstaddr-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dstaddr_negate. When enabled dstaddr
          specifies what the destination address must NOT be.
        type: str
      dstintf:
        description: (list or str) Outgoing
        type: raw
      emailfilter-profile:
        description: Deprecated, please rename it to emailfilter_profile. Name of an existing
          email filter profile.
        type: str
      firewall-session-dirty:
        choices:
        - check-all
        - check-new
        description: Deprecated, please rename it to firewall_session_dirty. How to handle
          sessions if the configuration of this firewall polic...
        type: str
      fixedport:
        choices:
        - disable
        - enable
        description: Enable to prevent source NAT from changing a sessions source port.
        type: str
      fsso-groups:
        description: (list or str) Deprecated, please rename it to fsso_groups. Names
          of FSSO groups.
        type: raw
      global-label:
        description: Deprecated, please rename it to global_label. Label for the policy
          that appears when the GUI is in Global View mode.
        type: str
      groups:
        description: (list or str) Names of user groups that can authenticate with this
          policy.
        type: raw
      http-policy-redirect:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to http_policy_redirect. Redirect HTTP
        type: str
      icap-profile:
        description: Deprecated, please rename it to icap_profile. Name of an existing
          ICAP profile.
        type: str
      inbound:
        choices:
        - disable
        - enable
        description: Policy-based IPsec VPN
        type: str
      inspection-mode:
        choices:
        - proxy
        - flow
        description: Deprecated, please rename it to inspection_mode. Policy inspection
          mode
        type: str
      ippool:
        choices:
        - disable
        - enable
        description: Enable to use IP Pools for source NAT.
        type: str
      ips-sensor:
        description: Deprecated, please rename it to ips_sensor. Name of an existing IPS
          sensor.
        type: str
      label:
        description: Label for the policy that appears when the GUI is in Section View
          mode.
        type: str
      logtraffic:
        choices:
        - disable
        - enable
        - all
        - utm
        description: Enable or disable logging.
        type: str
      logtraffic-start:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to logtraffic_start. Record logs when
          a session starts and ends.
        type: str
      mms-profile:
        description: Deprecated, please rename it to mms_profile. Name of an existing
          MMS profile.
        type: str
      name:
        description: Policy name.
        type: str
      nat:
        choices:
        - disable
        - enable
        description: Enable/disable source NAT.
        type: str
      natinbound:
        choices:
        - disable
        - enable
        description: Policy-based IPsec VPN
        type: str
      natoutbound:
        choices:
        - disable
        - enable
        description: Policy-based IPsec VPN
        type: str
      np-accelation:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to np_accelation. Enable/disable UTM
          Network Processor acceleration.
        type: str
      np-acceleration:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to np_acceleration. Enable/disable UTM
          Network Processor acceleration.
        type: str
      outbound:
        choices:
        - disable
        - enable
        description: Policy-based IPsec VPN
        type: str
      per-ip-shaper:
        description: Deprecated, please rename it to per_ip_shaper. Per-IP traffic shaper.
        type: str
      policy-offload:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to policy_offload. Enable/disable offloading
          policy configuration to CP processors.
        type: str
      policyid:
        description: Policy ID.
        required: true
        type: int
      poolname:
        description: (list or str) IP Pool names.
        type: raw
      profile-group:
        description: Deprecated, please rename it to profile_group. Name of profile group.
        type: str
      profile-protocol-options:
        description: Deprecated, please rename it to profile_protocol_options. Name of
          an existing Protocol options profile.
        type: str
      profile-type:
        choices:
        - single
        - group
        description: Deprecated, please rename it to profile_type. Determine whether the
          firewall policy allows security profile groups or sing...
        type: str
      replacemsg-override-group:
        description: Deprecated, please rename it to replacemsg_override_group. Override
          the default replacement message group for this policy.
        type: str
      rsso:
        choices:
        - disable
        - enable
        description: Enable/disable RADIUS single sign-on
        type: str
      schedule:
        description: Schedule name.
        type: str
      send-deny-packet:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to send_deny_packet. Enable/disable
          return of deny-packet.
        type: str
      service:
        description: (list or str) Service and service group names.
        type: raw
      service-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to service_negate. When enabled service
          specifies what the service must NOT be.
        type: str
      session-ttl:
        description: (int or str) Deprecated, please rename it to session_ttl. Session
          TTL in seconds for sessions accepted by this policy.
        type: raw
      spamfilter-profile:
        description: Deprecated, please rename it to spamfilter_profile. Name of an existing
          Spam filter profile.
        type: str
      srcaddr:
        description: (list or str) Source address and address group names.
        type: raw
      srcaddr-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to srcaddr_negate. When enabled srcaddr
          specifies what the source address must NOT be.
        type: str
      srcintf:
        description: (list or str) Incoming
        type: raw
      ssh-filter-profile:
        description: Deprecated, please rename it to ssh_filter_profile. Name of an existing
          SSH filter profile.
        type: str
      ssh-policy-redirect:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ssh_policy_redirect. Redirect SSH
          traffic to matching transparent proxy policy.
        type: str
      ssl-mirror:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ssl_mirror. Enable to copy decrypted
          SSL traffic to a FortiGate interface
        type: str
      ssl-mirror-intf:
        description: (list or str) Deprecated, please rename it to ssl_mirror_intf. SSL
          mirror interface name.
        type: raw
      ssl-ssh-profile:
        description: Deprecated, please rename it to ssl_ssh_profile. Name of an existing
          SSL SSH profile.
        type: str
      status:
        choices:
        - disable
        - enable
        description: Enable or disable this policy.
        type: str
      tags:
        description: Names of object-tags applied to this policy.
        type: str
      tcp-mss-receiver:
        description: Deprecated, please rename it to tcp_mss_receiver. Receiver TCP maximum
          segment size
        type: int
      tcp-mss-sender:
        description: Deprecated, please rename it to tcp_mss_sender. Sender TCP maximum
          segment size
        type: int
      tcp-session-without-syn:
        choices:
        - all
        - data-only
        - disable
        description: Deprecated, please rename it to tcp_session_without_syn. Enable/disable
          creation of TCP session without SYN flag.
        type: str
      timeout-send-rst:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to timeout_send_rst. Enable/disable
          sending RST packets when TCP sessions expire.
        type: str
      tos:
        description: ToS
        type: str
      tos-mask:
        description: Deprecated, please rename it to tos_mask. Non-zero bit positions
          are used for comparison while zero bit positions are ignored.
        type: str
      tos-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to tos_negate. Enable negated TOS match.
        type: str
      traffic-shaper:
        description: Deprecated, please rename it to traffic_shaper. Reverse traffic shaper.
        type: str
      traffic-shaper-reverse:
        description: Deprecated, please rename it to traffic_shaper_reverse. Reverse traffic
          shaper.
        type: str
      url-category:
        description: (list or str) Deprecated, please rename it to url_category. URL category
          ID list.
        type: raw
      users:
        description: (list or str) Names of individual users that can authenticate with
          this policy.
        type: raw
      utm-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to utm_status. Enable AV/web/ips protection
          profile.
        type: str
      uuid:
        description: Universally Unique Identifier
        type: str
      vlan-cos-fwd:
        description: Deprecated, please rename it to vlan_cos_fwd. VLAN forward direction
          user priority
        type: int
      vlan-cos-rev:
        description: Deprecated, please rename it to vlan_cos_rev. VLAN reverse direction
          user priority
        type: int
      vlan-filter:
        description: Deprecated, please rename it to vlan_filter. Set VLAN filters.
        type: str
      voip-profile:
        description: Deprecated, please rename it to voip_profile. Name of an existing
          VoIP profile.
        type: str
      vpntunnel:
        description: Policy-based IPsec VPN
        type: str
      waf-profile:
        description: Deprecated, please rename it to waf_profile. Name of an existing
          Web application firewall profile.
        type: str
      webcache:
        choices:
        - disable
        - enable
        description: Enable/disable web cache.
        type: str
      webcache-https:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to webcache_https. Enable/disable web
          cache for HTTPS.
        type: str
      webfilter-profile:
        description: Deprecated, please rename it to webfilter_profile. Name of an existing
          Web filter profile.
        type: str
      webproxy-forward-server:
        description: Deprecated, please rename it to webproxy_forward_server. Web proxy
          forward server name.
        type: str
      webproxy-profile:
        description: Deprecated, please rename it to webproxy_profile. Webproxy profile
          name.
        type: str
    type: dict

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

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list