fmgd_webfilter_fortiguard – Configure FortiGuard Web Filter service.
Added in version 1.0.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 v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
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
- 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
- device - The parameter in requested url type: str required: true
- webfilter_fortiguard - Configure FortiGuard Web Filter service. type: dict
- cache_mem_permille (Alias name: cache-mem-permille) Maximum permille of available memory allocated to caching (1 - 150). type: int more...
- cache_mode (Alias name: cache-mode) Cache entry expiration mode. type: str choices: [ttl, db-ver] more...
- cache_prefix_match (Alias name: cache-prefix-match) Enable/disable prefix matching in the cache. type: str choices: [disable, enable] more...
- close_ports (Alias name: close-ports) Close ports used for http/https override authentication and disable user overrides. type: str choices: [disable, enable] more...
- embed_image (Alias name: embed-image) Enable/disable embedding images into replacement messages (default = enable). type: str choices: [disable, enable] more...
- ovrd_auth_https (Alias name: ovrd-auth-https) Enable/disable use of https for override authentication. type: str choices: [disable, enable] more...
- ovrd_auth_port_http (Alias name: ovrd-auth-port-http) Port to use for fortiguard web filter http override authentication. type: int more...
- ovrd_auth_port_https (Alias name: ovrd-auth-port-https) Port to use for fortiguard web filter https override authentication in proxy mode. type: int more...
- ovrd_auth_port_https_flow (Alias name: ovrd-auth-port-https-flow) Port to use for fortiguard web filter https override authentication in flow mode. type: int more...
- ovrd_auth_port_warning (Alias name: ovrd-auth-port-warning) Port to use for fortiguard web filter warning override authentication. type: int more...
- request_packet_size_limit (Alias name: request-packet-size-limit) Limit size of url request packets sent to fortiguard server (0 for default). type: int more...
- warn_auth_https (Alias name: warn-auth-https) Enable/disable use of https for warning and authentication. type: str choices: [disable, enable] more...
- cache_mem_percent (Alias name: cache-mem-percent) Maximum percentage of available memory allocated to caching (1 - 15). type: int 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: 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: Configure FortiGuard Web Filter service.
fortinet.fmgdevice.fmgd_webfilter_fortiguard:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
webfilter_fortiguard:
# cache_mem_permille: <integer>
# cache_mode: <value in [ttl, db-ver]>
# cache_prefix_match: <value in [disable, enable]>
# close_ports: <value in [disable, enable]>
# embed_image: <value in [disable, enable]>
# ovrd_auth_https: <value in [disable, enable]>
# ovrd_auth_port_http: <integer>
# ovrd_auth_port_https: <integer>
# ovrd_auth_port_https_flow: <integer>
# ovrd_auth_port_warning: <integer>
# request_packet_size_limit: <integer>
# warn_auth_https: <value in [disable, enable]>
# cache_mem_percent: <integer>
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 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.