fortinet.fortimanager.fmgr_pkg_firewall_proxypolicy module – Configure proxy policies.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_firewall_proxypolicy.

New in fortinet.fortimanager 2.0.0

Synopsis

  • 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.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

pkg

string / required

The parameter (pkg) in requested url.

pkg_firewall_proxypolicy

dictionary

The top level parameters set.

access-proxy

any

(list or str) Deprecated, please rename it to access_proxy. Access Proxy.

access-proxy6

any

(list or str) Deprecated, please rename it to access_proxy6.

action

string

Accept or deny traffic matching the policy parameters.

Choices:

  • "accept"

  • "deny"

  • "redirect"

application-list

string

Deprecated, please rename it to application_list. Name of an existing Application list.

av-profile

string

Deprecated, please rename it to av_profile. Name of an existing Antivirus profile.

block-notification

string

Deprecated, please rename it to block_notification. Enable/disable block notification.

Choices:

  • "disable"

  • "enable"

casb-profile

string

Deprecated, please rename it to casb_profile. Name of an existing CASB profile.

cifs-profile

string

Deprecated, please rename it to cifs_profile. Name of an existing CIFS profile.

comments

string

Optional comments.

decrypted-traffic-mirror

string

Deprecated, please rename it to decrypted_traffic_mirror. Decrypted traffic mirror.

detect-https-in-http-request

string

Deprecated, please rename it to detect_https_in_http_request. Enable/disable detection of HTTPS in HTTP request.

Choices:

  • "disable"

  • "enable"

device-ownership

string

Deprecated, please rename it to device_ownership. When enabled, the ownership enforcement will be done at policy level.

Choices:

  • "disable"

  • "enable"

diameter-filter-profile

string

Deprecated, please rename it to diameter_filter_profile. Name of an existing Diameter filter profile.

disclaimer

string

Web proxy disclaimer setting

Choices:

  • "disable"

  • "domain"

  • "policy"

  • "user"

dlp-profile

string

Deprecated, please rename it to dlp_profile. Name of an existing DLP profile.

dlp-sensor

string

Deprecated, please rename it to dlp_sensor. Name of an existing DLP sensor.

dstaddr

any

(list or str) Destination address objects.

dstaddr-negate

string

Deprecated, please rename it to dstaddr_negate. When enabled, destination addresses match against any address EXCEPT the s…

Choices:

  • "disable"

  • "enable"

dstaddr6

any

(list or str) IPv6 destination address objects.

dstintf

any

(list or str) Destination interface names.

emailfilter-profile

string

Deprecated, please rename it to emailfilter_profile. Name of an existing email filter profile.

file-filter-profile

string

Deprecated, please rename it to file_filter_profile. Name of an existing file-filter profile.

global-label

string

Deprecated, please rename it to global_label. Global web-based manager visible label.

groups

any

(list or str) Names of group objects.

http-tunnel-auth

string

Deprecated, please rename it to http_tunnel_auth. Enable/disable HTTP tunnel authentication.

Choices:

  • "disable"

  • "enable"

icap-profile

string

Deprecated, please rename it to icap_profile. Name of an existing ICAP profile.

internet-service

string

Deprecated, please rename it to internet_service. Enable/disable use of Internet Services for this policy.

Choices:

  • "disable"

  • "enable"

internet-service-custom

any

(list or str) Deprecated, please rename it to internet_service_custom. Custom Internet Service name.

internet-service-custom-group

any

(list or str) Deprecated, please rename it to internet_service_custom_group. Custom Internet Service group name.

internet-service-group

any

(list or str) Deprecated, please rename it to internet_service_group. Internet Service group name.

internet-service-id

any

(list or str) Deprecated, please rename it to internet_service_id. Internet Service ID.

internet-service-name

any

(list or str) Deprecated, please rename it to internet_service_name. Internet Service name.

internet-service-negate

string

Deprecated, please rename it to internet_service_negate. When enabled, Internet Services match against any internet servic…

Choices:

  • "disable"

  • "enable"

internet-service6

string

Deprecated, please rename it to internet_service6. Enable/disable use of Internet Services IPv6 for this policy.

Choices:

  • "disable"

  • "enable"

internet-service6-custom

any

(list) Deprecated, please rename it to internet_service6_custom.

internet-service6-custom-group

any

(list) Deprecated, please rename it to internet_service6_custom_group.

internet-service6-group

any

(list) Deprecated, please rename it to internet_service6_group.

internet-service6-name

any

(list) Deprecated, please rename it to internet_service6_name.

internet-service6-negate

string

Deprecated, please rename it to internet_service6_negate. When enabled, Internet Services match against any internet servi…

Choices:

  • "disable"

  • "enable"

ips-sensor

string

Deprecated, please rename it to ips_sensor. Name of an existing IPS sensor.

ips-voip-filter

