drmofu.fortimanager.fmgr_webfilter_profile_ftgdwf (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

 - 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: FortiGuard Web Filter settings.
      fmgr_webfilter_profile_ftgdwf:
         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_ftgdwf:
            exempt-quota: <value of string>
            filters:
              -
                  action: <value in [block, monitor, warning, ...]>
                  auth-usr-grp: <value of string>
                  category: <value of string>
                  id: <value of integer>
                  log: <value in [disable, enable]>
                  override-replacemsg: <value of string>
                  warn-duration: <value of string>
                  warning-duration-type: <value in [session, timeout]>
                  warning-prompt: <value in [per-domain, per-category]>
            max-quota-timeout: <value of integer>
            options:
              - error-allow
              - http-err-detail
              - rate-image-urls
              - strict-blocking
              - rate-server-ip
              - redir-block
              - connect-request-bypass
              - log-all-url
              - ftgd-disable
            ovrd: <value of string>
            quota:
              -
                  category: <value of string>
                  duration: <value of string>
                  id: <value of integer>
                  override-replacemsg: <value of string>
                  type: <value in [time, traffic]>
                  unit: <value in [B, KB, MB, ...]>
                  value: <value of integer>
            rate-crl-urls: <value in [disable, enable]>
            rate-css-urls: <value in [disable, enable]>
            rate-image-urls: <value in [disable, enable]>
            rate-javascript-urls: <value in [disable, enable]>
            category-override: <value of string>

Inputs

    
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
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    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.
    required: false
    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.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

webfilter_profile_ftgdwf:
    description: the top level parameters set
    required: false
    suboptions:
      category-override:
        description: Local categories take precedence over FortiGuard categories.
        type: str
      exempt-quota:
        description: Do not stop quota for these categories.
        type: str
      filters:
        description: description
        elements: dict
        suboptions:
          action:
            choices:
            - block
            - monitor
            - warning
            - authenticate
            description: Action to take for matches.
            type: str
          auth-usr-grp:
            description: Groups with permission to authenticate.
            type: str
          category:
            description: Categories and groups the filter examines.
            type: str
          id:
            description: ID number.
            type: int
          log:
            choices:
            - disable
            - enable
            description: Enable/disable logging.
            type: str
          override-replacemsg:
            description: Override replacement message.
            type: str
          warn-duration:
            description: Duration of warnings.
            type: str
          warning-duration-type:
            choices:
            - session
            - timeout
            description: Re-display warning after closing browser or after a timeout.
            type: str
          warning-prompt:
            choices:
            - per-domain
            - per-category
            description: Warning prompts in each category or each domain.
            type: str
        type: list
      max-quota-timeout:
        description: Maximum FortiGuard quota used by single page view in seconds
        type: int
      options:
        choices:
        - error-allow
        - http-err-detail
        - rate-image-urls
        - strict-blocking
        - rate-server-ip
        - redir-block
        - connect-request-bypass
        - log-all-url
        - ftgd-disable
        description: description
        elements: str
        type: list
      ovrd:
        description: Allow web filter profile overrides.
        type: str
      quota:
        description: description
        elements: dict
        suboptions:
          category:
            description: FortiGuard categories to apply quota to
            type: str
          duration:
            description: Duration of quota.
            type: str
          id:
            description: ID number.
            type: int
          override-replacemsg:
            description: Override replacement message.
            type: str
          type:
            choices:
            - time
            - traffic
            description: Quota type.
            type: str
          unit:
            choices:
            - B
            - KB
            - MB
            - GB
            description: Traffic quota unit of measurement.
            type: str
          value:
            description: Traffic quota value.
            type: int
        type: list
      rate-crl-urls:
        choices:
        - disable
        - enable
        description: Enable/disable rating CRL by URL.
        type: str
      rate-css-urls:
        choices:
        - disable
        - enable
        description: Enable/disable rating CSS by URL.
        type: str
      rate-image-urls:
        choices:
        - disable
        - enable
        description: Enable/disable rating images by URL.
        type: str
      rate-javascript-urls:
        choices:
        - disable
        - enable
        description: Enable/disable rating JavaScript by URL.
        type: str
    type: dict

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

Outputs

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