fmgd_casb_useractivity – Configure CASB user activity.

Added in version 1.1.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.4.8 -> v7.4.10, v7.6.4 -> 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
  • 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
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • casb_useractivity - Configure CASB user activity. type: dict
    • application Casb saas application name. type: list more...
    • casb_name (Alias name: casb-name) Casb user activity signature name. type: str more...
    • category Casb user activity category. type: str choices: [activity-control, tenant-control, domain-control, safe-search-control, other, advanced-tenant-control] more...
    • control_options (Alias name: control-options) Control options. type: list more...
      • name Casb control option name. type: str more...
      • operations Operations. type: list more...
        • action Casb operation action. type: str choices: [append, prepend, replace, new, new-on-not-found, delete] more...
        • case_sensitive (Alias name: case-sensitive) Casb operation search case sensitive. type: str choices: [disable, enable] more...
        • direction Casb operation direction. type: str choices: [request, response] more...
        • header_name (Alias name: header-name) Casb operation header name to search. type: str more...
        • name Casb control option operation name. type: str more...
        • search_key (Alias name: search-key) Casb operation key to search. type: str more...
        • search_pattern (Alias name: search-pattern) Casb operation search pattern. type: str choices: [simple, substr, regexp] more...
        • target Casb operation target. type: str choices: [header, path, body] more...
        • value_from_input (Alias name: value-from-input) Enable/disable value from user input. type: str choices: [disable, enable] more...
        • values Casb operation new values. type: list more...
        • value_name_from_input (Alias name: value-name-from-input) Casb operation value name from user input. type: str more...
      • status Casb control option status. type: str choices: [disable, enable] more...
    • description Casb user activity description. type: str more...
    • match Match. type: list more...
      • id Casb user activity match rules id. type: int more...
      • rules Rules. type: list more...
        • case_sensitive (Alias name: case-sensitive) Casb user activity match case sensitive. type: str choices: [disable, enable] more...
        • domains Casb user activity domain list. type: list more...
        • header_name (Alias name: header-name) Casb user activity rule header name. type: str more...
        • id Casb user activity rule id. type: int more...
        • match_pattern (Alias name: match-pattern) Casb user activity rule match pattern. type: str choices: [simple, substr, regexp] more...
        • match_value (Alias name: match-value) Casb user activity rule match value. type: str more...
        • methods Casb user activity method list. type: list more...
        • negate Enable/disable what the matching strategy must not be. type: str choices: [disable, enable] more...
        • type Casb user activity rule type. type: str choices: [domains, host, path, header, header-value, method, body] more...
        • jq Casb user activity rule match jq script. type: str more...
        • body_type (Alias name: body-type) Casb user activity match rule body type. type: str choices: [json] more...
      • strategy Casb user activity rules strategy. type: str choices: [or, and] more...
      • tenant_extraction (Alias name: tenant-extraction) Tenant extraction. type: dict more...
        • filters Filters. type: list more...
          • body_type (Alias name: body-type) Casb tenant extraction filter body type. type: str choices: [json] more...
          • direction Casb tenant extraction filter direction. type: str choices: [request, response] more...
          • header_name (Alias name: header-name) Casb tenant extraction filter header name. type: str more...
          • id Casb tenant extraction filter id. type: int more...
          • place Casb tenant extraction filter place type. type: str choices: [path, header, body] more...
        • jq Casb user activity tenant extraction jq script. type: str more...
        • status Enable/disable casb tenant extraction. type: str choices: [disable, enable] more...
        • type Casb user activity tenant extraction type. type: str choices: [json-query] more...
    • match_strategy (Alias name: match-strategy) Casb user activity match strategy. type: str choices: [or, and] more...
    • name Casb user activity name. type: str more...
    • status Casb user activity status. type: str choices: [disable, enable] more...
    • type Casb user activity type. type: str choices: [built-in, customized] more...
    • uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str 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 CASB user activity.
      fortinet.fmgdevice.fmgd_casb_useractivity:
        # 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>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        casb_useractivity:
          name: "your value" # Required variable, string
          # application: <list or string>
          # casb_name: <string>
          # category: <value in [activity-control, tenant-control, domain-control, ...]>
          # control_options:
          #   - name: <string>
          #     operations:
          #       - action: <value in [append, prepend, replace, ...]>
          #         case_sensitive: <value in [disable, enable]>
          #         direction: <value in [request, response]>
          #         header_name: <string>
          #         name: <string>
          #         search_key: <string>
          #         search_pattern: <value in [simple, substr, regexp]>
          #         target: <value in [header, path, body]>
          #         value_from_input: <value in [disable, enable]>
          #         values: <list or string>
          #         value_name_from_input: <string>
          #     status: <value in [disable, enable]>
          # description: <string>
          # match:
          #   - id: <integer>
          #     rules:
          #       - case_sensitive: <value in [disable, enable]>
          #         domains: <list or string>
          #         header_name: <string>
          #         id: <integer>
          #         match_pattern: <value in [simple, substr, regexp]>
          #         match_value: <string>
          #         methods: <list or string>
          #         negate: <value in [disable, enable]>
          #         type: <value in [domains, host, path, ...]>
          #         jq: <string>
          #         body_type: <value in [json]>
          #     strategy: <value in [or, and]>
          #     tenant_extraction:
          #       filters:
          #         - body_type: <value in [json]>
          #           direction: <value in [request, response]>
          #           header_name: <string>
          #           id: <integer>
          #           place: <value in [path, header, body]>
          #       jq: <string>
          #       status: <value in [disable, enable]>
          #       type: <value in [json-query]>
          # match_strategy: <value in [or, and]>
          # status: <value in [disable, enable]>
          # type: <value in [built-in, customized]>
          # uuid: <string>

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.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)