:source: fmgr_webproxy_explicitproxy.py
:orphan:
.. _fmgr_webproxy_explicitproxy:
fmgr_webproxy_explicitproxy -- Web proxy explicit proxy.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.12.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.
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device (FortiProxy).
- 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
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- webproxy_explicitproxy - Web proxy explicit proxy type: dict
- detect_https_in_http_request (Alias name: detect-https-in-http-request) Detect https in http request. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dns_mode (Alias name: dns-mode) Dns mode. type: str choices: [recursive, non-recursive, forward-only]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dstport_from_incoming (Alias name: dstport-from-incoming) Dstport from incoming. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ftp_incoming_port (Alias name: ftp-incoming-port) Ftp incoming port. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ftp_over_http (Alias name: ftp-over-http) Ftp over http. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- header_proxy_agent (Alias name: header-proxy-agent) Header proxy agent. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- http Http. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- http_connection_mode (Alias name: http-connection-mode) Http connection mode. type: str choices: [static, multiplex, serverpool]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- http_incoming_port (Alias name: http-incoming-port) Http incoming port. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- https_incoming_port (Alias name: https-incoming-port) Https incoming port. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- incoming_ip6 (Alias name: incoming-ip6) Incoming ip6. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface Interface. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ipv6_status (Alias name: ipv6-status) Ipv6 status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- learn_dst_from_sni (Alias name: learn-dst-from-sni) Learn dst from sni. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- name Name. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- pac_file_data (Alias name: pac-file-data) Pac file data. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- pac_file_name (Alias name: pac-file-name) Pac file name. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- pac_file_server_port (Alias name: pac-file-server-port) Pac file server port. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- pac_file_server_status (Alias name: pac-file-server-status) Pac file server status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- pac_file_through_https (Alias name: pac-file-through-https) Pac file through https. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- pac_file_url (Alias name: pac-file-url) Pac file url. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- pref_dns_result (Alias name: pref-dns-result) Pref dns result. type: str choices: [ipv4, ipv6, ipv4-strict, ipv6-strict]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- realm Realm. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- return_to_sender (Alias name: return-to-sender) Return to sender. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- sec_default_action (Alias name: sec-default-action) Sec default action. type: str choices: [deny, accept]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secure_web_proxy (Alias name: secure-web-proxy) Secure web proxy. type: str choices: [disable, enable, secure]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secure_web_proxy_cert (Alias name: secure-web-proxy-cert) Secure web proxy cert. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- socks Socks. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- socks_incoming_port (Alias name: socks-incoming-port) Socks incoming port. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_algorithm (Alias name: ssl-algorithm) Ssl algorithm. type: str choices: [high, low, medium]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_dh_bits (Alias name: ssl-dh-bits) Ssl dh bits. type: str choices: [768, 1024, 1536, 2048]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- status Status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- unknown_http_version (Alias name: unknown-http-version) Unknown http version. type: str choices: [best-effort, reject]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- incoming_ip (Alias name: incoming-ip) Incoming ip. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- client_cert (Alias name: client-cert) Client cert. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.4 -> latest
- empty_cert_action (Alias name: empty-cert-action) Empty cert action. type: str choices: [block, accept, accept-unmanageable]
more...
Supported Version Ranges: v7.6.4 -> latest
- user_agent_detect (Alias name: user-agent-detect) User agent detect. type: str choices: [disable, enable]
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
tasks:
- name: Web proxy explicit proxy
fortinet.fortimanager.fmgr_webproxy_explicitproxy:
# workspace_locking_adom:
adom:
state: present #
webproxy_explicitproxy:
name: "your value" # Required variable, string
# detect_https_in_http_request:
# dns_mode:
# dstport_from_incoming:
# ftp_incoming_port:
# ftp_over_http:
# header_proxy_agent:
# http:
# http_connection_mode:
# http_incoming_port:
# https_incoming_port:
# incoming_ip6:
# interface:
# ipv6_status:
# learn_dst_from_sni:
# pac_file_data:
# pac_file_name:
# pac_file_server_port:
# pac_file_server_status:
# pac_file_through_https:
# pac_file_url:
# pref_dns_result:
# realm:
# return_to_sender:
# sec_default_action:
# secure_web_proxy:
# secure_web_proxy_cert:
# socks:
# socks_incoming_port:
# ssl_algorithm:
# ssl_dh_bits:
# status:
# unknown_http_version:
# incoming_ip:
# client_cert:
# empty_cert_action:
# user_agent_detect:
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)