fmgr_pkg_firewall_proxypolicy – Configure proxy policies.

New in version 2.0.0.

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 v6.x and v7.x.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0
True
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10
True True True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11
True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7
True True True True True True True True
7.2.0 7.2.1 7.2.2
True True True
7.4.0
True

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_proxypolicy - Configure proxy policies. type: dict
    • action - Accept or deny traffic matching the policy parameters. type: str choices: [accept, deny, redirect] more...
    • application-list - Name of an existing Application list. type: str more...
    • av-profile - Name of an existing Antivirus profile. type: str more...
    • comments - Optional comments. type: str more...
    • disclaimer - Web proxy disclaimer setting: by domain, policy, or user. type: str choices: [disable, domain, policy, user] more...
    • dlp-sensor - Name of an existing DLP sensor. type: str more...
    • dstaddr - Destination address objects. type: str more...
    • dstaddr-negate - When enabled, destination addresses match against any address EXCEPT the specified destination addresses. type: str choices: [disable, enable] more...
    • dstaddr6 - IPv6 destination address objects. type: str more...
    • dstintf - Destination interface names. type: str more...
    • global-label - Global web-based manager visible label. type: str more...
    • groups - Names of group objects. type: str more...
    • http-tunnel-auth - Enable/disable HTTP tunnel authentication. type: str choices: [disable, enable] more...
    • icap-profile - Name of an existing ICAP profile. type: str more...
    • internet-service - Enable/disable use of Internet Services for this policy. type: str choices: [disable, enable] more...
    • internet-service-custom - Custom Internet Service name. type: str more...
    • internet-service-id - Internet Service ID. type: str more...
    • internet-service-negate - When enabled, Internet Services match against any internet service EXCEPT the selected Internet Service. type: str choices: [disable, enable] more...
    • ips-sensor - Name of an existing IPS sensor. type: str more...
    • label - VDOM-specific GUI visible label. type: str more...
    • logtraffic - Enable/disable logging traffic through the policy. type: str choices: [disable, all, utm] more...
    • logtraffic-start - Enable/disable policy log traffic start. type: str choices: [disable, enable] more...
    • mms-profile - Name of an existing MMS profile. type: str more...
    • policyid - Policy ID. type: int more...
    • poolname - Name of IP pool object. type: str more...
    • profile-group - Name of profile group. type: str more...
    • profile-protocol-options - Name of an existing Protocol options profile. type: str more...
    • profile-type - Determine whether the firewall policy allows security profile groups or single profiles only. type: str choices: [single, group] more...
    • proxy - Type of explicit proxy. type: str choices: [explicit-web, transparent-web, ftp, wanopt, ssh, ssh-tunnel, access-proxy] more...
    • redirect-url - Redirect URL for further explicit web proxy processing. type: str more...
    • replacemsg-override-group - Authentication replacement message override group. type: str more...
    • scan-botnet-connections - Enable/disable scanning of connections to Botnet servers. type: str choices: [disable, block, monitor] more...
    • schedule - Name of schedule object. type: str more...
    • service - Name of service objects. type: str more...
    • service-negate - When enabled, services match against any service EXCEPT the specified destination services. type: str choices: [disable, enable] more...
    • spamfilter-profile - Name of an existing Spam filter profile. type: str more...
    • srcaddr - Source address objects (must be set when using Web proxy). type: str more...
    • srcaddr-negate - When enabled, source addresses match against any address EXCEPT the specified source addresses. type: str choices: [disable, enable] more...
    • srcaddr6 - IPv6 source address objects. type: str more...
    • srcintf - Source interface names. type: str more...
    • ssl-ssh-profile - Name of an existing SSL SSH profile. type: str more...
    • status - Enable/disable the active status of the policy. type: str choices: [disable, enable] more...
    • tags - Names of object-tags applied to address. type: str more...
    • transparent - Enable to use the IP address of the client to connect to the server. type: str choices: [disable, enable] more...
    • users - Names of user objects. type: str more...
    • utm-status - Enable the use of UTM profiles/sensors/lists. type: str choices: [disable, enable] more...
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
    • waf-profile - Name of an existing Web application firewall profile. type: str more...
    • webcache - Enable/disable web caching. type: str choices: [disable, enable] more...
    • webcache-https - Enable/disable web caching for HTTPS (Requires deep-inspection enabled in ssl-ssh-profile). type: str choices: [disable, enable] more...
    • webfilter-profile - Name of an existing Web filter profile. type: str more...
    • webproxy-forward-server - Name of web proxy forward server. type: str more...
    • webproxy-profile - Name of web proxy profile. type: str more...
    • cifs-profile - Name of an existing CIFS profile. type: str more...
    • emailfilter-profile - Name of an existing email filter profile. type: str more...
    • internet-service-custom-group - Custom Internet Service group name. type: str more...
    • internet-service-group - Internet Service group name. type: str more...
    • session-ttl - TTL in seconds for sessions accepted by this policy (0 means use the system default session TTL). type: int more...
    • ssh-filter-profile - Name of an existing SSH filter profile. type: str more...
    • ssh-policy-redirect - Redirect SSH traffic to matching transparent proxy policy. type: str choices: [disable, enable] more...
    • decrypted-traffic-mirror - Decrypted traffic mirror. type: str more...
    • internet-service-name - Internet Service name. type: str more...
    • file-filter-profile - Name of an existing file-filter profile. type: str more...
    • name - Policy name. type: str more...
    • access-proxy - Access Proxy. type: str more...
    • device-ownership - When enabled, the ownership enforcement will be done at policy level. type: str choices: [disable, enable] more...
    • videofilter-profile - Name of an existing VideoFilter profile. type: str more...
    • voip-profile - Name of an existing VoIP profile. type: str more...
    • ztna-ems-tag - ZTNA EMS Tag names. type: str more...
    • access-proxy6 - No description for the parameter type: str more...
    • block-notification - Enable/disable block notification. type: str choices: [disable, enable] more...
    • dlp-profile - Name of an existing DLP profile. type: str more...
    • sctp-filter-profile - Name of an existing SCTP filter profile. type: str more...
    • ztna-tags-match-logic - ZTNA tag matching logic. type: str choices: [or, and] 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

- 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 proxy policies.
     fmgr_pkg_firewall_proxypolicy:
        bypass_validation: False
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_proxypolicy:
           action: accept #<value in [accept, deny, redirect]>
           comments: ansible-comment
           dstaddr: all
           dstintf: any
           policyid: 1
           schedule: always
           service: ALL
           srcaddr: all
           srcintf: any
           status: disable

- 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 proxy policies
     fmgr_fact:
       facts:
           selector: 'pkg_firewall_proxypolicy'
           params:
               adom: 'ansible'
               proxy-policy: 'your_value'
               pkg: 'ansible' # package name

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 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

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)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.