fortinet.fortimanager.fmgr_pkg_firewall_proxypolicy module – Configure proxy policies.

Note

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

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.

_policy_block

integer

Assigned policy block.

access_proxy

aliases: access-proxy

any

(list or str) Access Proxy.

access_proxy6

aliases: access-proxy6

any

(list or str) IPv6 access proxy.

action

string

Accept or deny traffic matching the policy parameters.

Choices:

  • "accept"

  • "deny"

  • "redirect"

application_list

aliases: application-list

string

Name of an existing Application list.

av_profile

aliases: av-profile

string

Name of an existing Antivirus profile.

block_notification

aliases: block-notification

string

Enable/disable block notification.

Choices:

  • "disable"

  • "enable"

casb_profile

aliases: casb-profile

string

Name of an existing CASB profile.

cifs_profile

aliases: cifs-profile

string

Name of an existing CIFS profile.

comments

string

Optional comments.

decrypted_traffic_mirror

aliases: decrypted-traffic-mirror

string

Decrypted traffic mirror.

detect_https_in_http_request

aliases: detect-https-in-http-request

string

Enable/disable detection of HTTPS in HTTP request.

Choices:

  • "disable"

  • "enable"

device_ownership

aliases: device-ownership

string

When enabled, the ownership enforcement will be done at policy level.

Choices:

  • "disable"

  • "enable"

diameter_filter_profile

aliases: diameter-filter-profile

string

Name of an existing Diameter filter profile.

disclaimer

string

Web proxy disclaimer setting

Choices:

  • "disable"

  • "domain"

  • "policy"

  • "user"

dlp_profile

aliases: dlp-profile

string

Name of an existing DLP profile.

dlp_sensor

aliases: dlp-sensor

string

Name of an existing DLP sensor.

dnsfilter_profile

aliases: dnsfilter-profile

any

(list) Name of an existing DNS filter profile.

dstaddr

any

(list or str) Destination address objects.

dstaddr6

any

(list or str) IPv6 destination address objects.

dstaddr_negate

aliases: dstaddr-negate

string

When enabled, destination addresses match against any address EXCEPT the specified destination addresses.

Choices:

  • "disable"

  • "enable"

dstintf

any

(list or str) Destination interface names.

emailfilter_profile

aliases: emailfilter-profile

string

Name of an existing email filter profile.

file_filter_profile

aliases: file-filter-profile

string

Name of an existing file-filter profile.

global_label

aliases: global-label

string

Global web-based manager visible label.

groups

any

(list or str) Names of group objects.

http_tunnel_auth

aliases: http-tunnel-auth

string

Enable/disable HTTP tunnel authentication.

Choices:

  • "disable"

  • "enable"

icap_profile

aliases: icap-profile

string

Name of an existing ICAP profile.

internet_service

aliases: internet-service

string

Enable/disable use of Internet Services for this policy.

Choices:

  • "disable"

  • "enable"

internet_service6

aliases: internet-service6

string

Enable/disable use of Internet Services IPv6 for this policy.

Choices:

  • "disable"

  • "enable"

internet_service6_custom

aliases: internet-service6-custom

any

(list) Custom Internet Service IPv6 name.

internet_service6_custom_group

aliases: internet-service6-custom-group

any

(list) Custom Internet Service IPv6 group name.

internet_service6_group

aliases: internet-service6-group

any

(list) Internet Service IPv6 group name.

internet_service6_name

aliases: internet-service6-name

any

(list) Internet Service IPv6 name.

internet_service6_negate

aliases: internet-service6-negate

string

When enabled, Internet Services match against any internet service IPv6 EXCEPT the selected Internet Service IPv6.

Choices:

  • "disable"

  • "enable"

internet_service_custom

aliases: internet-service-custom

any

(list or str) Custom Internet Service name.

internet_service_custom_group

aliases: internet-service-custom-group

any

(list or str) Custom Internet Service group name.

internet_service_group

aliases: internet-service-group

any

(list or str) Internet Service group name.

internet_service_id

aliases: internet-service-id

any

(list or str) Internet Service ID.

internet_service_name

aliases: internet-service-name

any

(list or str) Internet Service name.

internet_service_negate

aliases: internet-service-negate

string

When enabled, Internet Services match against any internet service EXCEPT the selected Internet Service.

