fmgr_firewall_explicitproxyaddress – Explicit web proxy address configuration.¶
New in version 2.2.0.
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 v6.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.4 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
6.2.12 |
|
| True | True | True | True | None | True | True | True | True | True | True | True | True | |
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
6.4.12 |
6.4.13 |
| False | False | False | False | False | False | False | False | False | False | False | False | False | False |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
7.0.8 |
7.0.9 |
7.0.10 |
|||
| False | False | False | False | False | False | False | False | False | False | False | |||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
7.2.4 |
|||||||||
| False | False | False | False | False | |||||||||
7.4.0 |
7.4.1 |
||||||||||||
| False | False |
Parameters¶
- 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
- adom - The parameter in requested url type: str required: true
- firewall_explicitproxyaddress - Explicit web proxy address configuration. type: dict
- case-sensitivity - Case sensitivity in pattern. type: str choices: [disable, enable] more...
- category - FortiGuard category ID. type: str more...
- color - GUI icon color. type: int more...
- comment - Comment. type: str more...
- header - HTTP header regular expression. type: str more...
- header-group - No description for the parameter type: list more...
- header-name - HTTP header. type: str more...
- host - Host address type: str more...
- host-regex - Host regular expression. type: str more...
- method - No description for the parameter type: list choices: [delete, get, head, options, post, put, trace, connect] more...
- name - Address name. type: str more...
- path - URL path regular expression. type: str more...
- tags - Applied object tags. type: str more...
- type - Address type. type: str choices: [host-regex, url, category, method, ua, header, src-advanced, dst-advanced] more...
- ua - No description for the parameter type: list choices: [chrome, ms, firefox, safari, other] more...
- uuid - Universally Unique IDentifier. type: str more...
- visibility - Enable/disable address visibility. type: str choices: [disable, enable] 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¶
- 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: Explicit web proxy address configuration.
fmgr_firewall_explicitproxyaddress:
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_explicitproxyaddress:
case-sensitivity: <value in [disable, enable]>
category: <string>
color: <integer>
comment: <string>
header: <string>
header-group:
-
case-sensitivity: <value in [disable, enable]>
header: <string>
header-name: <string>
id: <integer>
header-name: <string>
host: <string>
host-regex: <string>
method:
- delete
- get
- head
- options
- post
- put
- trace
- connect
name: <string>
path: <string>
tags: <string>
type: <value in [host-regex, url, category, ...]>
ua:
- chrome
- ms
- firefox
- safari
- other
uuid: <string>
visibility: <value in [disable, enable]>
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:
- 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 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0