drmofu.fortimanager.fmgr_pkg_firewall_policy64 (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 to IPv4 policies
      fmgr_fact:
        facts:
            selector: 'pkg_firewall_policy64'
            params:
                adom: 'ansible'
                pkg: 'ansible' # package name
                policy64: '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 to IPv4 policies.
      fmgr_pkg_firewall_policy64:
         bypass_validation: False
         adom: ansible
         pkg: ansible # package name
         state: present
         pkg_firewall_policy64:
            action: accept #<value in [deny, accept]>
            comments: ansible-comment
            dstaddr: all
            dstintf: any
            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_policy64:
    description: the top level parameters set
    required: false
    suboptions:
      action:
        choices:
        - deny
        - accept
        description: Policy action.
        type: str
      cgn-eif:
        choices:
        - disable
        - enable
        description: Enable/disable CGN endpoint independent filtering.
        type: str
      cgn-eim:
        choices:
        - disable
        - enable
        description: Enable/disable CGN endpoint independent mapping.
        type: str
      cgn-log-server-grp:
        description: NP log server group name
        type: str
      cgn-resource-quota:
        description: resource quota
        type: int
      cgn-session-quota:
        description: session quota
        type: int
      comments:
        description: Comment.
        type: str
      dstaddr:
        description: Destination address name.
        type: str
      dstintf:
        description: Destination interface name.
        type: str
      fixedport:
        choices:
        - disable
        - enable
        description: Enable/disable policy fixed port.
        type: str
      ippool:
        choices:
        - disable
        - enable
        description: Enable/disable policy64 IP pool.
        type: str
      logtraffic:
        choices:
        - disable
        - enable
        description: Enable/disable policy log traffic.
        type: str
      logtraffic-start:
        choices:
        - disable
        - enable
        description: Record logs when a session starts and ends.
        type: str
      name:
        description: Policy name.
        type: str
      per-ip-shaper:
        description: Per-IP traffic shaper.
        type: str
      permit-any-host:
        choices:
        - disable
        - enable
        description: Enable/disable permit any host in.
        type: str
      policy-offload:
        choices:
        - disable
        - enable
        description: Enable/disable hardware session setup for CGNAT.
        type: str
      policyid:
        description: Policy ID.
        type: int
      poolname:
        description: Policy IP pool names.
        type: str
      schedule:
        description: Schedule name.
        type: str
      service:
        description: Service name.
        type: str
      srcaddr:
        description: Source address name.
        type: str
      srcintf:
        description: Source interface name.
        type: str
      status:
        choices:
        - disable
        - enable
        description: Enable/disable policy status.
        type: str
      tags:
        description: Applied object tags.
        type: str
      tcp-mss-receiver:
        description: TCP MSS value of receiver.
        type: int
      tcp-mss-sender:
        description: TCP MSS value of sender.
        type: int
      traffic-shaper:
        description: Traffic shaper.
        type: str
      traffic-shaper-reverse:
        description: Reverse traffic shaper.
        type: str
      uuid:
        description: Universally Unique Identifier
        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