Choices:

  • "disable"

  • "enable"

ips_sensor

aliases: ips-sensor

string

Name of an existing IPS sensor.

ips_voip_filter

aliases: ips-voip-filter

string

Name of an existing VoIP

label

string

VDOM-specific GUI visible label.

log_http_transaction

aliases: log-http-transaction

string

Enable/disable HTTP transaction log.

Choices:

  • "disable"

  • "enable"

logtraffic

string

Enable/disable logging traffic through the policy.

Choices:

  • "disable"

  • "all"

  • "utm"

logtraffic_start

aliases: logtraffic-start

string

Enable/disable policy log traffic start.

Choices:

  • "disable"

  • "enable"

mms_profile

aliases: mms-profile

string

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

aliases: profile-group

string

Name of profile group.

profile_protocol_options

aliases: profile-protocol-options

string

Name of an existing Protocol options profile.

profile_type

aliases: profile-type

string

Determine whether the firewall policy allows security profile groups or single profiles only.

Choices:

  • "single"

  • "group"

proxy

string

Type of explicit proxy.

Choices:

  • "explicit-web"

  • "transparent-web"

  • "ftp"

  • "wanopt"

  • "ssh"

  • "ssh-tunnel"

  • "access-proxy"

  • "ztna-proxy"

redirect_url

aliases: redirect-url

string

Redirect URL for further explicit web proxy processing.

replacemsg_override_group

aliases: replacemsg-override-group

string

Authentication replacement message override group.

scan_botnet_connections

aliases: scan-botnet-connections

string

Enable/disable scanning of connections to Botnet servers.

Choices:

  • "disable"

  • "block"

  • "monitor"

schedule

string

Name of schedule object.

sctp_filter_profile

aliases: sctp-filter-profile

string

Name of an existing SCTP filter profile.

service

any

(list or str) Name of service objects.

service_negate

aliases: service-negate

string

When enabled, services match against any service EXCEPT the specified destination services.

Choices:

  • "disable"

  • "enable"

session_ttl

aliases: session-ttl

any

(int or str) TTL in seconds for sessions accepted by this policy

spamfilter_profile

aliases: spamfilter-profile

string

Name of an existing Spam filter profile.

srcaddr

any

(list or str) Source address objects

srcaddr6

any

(list or str) IPv6 source address objects.

srcaddr_negate

aliases: srcaddr-negate

string

When enabled, source addresses match against any address EXCEPT the specified source addresses.

Choices:

  • "disable"

  • "enable"

srcintf

any

(list or str) Source interface names.

ssh_filter_profile

aliases: ssh-filter-profile

string

Name of an existing SSH filter profile.

ssh_policy_redirect

aliases: ssh-policy-redirect

string

Redirect SSH traffic to matching transparent proxy policy.

Choices:

  • "disable"

  • "enable"

ssl_ssh_profile

aliases: ssl-ssh-profile

string

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

aliases: utm-status

string

Enable the use of UTM profiles/sensors/lists.

Choices:

  • "disable"

  • "enable"

uuid

string

Universally Unique Identifier

videofilter_profile

aliases: videofilter-profile

string

Name of an existing VideoFilter profile.

virtual_patch_profile

aliases: virtual-patch-profile

string

Virtual patch profile.

voip_profile

aliases: voip-profile

string

Name of an existing VoIP profile.

waf_profile

aliases: waf-profile

string

Name of an existing Web application firewall profile.

webcache

string

Enable/disable web caching.

Choices:

  • "disable"

  • "enable"

webcache_https

aliases: webcache-https

string

Enable/disable web caching for HTTPS

Choices:

  • "disable"

  • "enable"

webfilter_profile

aliases: webfilter-profile

string

Name of an existing Web filter profile.

webproxy_forward_server

aliases: webproxy-forward-server

string

Name of web proxy forward server.

webproxy_profile

aliases: webproxy-profile

string

Name of web proxy profile.

ztna_ems_tag

aliases: ztna-ems-tag

any

(list or str) ZTNA EMS Tag names.

ztna_proxy

aliases: ztna-proxy

any

(list) IPv4 ZTNA traffic forward proxy.

ztna_tags_match_logic

aliases: ztna-tags-match-logic

string

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)