drmofu.fortimanager.fmgr_pkg_firewall_policy6 (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

 - 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'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

 - 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

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
    required: false
    type: list

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

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

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

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    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.
    required: false
    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: Enable/disable anti-replay check.
        type: str
      app-category:
        description: Application category ID list.
        type: str
      app-group:
        description: Application group names.
        type: str
      application:
        description: Application ID list.
        type: int
      application-list:
        description: Name of an existing Application list.
        type: str
      auto-asic-offload:
        choices:
        - disable
        - enable
        description: Enable/disable policy traffic ASIC offloading.
        type: str
      av-profile:
        description: Name of an existing Antivirus profile.
        type: str
      casi-profile:
        description: CASI profile.
        type: str
      cgn-log-server-grp:
        description: NP log server group name
        type: str
      cifs-profile:
        description: Name of an existing CIFS profile.
        type: str
      comments:
        description: Comment.
        type: str
      custom-log-fields:
        description: Log field index numbers to append custom log fields to log messages
          for this policy.
        type: str
      decrypted-traffic-mirror:
        description: Decrypted traffic mirror.
        type: str
      devices:
        description: Names of devices or device groups that can be matched by the policy.
        type: str
      diffserv-forward:
        choices:
        - disable
        - enable
        description: Enable to change packets DiffServ values to the specified diffservcode-forward
          value.
        type: str
      diffserv-reverse:
        choices:
        - disable
        - enable
        description: Enable to change packets reverse
        type: str
      diffservcode-forward:
        description: Change packets DiffServ to this value.
        type: str
      diffservcode-rev:
        description: Change packets reverse
        type: str
      dlp-sensor:
        description: Name of an existing DLP sensor.
        type: str
      dnsfilter-profile:
        description: Name of an existing DNS filter profile.
        type: str
      dscp-match:
        choices:
        - disable
        - enable
        description: Enable DSCP check.
        type: str
      dscp-negate:
        choices:
        - disable
        - enable
        description: Enable negated DSCP match.
        type: str
      dscp-value:
        description: DSCP value.
        type: str
      dsri:
        choices:
        - disable
        - enable
        description: Enable DSRI to ignore HTTP server responses.
        type: str
      dstaddr:
        description: Destination address and address group names.
        type: str
      dstaddr-negate:
        choices:
        - disable
        - enable
        description: When enabled dstaddr specifies what the destination address must
          NOT be.
        type: str
      dstintf:
        description: Outgoing
        type: str
      emailfilter-profile:
        description: Name of an existing email filter profile.
        type: str
      firewall-session-dirty:
        choices:
        - check-all
        - check-new
        description: How to handle sessions if the configuration of this firewall policy
          changes.
        type: str
      fixedport:
        choices:
        - disable
        - enable
        description: Enable to prevent source NAT from changing a sessions source port.
        type: str
      fsso-groups:
        description: Names of FSSO groups.
        type: str
      global-label:
        description: Label for the policy that appears when the GUI is in Global View
          mode.
        type: str
      groups:
        description: Names of user groups that can authenticate with this policy.
        type: str
      http-policy-redirect:
        choices:
        - disable
        - enable
        description: Redirect HTTP
        type: str
      icap-profile:
        description: 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: Policy inspection mode
        type: str
      ippool:
        choices:
        - disable
        - enable
        description: Enable to use IP Pools for source NAT.
        type: str
      ips-sensor:
        description: 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: Record logs when a session starts and ends.
        type: str
      mms-profile:
        description: 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: Enable/disable UTM Network Processor acceleration.
        type: str
      np-acceleration:
        choices:
        - disable
        - enable
        description: Enable/disable UTM Network Processor acceleration.
        type: str
      outbound:
        choices:
        - disable
        - enable
        description: Policy-based IPsec VPN
        type: str
      per-ip-shaper:
        description: Per-IP traffic shaper.
        type: str
      policy-offload:
        choices:
        - disable
        - enable
        description: Enable/disable offloading policy configuration to CP processors.
        type: str
      policyid:
        description: Policy ID.
        type: int
      poolname:
        description: IP Pool names.
        type: str
      profile-group:
        description: Name of profile group.
        type: str
      profile-protocol-options:
        description: Name of an existing Protocol options profile.
        type: str
      profile-type:
        choices:
        - single
        - group
        description: Determine whether the firewall policy allows security profile groups
          or single profiles only.
        type: str
      replacemsg-override-group:
        description: 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: Enable/disable return of deny-packet.
        type: str
      service:
        description: Service and service group names.
        type: str
      service-negate:
        choices:
        - disable
        - enable
        description: When enabled service specifies what the service must NOT be.
        type: str
      session-ttl:
        description: Session TTL in seconds for sessions accepted by this policy.
        type: int
      spamfilter-profile:
        description: Name of an existing Spam filter profile.
        type: str
      srcaddr:
        description: Source address and address group names.
        type: str
      srcaddr-negate:
        choices:
        - disable
        - enable
        description: When enabled srcaddr specifies what the source address must NOT be.
        type: str
      srcintf:
        description: Incoming
        type: str
      ssh-filter-profile:
        description: Name of an existing SSH filter profile.
        type: str
      ssh-policy-redirect:
        choices:
        - disable
        - enable
        description: Redirect SSH traffic to matching transparent proxy policy.
        type: str
      ssl-mirror:
        choices:
        - disable
        - enable
        description: Enable to copy decrypted SSL traffic to a FortiGate interface
        type: str
      ssl-mirror-intf:
        description: SSL mirror interface name.
        type: str
      ssl-ssh-profile:
        description: 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: Receiver TCP maximum segment size
        type: int
      tcp-mss-sender:
        description: Sender TCP maximum segment size
        type: int
      tcp-session-without-syn:
        choices:
        - all
        - data-only
        - disable
        description: Enable/disable creation of TCP session without SYN flag.
        type: str
      timeout-send-rst:
        choices:
        - disable
        - enable
        description: Enable/disable sending RST packets when TCP sessions expire.
        type: str
      tos:
        description: ToS
        type: str
      tos-mask:
        description: Non-zero bit positions are used for comparison while zero bit positions
          are ignored.
        type: str
      tos-negate:
        choices:
        - disable
        - enable
        description: Enable negated TOS match.
        type: str
      traffic-shaper:
        description: Reverse traffic shaper.
        type: str
      traffic-shaper-reverse:
        description: Reverse traffic shaper.
        type: str
      url-category:
        description: URL category ID list.
        type: str
      users:
        description: Names of individual users that can authenticate with this policy.
        type: str
      utm-status:
        choices:
        - disable
        - enable
        description: Enable AV/web/ips protection profile.
        type: str
      uuid:
        description: Universally Unique Identifier
        type: str
      vlan-cos-fwd:
        description: VLAN forward direction user priority
        type: int
      vlan-cos-rev:
        description: VLAN reverse direction user priority
        type: int
      vlan-filter:
        description: Set VLAN filters.
        type: str
      voip-profile:
        description: Name of an existing VoIP profile.
        type: str
      vpntunnel:
        description: Policy-based IPsec VPN
        type: str
      waf-profile:
        description: 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: Enable/disable web cache for HTTPS.
        type: str
      webfilter-profile:
        description: Name of an existing Web filter profile.
        type: str
      webproxy-forward-server:
        description: Web proxy forward server name.
        type: str
      webproxy-profile:
        description: 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.
    required: false
    type: str

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

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    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