W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_firewall_proxyaddress – Web proxy address configuration.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

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

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

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			Choices/Defaults	Comments
adom string / required				the parameter (adom) in requested url
bypass_validation boolean			Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean			Choices: no ← yes	Enable/Disable logging for task
firewall_proxyaddress dictionary				the top level parameters set
	_image-base64 string			no description
	case-sensitivity string		Choices: disable enable	Enable to make the pattern case sensitive.
	category string			FortiGuard category ID.
	color integer			Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets value to 1).
	comment string			Optional comments.
	header string			HTTP header name as a regular expression.
	header-group list / elements=string			no description
		case-sensitivity string	Choices: disable enable	Case sensitivity in pattern.
		header string		HTTP header regular expression.
		header-name string		HTTP header.
		id integer		ID.
	header-name string			Name of HTTP header.
	host string			Address object for the host.
	host-regex string			Host name as a regular expression.
	method list / elements=string		Choices: delete get head options post put trace connect	no description
	name string			Address name.
	path string			URL path as a regular expression.
	query string			Match the query part of the URL as a regular expression.
	referrer string		Choices: disable enable	Enable/disable use of referrer field in the HTTP header to match the address.
	tagging list / elements=string			no description
		category string		Tag category.
		name string		Tagging entry name.
		tags string		no description
	type string		Choices: host-regex url category method ua header src-advanced dst-advanced	Proxy address type.
	ua list / elements=string		Choices: chrome ms firefox safari other	no description
	uuid string			Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
	visibility string		Choices: disable enable	Enable/disable visibility of the object in the GUI.
proposed_method string			Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string				the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string				the rc codes list with which the conditions to succeed will be overriden
state string / required			Choices: present absent	the directive to create, update or delete an object
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			Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Web proxy address configuration.
     fmgr_firewall_proxyaddress:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        firewall_proxyaddress:
           case-sensitivity: <value in [disable, enable]>
           category: <value of string>
           color: <value of integer>
           comment: <value of string>
           header: <value of string>
           header-group:
             -
                 case-sensitivity: <value in [disable, enable]>
                 header: <value of string>
                 header-name: <value of string>
                 id: <value of integer>
           header-name: <value of string>
           host: <value of string>
           host-regex: <value of string>
           method:
             - delete
             - get
             - head
             - options
             - post
             - put
             - trace
             - connect
           name: <value of string>
           path: <value of string>
           query: <value of string>
           referrer: <value in [disable, enable]>
           tagging:
             -
                 category: <value of string>
                 name: <value of string>
                 tags: <value of string>
           type: <value in [host-regex, url, category, ...]>
           ua:
             - chrome
             - ms
             - firefox
             - safari
             - other
           uuid: <value of string>
           visibility: <value in [disable, enable]>
           _image-base64: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_proxyaddress_module.html