fmgr_firewall_proxyaddress – Web proxy address configuration.¶
New in version 2.10.
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| firewall_proxyaddress | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- firewall_proxyaddress - no description type: dict
- case-sensitivity - Enable to make the pattern case sensitive. type: str choices: [disable, enable] more...
- category - FortiGuard category ID. type: str more...
- color - Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets value to 1). type: int more...
- comment - Optional comments. type: str more...
- header - HTTP header name as a regular expression. type: str more...
- header-group - Header-Group. type: array more...
- header-name - Name of HTTP header. type: str more...
- host - Address object for the host. type: str more...
- host-regex - Host name as a regular expression. type: str more...
- method - HTTP request methods to be used. type: array choices: [delete, get, head, options, post, put, trace, connect] more...
- name - Address name. type: str more...
- path - URL path as a regular expression. type: str more...
- query - Match the query part of the URL as a regular expression. type: str more...
- referrer - Enable/disable use of referrer field in the HTTP header to match the address. type: str choices: [disable, enable] more...
- tagging - Tagging. type: array more...
- type - Proxy address type. type: str choices: [host-regex, url, category, method, ua, header, src-advanced, dst-advanced, url-list] more...
- ua - Names of browsers to be used as user agent. type: array choices: [chrome, ms, firefox, safari, other] more...
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
- visibility - Enable/disable visibility of the object in the GUI. type: str choices: [disable, enable] more...
- _image-base64 - _Image-Base64. type: str more...
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¶
- name: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the proxy addresses
fmgr_fact:
facts:
selector: 'firewall_proxyaddress'
params:
adom: 'ansible'
proxy-address: 'your_value'
- hosts: fortimanager00
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
adom: ansible
state: present
firewall_proxyaddress:
case-sensitivity: disable
color: 1
comment: 'ansible-comment'
name: 'ansible-test'
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict