:source: fmgd_firewall_proxypolicy.py
:orphan:
.. _fmgd_firewall_proxypolicy:
fmgd_firewall_proxypolicy -- Configure proxy policies.
++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.1.0
.. contents::
:local:
:depth: 1
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-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
Parameters
----------
.. raw:: html
- 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
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- firewall_proxypolicy - Configure proxy policies. type: dict
- access_proxy (Alias name: access-proxy) Ipv4 access proxy. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- access_proxy6 (Alias name: access-proxy6) Ipv6 access proxy. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- action Accept or deny traffic matching the policy parameters. type: str choices: [accept, deny, redirect, isolate]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- application_list (Alias name: application-list) Name of an existing application list. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- av_profile (Alias name: av-profile) Name of an existing antivirus profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_notification (Alias name: block-notification) Enable/disable block notification. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- casb_profile (Alias name: casb-profile) Name of an existing casb profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- comments Optional comments. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- decrypted_traffic_mirror (Alias name: decrypted-traffic-mirror) Decrypted traffic mirror. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- 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...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- device_ownership (Alias name: device-ownership) When enabled, the ownership enforcement will be done at policy level. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- diameter_filter_profile (Alias name: diameter-filter-profile) Name of an existing diameter filter profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- disclaimer Web proxy disclaimer setting: by domain, policy, or user. type: str choices: [disable, domain, policy, user]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dlp_profile (Alias name: dlp-profile) Name of an existing dlp profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dstaddr Destination address objects. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- 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...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dstaddr6 Ipv6 destination address objects. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dstintf Destination interface names. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- emailfilter_profile (Alias name: emailfilter-profile) Name of an existing email filter profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- file_filter_profile (Alias name: file-filter-profile) Name of an existing file-filter profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- global_label (Alias name: global-label) Global web-based manager visible label. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- groups Names of group objects. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- http_tunnel_auth (Alias name: http-tunnel-auth) Enable/disable http tunnel authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- icap_profile (Alias name: icap-profile) Name of an existing icap profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- internet_service (Alias name: internet-service) Enable/disable use of internet services for this policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- internet_service_custom (Alias name: internet-service-custom) Custom internet service name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- internet_service_custom_group (Alias name: internet-service-custom-group) Custom internet service group name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- internet_service_group (Alias name: internet-service-group) Internet service group name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- internet_service_name (Alias name: internet-service-name) Internet service name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- 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...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- internet_service6 (Alias name: internet-service6) Enable/disable use of internet services ipv6 for this policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- internet_service6_custom (Alias name: internet-service6-custom) Custom internet service ipv6 name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- internet_service6_custom_group (Alias name: internet-service6-custom-group) Custom internet service ipv6 group name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- internet_service6_group (Alias name: internet-service6-group) Internet service ipv6 group name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- internet_service6_name (Alias name: internet-service6-name) Internet service ipv6 name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- 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...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ips_sensor (Alias name: ips-sensor) Name of an existing ips sensor. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ips_voip_filter (Alias name: ips-voip-filter) Name of an existing voip (ips) profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- label Vdom-specific gui visible label. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- logtraffic Enable/disable logging traffic through the policy. type: str choices: [disable, all, utm]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- logtraffic_start (Alias name: logtraffic-start) Enable/disable policy log traffic start. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- name Policy name. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- policyid Policy id. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- poolname Name of ip pool object. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- poolname6 Name of ipv6 pool object. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.5 -> latest
- profile_group (Alias name: profile-group) Name of profile group. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- profile_protocol_options (Alias name: profile-protocol-options) Name of an existing protocol options profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- 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...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- proxy Type of explicit proxy. type: str choices: [explicit-web, transparent-web, ftp, wanopt, ssh, ssh-tunnel, access-proxy, ztna-proxy]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- redirect_url (Alias name: redirect-url) Redirect url for further explicit web proxy processing. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- replacemsg_override_group (Alias name: replacemsg-override-group) Authentication replacement message override group. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- schedule Name of schedule object. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- sctp_filter_profile (Alias name: sctp-filter-profile) Name of an existing sctp filter profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- service Name of service objects. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- service_negate (Alias name: service-negate) When enabled, services match against any service except the specified destination services. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- session_ttl (Alias name: session-ttl) Ttl in seconds for sessions accepted by this policy (0 means use the system default session ttl). type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- srcaddr Source address objects. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- 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...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- srcaddr6 Ipv6 source address objects. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- srcintf Source interface names. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssh_filter_profile (Alias name: ssh-filter-profile) Name of an existing ssh filter profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssh_policy_redirect (Alias name: ssh-policy-redirect) Redirect ssh traffic to matching transparent proxy policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_ssh_profile (Alias name: ssl-ssh-profile) Name of an existing ssl ssh profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- status Enable/disable the active status of the policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- transparent Enable to use the ip address of the client to connect to the server. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- users Names of user objects. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- utm_status (Alias name: utm-status) Enable the use of utm profiles/sensors/lists. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- videofilter_profile (Alias name: videofilter-profile) Name of an existing videofilter profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- virtual_patch_profile (Alias name: virtual-patch-profile) Virtual patch profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- waf_profile (Alias name: waf-profile) Name of an existing web application firewall profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- webcache Enable/disable web caching. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- 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...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- webfilter_profile (Alias name: webfilter-profile) Name of an existing web filter profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- webproxy_forward_server (Alias name: webproxy-forward-server) Web proxy forward server name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- webproxy_profile (Alias name: webproxy-profile) Name of web proxy profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ztna_ems_tag (Alias name: ztna-ems-tag) Ztna ems tag names. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ztna_tags_match_logic (Alias name: ztna-tags-match-logic) Ztna tag matching logic. type: str choices: [or, and]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- voip_profile (Alias name: voip-profile) Name of an existing voip profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dlp_sensor (Alias name: dlp-sensor) Name of an existing dlp sensor. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- cifs_profile (Alias name: cifs-profile) Name of an existing cifs profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- internet_service_id (Alias name: internet-service-id) Internet service id. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10
- mms_profile (Alias name: mms-profile) Name of an existing mms profile. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10
- _policy_block Assigned policy block. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- dnsfilter_profile (Alias name: dnsfilter-profile) Name of an existing dns filter profile. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- https_sub_category (Alias name: https-sub-category) Enable/disable https sub-category policy matching. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.4 -> latest
- internet_service_fortiguard (Alias name: internet-service-fortiguard) Fortiguard internet service name. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- internet_service6_fortiguard (Alias name: internet-service6-fortiguard) Fortiguard internet service ipv6 name. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- isolator_server (Alias name: isolator-server) Isolator server name. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- log_http_transaction (Alias name: log-http-transaction) Enable/disable http transaction log. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.4 -> latest
- telemetry_profile (Alias name: telemetry-profile) Name of an existing telemetry profile. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- url_risk (Alias name: url-risk) Url risk level name. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- ztna_ems_tag_negate (Alias name: ztna-ems-tag-negate) When enabled, ztna ems tags match against any tag except the specified ztna ems tags. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.4 -> latest
- ztna_proxy (Alias name: ztna-proxy) Ztna proxies. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure proxy policies.
fortinet.fmgdevice.fmgd_firewall_proxypolicy:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
state: present #
firewall_proxypolicy:
policyid: 0 # Required variable, integer
# access_proxy:
# access_proxy6:
# action:
# application_list:
# av_profile:
# block_notification:
# casb_profile:
# comments:
# decrypted_traffic_mirror:
# detect_https_in_http_request:
# device_ownership:
# diameter_filter_profile:
# disclaimer:
# dlp_profile:
# dstaddr:
# dstaddr_negate:
# dstaddr6:
# dstintf:
# emailfilter_profile:
# file_filter_profile:
# global_label:
# groups:
# http_tunnel_auth:
# icap_profile:
# internet_service:
# internet_service_custom:
# internet_service_custom_group:
# internet_service_group:
# internet_service_name:
# internet_service_negate:
# internet_service6:
# internet_service6_custom:
# internet_service6_custom_group:
# internet_service6_group:
# internet_service6_name:
# internet_service6_negate:
# ips_sensor:
# ips_voip_filter:
# label:
# logtraffic:
# logtraffic_start:
# name:
# poolname:
# poolname6:
# profile_group:
# profile_protocol_options:
# profile_type:
# proxy:
# redirect_url:
# replacemsg_override_group:
# schedule:
# sctp_filter_profile:
# service:
# service_negate:
# session_ttl:
# srcaddr:
# srcaddr_negate:
# srcaddr6:
# srcintf:
# ssh_filter_profile:
# ssh_policy_redirect:
# ssl_ssh_profile:
# status:
# transparent:
# users:
# utm_status:
# uuid:
# videofilter_profile:
# virtual_patch_profile:
# waf_profile:
# webcache:
# webcache_https:
# webfilter_profile:
# webproxy_forward_server:
# webproxy_profile:
# ztna_ems_tag:
# ztna_tags_match_logic:
# voip_profile:
# dlp_sensor:
# cifs_profile:
# internet_service_id:
# mms_profile:
# _policy_block:
# dnsfilter_profile:
# https_sub_category:
# internet_service_fortiguard:
# internet_service6_fortiguard:
# isolator_server:
# log_http_transaction:
# telemetry_profile:
# url_risk:
# ztna_ems_tag_negate:
# ztna_proxy:
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:
.. raw:: html
- 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)