fmgr_pkg_firewall_proxypolicy – Configure proxy 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_proxypolicy - Configure proxy policies. type: dict
    • action Accept or deny traffic matching the policy parameters. type: str choices: [accept, deny, redirect] more...
    • application_list (Alias name: application-list) Name of an existing application list. type: str more...
    • av_profile (Alias name: 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 (Alias name: dlp-sensor) Name of an existing dlp sensor. type: str more...
    • dstaddr Destination address objects. type: list or str more...
    • dstaddr_negate (Alias name: 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: list or str more...
    • dstintf Destination interface names. type: list or str more...
    • global_label (Alias name: global-label) Global web-based manager visible label. type: str more...
    • groups Names of group objects. type: list or str more...
    • http_tunnel_auth (Alias name: http-tunnel-auth) Enable/disable http tunnel authentication. type: str choices: [disable, enable] more...
    • icap_profile (Alias name: icap-profile) Name of an existing icap profile. type: str more...
    • internet_service (Alias name: internet-service) Enable/disable use of internet services for this policy. type: str choices: [disable, enable] more...
    • internet_service_custom (Alias name: internet-service-custom) Custom internet service name. type: list or str more...
    • internet_service_id (Alias name: internet-service-id) Internet service id. type: list or str more...
    • internet_service_negate (Alias name: 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 (Alias name: 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 (Alias name: logtraffic-start) Enable/disable policy log traffic start. type: str choices: [disable, enable] more...
    • mms_profile (Alias name: mms-profile) Name of an existing mms profile. type: str more...
    • policyid Policy id. type: int more...
    • poolname Name of ip pool object. 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...
    • proxy Type of explicit proxy. type: str choices: [explicit-web, transparent-web, ftp, wanopt, ssh, ssh-tunnel, access-proxy, ztna-proxy] more...
    • redirect_url (Alias name: redirect-url) Redirect url for further explicit web proxy processing. type: str more...
    • replacemsg_override_group (Alias name: replacemsg-override-group) Authentication replacement message override group. type: str more...
    • scan_botnet_connections (Alias name: 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: list or str more...
    • service_negate (Alias name: service-negate) When enabled, services match against any service except the specified destination services. type: str choices: [disable, enable] more...
    • spamfilter_profile (Alias name: spamfilter-profile) Name of an existing spam filter profile. type: str more...
    • srcaddr Source address objects (must be set when using web proxy). type: list or str more...
    • srcaddr_negate (Alias name: 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: list or str more...
    • srcintf Source interface names. 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/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: list or str more...
    • utm_status (Alias name: 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 (Alias name: 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 (Alias name: webcache-https) Enable/disable web caching for https (requires deep-inspection enabled in ssl-ssh-profile). type: str choices: [disable, enable] more...
    • webfilter_profile (Alias name: webfilter-profile) Name of an existing web filter profile. type: str more...
    • webproxy_forward_server (Alias name: webproxy-forward-server) Name of web proxy forward server. type: str more...
    • webproxy_profile (Alias name: webproxy-profile) Name of web proxy profile. type: str more...
    • cifs_profile (Alias name: cifs-profile) Name of an existing cifs profile. type: str more...
    • emailfilter_profile (Alias name: emailfilter-profile) Name of an existing email filter profile. type: str more...
    • internet_service_custom_group (Alias name: internet-service-custom-group) Custom internet service group name. type: list or str more...
    • internet_service_group (Alias name: internet-service-group) Internet service group name. type: list or str more...
    • session_ttl (Alias name: session-ttl) Ttl in seconds for sessions accepted by this policy (0 means use the system default session ttl). type: int or str 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...
    • decrypted_traffic_mirror (Alias name: decrypted-traffic-mirror) Decrypted traffic mirror. type: str more...
    • internet_service_name (Alias name: internet-service-name) Internet service name. type: list or str more...
    • file_filter_profile (Alias name: file-filter-profile) Name of an existing file-filter profile. type: str more...
    • name Policy name. type: str more...
    • access_proxy (Alias name: access-proxy) Access proxy. type: list or str more...
    • device_ownership (Alias name: device-ownership) When enabled, the ownership enforcement will be done at policy level. type: str choices: [disable, enable] more...
    • videofilter_profile (Alias name: videofilter-profile) Name of an existing videofilter profile. type: str more...
    • voip_profile (Alias name: voip-profile) Name of an existing voip profile. type: str more...
    • ztna_ems_tag (Alias name: ztna-ems-tag) Ztna ems tag names. type: list or str more...
    • access_proxy6 (Alias name: access-proxy6) Ipv6 access proxy. type: list or str more...
    • block_notification (Alias name: block-notification) Enable/disable block notification. type: str choices: [disable, enable] more...
    • dlp_profile (Alias name: dlp-profile) Name of an existing dlp profile. type: str more...
    • sctp_filter_profile (Alias name: sctp-filter-profile) Name of an existing sctp filter profile. type: str more...
    • ztna_tags_match_logic (Alias name: ztna-tags-match-logic) Ztna tag matching logic. type: str choices: [or, and] more...
    • casb_profile (Alias name: casb-profile) Name of an existing casb profile. type: str more...
    • detect_https_in_http_request (Alias name: detect-https-in-http-request) Enable/disable detection of https in http request. type: str choices: [disable, enable] more...
    • diameter_filter_profile (Alias name: diameter-filter-profile) Name of an existing diameter filter profile. type: str more...
    • internet_service6 (Alias name: internet-service6) Enable/disable use of internet services ipv6 for this policy. type: str choices: [disable, enable] more...
    • internet_service6_custom (Alias name: internet-service6-custom) Custom internet service ipv6 name. type: list more...
    • internet_service6_custom_group (Alias name: internet-service6-custom-group) Custom internet service ipv6 group name. type: list more...
    • internet_service6_group (Alias name: internet-service6-group) Internet service ipv6 group name. type: list more...
    • internet_service6_name (Alias name: internet-service6-name) Internet service ipv6 name. type: list more...
    • internet_service6_negate (Alias name: internet-service6-negate) When enabled, internet services match against any internet service ipv6 except the selected internet service ipv6. type: str choices: [disable, enable] more...
    • ips_voip_filter (Alias name: ips-voip-filter) Name of an existing voip (ips) profile. type: str more...
    • virtual_patch_profile (Alias name: virtual-patch-profile) Virtual patch profile. type: str more...
    • _policy_block Assigned policy block. type: int more...
    • dnsfilter_profile (Alias name: dnsfilter-profile) Name of an existing dns filter profile. type: list more...
    • log_http_transaction (Alias name: log-http-transaction) Enable/disable http transaction log. type: str choices: [disable, enable] more...
    • ztna_proxy (Alias name: ztna-proxy) Ipv4 ztna traffic forward proxy. type: list 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 proxy policies.
      fortinet.fortimanager.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: 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 proxy policies
      fortinet.fortimanager.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 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)