fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_webfilter_profile_override Web Filter override settings. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_webfilter_profile_override (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Web Filter override settings. fortinet.fortimanager.fmgr_webfilter_profile_override: # 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> profile: <your own value> webfilter_profile_override: ovrd_cookie: <value in [deny, allow]> ovrd_dur: <string> ovrd_dur_mode: <value in [constant, ask]> ovrd_scope: <value in [user, user-group, ip, ...]> ovrd_user_group: <list or string> profile: <list or string> profile_attribute: <value in [User-Name, User-Password, CHAP-Password, ...]> profile_type: <value in [list, radius]>
adom: description: The parameter (adom) in requested url. required: true type: str profile: description: The parameter (profile) in requested url. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int webfilter_profile_override: description: The top level parameters set. required: false suboptions: ovrd-cookie: choices: - deny - allow description: Deprecated, please rename it to ovrd_cookie. Allow/deny browser-based type: str ovrd-dur: description: Deprecated, please rename it to ovrd_dur. Override duration. type: str ovrd-dur-mode: choices: - constant - ask description: Deprecated, please rename it to ovrd_dur_mode. Override duration mode. type: str ovrd-scope: choices: - user - user-group - ip - ask - browser description: Deprecated, please rename it to ovrd_scope. Override scope. type: str ovrd-user-group: description: (list or str) Deprecated, please rename it to ovrd_user_group. User groups with permission to use the override. type: raw profile: description: (list or str) Web filter profile with permission to create overrides. type: raw profile-attribute: choices: - User-Name - User-Password - CHAP-Password - NAS-IP-Address - NAS-Port - Service-Type - Framed-Protocol - Framed-IP-Address - Framed-IP-Netmask - Framed-Routing - Filter-Id - Framed-MTU - Framed-Compression - Login-IP-Host - Login-Service - Login-TCP-Port - Reply-Message - Callback-Number - Callback-Id - Framed-Route - Framed-IPX-Network - State - Class - Vendor-Specific - Session-Timeout - Idle-Timeout - Termination-Action - Called-Station-Id - Calling-Station-Id - NAS-Identifier - Proxy-State - Login-LAT-Service - Login-LAT-Node - Login-LAT-Group - Framed-AppleTalk-Link - Framed-AppleTalk-Network - Framed-AppleTalk-Zone - Acct-Status-Type - Acct-Delay-Time - Acct-Input-Octets - Acct-Output-Octets - Acct-Session-Id - Acct-Authentic - Acct-Session-Time - Acct-Input-Packets - Acct-Output-Packets - Acct-Terminate-Cause - Acct-Multi-Session-Id - Acct-Link-Count - CHAP-Challenge - NAS-Port-Type - Port-Limit - Login-LAT-Port description: Deprecated, please rename it to profile_attribute. Profile attribute to retrieve from the RADIUS server. type: str profile-type: choices: - list - radius description: Deprecated, please rename it to profile_type. Override profile type. type: str type: dict
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list