fortinet.fortimanager.fmgr_webfilter_profile_antiphish module – AntiPhishing profile.

Note

This module is part of the fortinet.fortimanager collection (version 2.9.1).

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

New in fortinet.fortimanager 2.1.0

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

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

profile

string / required

The parameter (profile) in requested url.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

webfilter_profile_antiphish

dictionary

The top level parameters set.

authentication

string

Authentication methods.

Choices:

  • "domain-controller"

  • "ldap"

check_basic_auth

aliases: check-basic-auth

string

Enable/disable checking of HTTP Basic Auth field for known credentials.

Choices:

  • "disable"

  • "enable"

check_uri

aliases: check-uri

string

Enable/disable checking of GET URI parameters for known credentials.

Choices:

  • "disable"

  • "enable"

check_username_only

aliases: check-username-only

string

Enable/disable acting only on valid username credentials.

Choices:

  • "disable"

  • "enable"

custom_patterns

aliases: custom-patterns

list / elements=dictionary

Custom patterns.

category

string

Category that the pattern matches.

Choices:

  • "username"

  • "password"

pattern

string

Target pattern.

type

string

Pattern will be treated either as a regex pattern or literal string.

Choices:

  • "regex"

  • "literal"

default_action

aliases: default-action

string

Action to be taken when there is no matching rule.

Choices:

  • "log"

  • "block"

  • "exempt"

domain_controller

aliases: domain-controller

string

Domain for which to verify received credentials against.

inspection_entries

aliases: inspection-entries

list / elements=dictionary

Inspection entries.

action

string

Action to be taken upon an AntiPhishing match.

Choices:

  • "log"

  • "block"

  • "exempt"

fortiguard_category

aliases: fortiguard-category

any

(list) FortiGuard category to match.

name

string

Inspection target name.

ldap

string

LDAP server for which to verify received credentials against.

max_body_len

aliases: max-body-len

integer

Maximum size of a POST body to check for credentials.

status

string

Toggle AntiPhishing functionality.

Choices:

  • "disable"

  • "enable"

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

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

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

  • 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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: AntiPhishing profile.
      fortinet.fortimanager.fmgr_webfilter_profile_antiphish:
        # 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_antiphish:
          # check_basic_auth: <value in [disable, enable]>
          # check_uri: <value in [disable, enable]>
          # custom_patterns:
          #   - category: <value in [username, password]>
          #     pattern: <string>
          #     type: <value in [regex, literal]>
          # default_action: <value in [log, block, exempt]>
          # domain_controller: <string>
          # inspection_entries:
          #   - action: <value in [log, block, exempt]>
          #     fortiguard_category: <list or string>
          #     name: <string>
          # max_body_len: <integer>
          # status: <value in [disable, enable]>
          # check_username_only: <value in [disable, enable]>
          # authentication: <value in [domain-controller, ldap]>
          # ldap: <string>

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)