string

Deprecated, please rename it to ips_voip_filter. Name of an existing VoIP

label

string

VDOM-specific GUI visible label.

logtraffic

string

Enable/disable logging traffic through the policy.

Choices:

  • "disable"

  • "all"

  • "utm"

logtraffic-start

string

Deprecated, please rename it to logtraffic_start. Enable/disable policy log traffic start.

Choices:

  • "disable"

  • "enable"

mms-profile

string

Deprecated, please rename it to mms_profile. Name of an existing MMS profile.

name

string

Policy name.

policyid

integer / required

Policy ID.

poolname

any

(list or str) Name of IP pool object.

profile-group

string

Deprecated, please rename it to profile_group. Name of profile group.

profile-protocol-options

string

Deprecated, please rename it to profile_protocol_options. Name of an existing Protocol options profile.

profile-type

string

Deprecated, please rename it to profile_type. Determine whether the firewall policy allows security profile groups or sing…

Choices:

  • "single"

  • "group"

proxy

string

Type of explicit proxy.

Choices:

  • "explicit-web"

  • "transparent-web"

  • "ftp"

  • "wanopt"

  • "ssh"

  • "ssh-tunnel"

  • "access-proxy"

redirect-url

string

Deprecated, please rename it to redirect_url. Redirect URL for further explicit web proxy processing.

replacemsg-override-group

string

Deprecated, please rename it to replacemsg_override_group. Authentication replacement message override group.

scan-botnet-connections

string

Deprecated, please rename it to scan_botnet_connections. Enable/disable scanning of connections to Botnet servers.

Choices:

  • "disable"

  • "block"

  • "monitor"

schedule

string

Name of schedule object.

sctp-filter-profile

string

Deprecated, please rename it to sctp_filter_profile. Name of an existing SCTP filter profile.

service

any

(list or str) Name of service objects.

service-negate

string

Deprecated, please rename it to service_negate. When enabled, services match against any service EXCEPT the specified dest…

Choices:

  • "disable"

  • "enable"

session-ttl

any

(int or str) Deprecated, please rename it to session_ttl. TTL in seconds for sessions accepted by this policy

spamfilter-profile

string

Deprecated, please rename it to spamfilter_profile. Name of an existing Spam filter profile.

srcaddr

any

(list or str) Source address objects

srcaddr-negate

string

Deprecated, please rename it to srcaddr_negate. When enabled, source addresses match against any address EXCEPT the specif…

Choices:

  • "disable"

  • "enable"

srcaddr6

any

(list or str) IPv6 source address objects.

srcintf

any

(list or str) Source interface names.

ssh-filter-profile

string

Deprecated, please rename it to ssh_filter_profile. Name of an existing SSH filter profile.

ssh-policy-redirect

string

Deprecated, please rename it to ssh_policy_redirect. Redirect SSH traffic to matching transparent proxy policy.

Choices:

  • "disable"

  • "enable"

ssl-ssh-profile

string

Deprecated, please rename it to ssl_ssh_profile. Name of an existing SSL SSH profile.

status

string

Enable/disable the active status of the policy.

Choices:

  • "disable"

  • "enable"

tags

string

Names of object-tags applied to address.

transparent

string

Enable to use the IP address of the client to connect to the server.

Choices:

  • "disable"

  • "enable"

users

any

(list or str) Names of user objects.

utm-status

string

Deprecated, please rename it to utm_status. Enable the use of UTM profiles/sensors/lists.

Choices:

  • "disable"

  • "enable"

uuid

string

Universally Unique Identifier

videofilter-profile

string

Deprecated, please rename it to videofilter_profile. Name of an existing VideoFilter profile.

virtual-patch-profile

string

Deprecated, please rename it to virtual_patch_profile.

voip-profile

string

Deprecated, please rename it to voip_profile. Name of an existing VoIP profile.

waf-profile

string

Deprecated, please rename it to waf_profile. Name of an existing Web application firewall profile.

webcache

string

Enable/disable web caching.

Choices:

  • "disable"

  • "enable"

webcache-https

string

Deprecated, please rename it to webcache_https. Enable/disable web caching for HTTPS

Choices:

  • "disable"

  • "enable"

webfilter-profile

string

Deprecated, please rename it to webfilter_profile. Name of an existing Web filter profile.

webproxy-forward-server

string

Deprecated, please rename it to webproxy_forward_server. Name of web proxy forward server.

webproxy-profile

string

Deprecated, please rename it to webproxy_profile. Name of web proxy profile.

ztna-ems-tag

any

(list or str) Deprecated, please rename it to ztna_ems_tag. ZTNA EMS Tag names.

ztna-tags-match-logic

string

Deprecated, please rename it to ztna_tags_match_logic. ZTNA tag matching logic.

Choices:

  • "or"

  • "and"

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

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

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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 here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)