fortinet.fortimanager.fmgr_webproxy_explicitproxy module – Web proxy explicit proxy

Note

This module is part of the fortinet.fortimanager collection (version 2.12.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_webproxy_explicitproxy.

New in fortinet.fortimanager 2.12.0

Synopsis

  • This module is able to configure a FortiManager device (FortiProxy).

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

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.

revision_note

string

The change note that can be specified when an object is created or updated.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

webproxy_explicitproxy

dictionary

The top level parameters set.

client_cert

aliases: client-cert

string

Client cert.

Choices:

  • "disable"

  • "enable"

detect_https_in_http_request

aliases: detect-https-in-http-request

string

Detect https in http request.

Choices:

  • "disable"

  • "enable"

dns_mode

aliases: dns-mode

string

Dns mode.

Choices:

  • "recursive"

  • "non-recursive"

  • "forward-only"

dstport_from_incoming

aliases: dstport-from-incoming

string

Dstport from incoming.

Choices:

  • "disable"

  • "enable"

empty_cert_action

aliases: empty-cert-action

string

Empty cert action.

Choices:

  • "block"

  • "accept"

  • "accept-unmanageable"

ftp_incoming_port

aliases: ftp-incoming-port

list / elements=string

Ftp incoming port.

ftp_over_http

aliases: ftp-over-http

string

Ftp over http.

Choices:

  • "disable"

  • "enable"

header_proxy_agent

aliases: header-proxy-agent

string

Header proxy agent.

Choices:

  • "disable"

  • "enable"

http

string

Http.

Choices:

  • "disable"

  • "enable"

http_connection_mode

aliases: http-connection-mode

string

Http connection mode.

Choices:

  • "static"

  • "multiplex"

  • "serverpool"

http_incoming_port

aliases: http-incoming-port

list / elements=string

Http incoming port.

https_incoming_port

aliases: https-incoming-port

list / elements=string

Https incoming port.

incoming_ip

aliases: incoming-ip

string

Incoming ip.

incoming_ip6

aliases: incoming-ip6

string

Incoming ip6.

interface

list / elements=string

Interface.

ipv6_status

aliases: ipv6-status

string

Ipv6 status.

Choices:

  • "disable"

  • "enable"

learn_dst_from_sni

aliases: learn-dst-from-sni

string

Learn dst from sni.

Choices:

  • "disable"

  • "enable"

name

string / required

Name.

pac_file_data

aliases: pac-file-data

string

Pac file data.

pac_file_name

aliases: pac-file-name

string

Pac file name.

pac_file_server_port

aliases: pac-file-server-port

string

Pac file server port.

pac_file_server_status

aliases: pac-file-server-status

string

Pac file server status.

Choices:

  • "disable"

  • "enable"

pac_file_through_https

aliases: pac-file-through-https

string

Pac file through https.

Choices:

  • "disable"

  • "enable"

pac_file_url

aliases: pac-file-url

string

Pac file url.

pref_dns_result

aliases: pref-dns-result

string

Pref dns result.

Choices:

  • "ipv4"

  • "ipv6"

  • "ipv4-strict"

  • "ipv6-strict"

realm

string

Realm.

return_to_sender

aliases: return-to-sender

string

Return to sender.

Choices:

  • "disable"

  • "enable"

sec_default_action

aliases: sec-default-action

string

Sec default action.

Choices:

  • "deny"

  • "accept"

secure_web_proxy

aliases: secure-web-proxy

string

Secure web proxy.

Choices:

  • "disable"

  • "enable"

  • "secure"

secure_web_proxy_cert

aliases: secure-web-proxy-cert

list / elements=string

Secure web proxy cert.

socks

string

Socks.

Choices:

  • "disable"

  • "enable"

socks_incoming_port

aliases: socks-incoming-port

list / elements=string

Socks incoming port.

ssl_algorithm

aliases: ssl-algorithm

string

Ssl algorithm.

Choices:

  • "high"

  • "low"

  • "medium"

ssl_dh_bits

aliases: ssl-dh-bits

string

Ssl dh bits.

Choices:

  • "768"

  • "1024"

  • "1536"

  • "2048"

status

string

Status.

Choices:

  • "disable"

  • "enable"

unknown_http_version

aliases: unknown-http-version

string

Unknown http version.

Choices:

  • "best-effort"

  • "reject"

user_agent_detect

aliases: user-agent-detect

string

User agent detect.

Choices:

  • "disable"

  • "enable"

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 (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: Web proxy explicit proxy
      fortinet.fortimanager.fmgr_webproxy_explicitproxy:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        webproxy_explicitproxy:
          name: "your value" # Required variable, string
          # detect_https_in_http_request: <value in [disable, enable]>
          # dns_mode: <value in [recursive, non-recursive, forward-only]>
          # dstport_from_incoming: <value in [disable, enable]>
          # ftp_incoming_port: <list or string>
          # ftp_over_http: <value in [disable, enable]>
          # header_proxy_agent: <value in [disable, enable]>
          # http: <value in [disable, enable]>
          # http_connection_mode: <value in [static, multiplex, serverpool]>
          # http_incoming_port: <list or string>
          # https_incoming_port: <list or string>
          # incoming_ip6: <string>
          # interface: <list or string>
          # ipv6_status: <value in [disable, enable]>
          # learn_dst_from_sni: <value in [disable, enable]>
          # pac_file_data: <string>
          # pac_file_name: <string>
          # pac_file_server_port: <string>
          # pac_file_server_status: <value in [disable, enable]>
          # pac_file_through_https: <value in [disable, enable]>
          # pac_file_url: <string>
          # pref_dns_result: <value in [ipv4, ipv6, ipv4-strict, ...]>
          # realm: <string>
          # return_to_sender: <value in [disable, enable]>
          # sec_default_action: <value in [deny, accept]>
          # secure_web_proxy: <value in [disable, enable, secure]>
          # secure_web_proxy_cert: <list or string>
          # socks: <value in [disable, enable]>
          # socks_incoming_port: <list or string>
          # ssl_algorithm: <value in [high, low, medium]>
          # ssl_dh_bits: <value in [768, 1024, 1536, ...]>
          # status: <value in [disable, enable]>
          # unknown_http_version: <value in [best-effort, reject]>
          # incoming_ip: <string>
          # client_cert: <value in [disable, enable]>
          # empty_cert_action: <value in [block, accept, accept-unmanageable]>
          # user_agent_detect: <value in [disable, enable]>

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)