fmgd_icap_profile – Configure ICAP profiles.

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: v6.0.0 -> 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
  • icap_profile - Configure ICAP profiles. type: dict
    • methods The allowed http methods that will be sent to icap server for further processing. type: list choices: [delete, get, head, options, post, put, trace, other, connect] more...
    • name Icap profile name. type: str more...
    • replacemsg_group (Alias name: replacemsg-group) Replacement message group. type: str more...
    • request Enable/disable whether an http request is passed to an icap server. type: str choices: [disable, enable] more...
    • request_failure (Alias name: request-failure) Action to take if the icap server cannot be contacted when processing an http request. type: str choices: [error, bypass] more...
    • request_path (Alias name: request-path) Path component of the icap uri that identifies the http request processing service. type: str more...
    • request_server (Alias name: request-server) Icap server to use for an http request. type: str more...
    • response Enable/disable whether an http response is passed to an icap server. type: str choices: [disable, enable] more...
    • response_failure (Alias name: response-failure) Action to take if the icap server cannot be contacted when processing an http response. type: str choices: [error, bypass] more...
    • response_path (Alias name: response-path) Path component of the icap uri that identifies the http response processing service. type: str more...
    • response_server (Alias name: response-server) Icap server to use for an http response. type: str more...
    • streaming_content_bypass (Alias name: streaming-content-bypass) Enable/disable bypassing of icap server for streaming content. type: str choices: [disable, enable] more...
    • icap_headers (Alias name: icap-headers) Icap headers. type: list more...
      • base64_encoding (Alias name: base64-encoding) Enable/disable use of base64 encoding of http content. type: str choices: [disable, enable] more...
      • content Http header content. type: str more...
      • id Http forwarded header id. type: int more...
      • name Http forwarded header name. type: str more...
      • http_header (Alias name: http-header) Http header. type: str more...
      • sesson_info_type (Alias name: sesson-info-type) Sesson info type. type: str choices: [client-ip, user, upn, domain, local-grp, remote-grp, proxy-name, auth-user-uri, auth-group-uri] more...
      • source Source. type: str choices: [content, http-header, session] more...
    • preview Enable/disable preview of data to icap server. type: str choices: [disable, enable] more...
    • preview_data_length (Alias name: preview-data-length) Preview data length to be sent to icap server. type: int more...
    • response_req_hdr (Alias name: response-req-hdr) Enable/disable addition of req-hdr for icap response modification (respmod) processing. type: str choices: [disable, enable] more...
    • respmod_default_action (Alias name: respmod-default-action) Default action to icap response modification (respmod) processing. type: str choices: [bypass, forward] more...
    • respmod_forward_rules (Alias name: respmod-forward-rules) Respmod forward rules. type: list more...
      • action Action to be taken for icap server. type: str choices: [bypass, forward] more...
      • header_group (Alias name: header-group) Header group. type: list more...
        • case_sensitivity (Alias name: case-sensitivity) Enable/disable case sensitivity when matching header. type: str choices: [disable, enable] more...
        • header Http header regular expression. type: str more...
        • header_name (Alias name: header-name) Http header. type: str more...
        • id Id. type: int more...
      • host Address object for the host. type: str more...
      • http_resp_status_code (Alias name: http-resp-status-code) Http response status code. type: list more...
      • name Address name. type: str more...
    • 204_response (Alias name: 204-response) Enable/disable allowance of 204 response from icap server. type: str choices: [disable, enable] more...
    • 204_size_limit (Alias name: 204-size-limit) 204 response size limit to be saved by icap client in megabytes (1 - 10, default = 1 mb). type: int more...
    • chunk_encap (Alias name: chunk-encap) Enable/disable chunked encapsulation (default = disable). type: str choices: [disable, enable] more...
    • extension_feature (Alias name: extension-feature) Enable/disable icap extension features. type: list choices: [scan-progress] more...
    • file_transfer (Alias name: file-transfer) Configure the file transfer protocols to pass transferred files to an icap server as reqmod. type: list choices: [ssh, ftp] more...
    • file_transfer_failure (Alias name: file-transfer-failure) Action to take if the icap server cannot be contacted when processing a file transfer. type: str choices: [error, bypass] more...
    • file_transfer_path (Alias name: file-transfer-path) Path component of the icap uri that identifies the file transfer processing service. type: str more...
    • file_transfer_server (Alias name: file-transfer-server) Icap server to use for a file transfer. type: str more...
    • icap_block_log (Alias name: icap-block-log) Enable/disable utm log when infection found (default = disable). type: str choices: [disable, enable] more...
    • scan_progress_interval (Alias name: scan-progress-interval) Scan progress interval value. type: int more...
    • timeout Time (in seconds) that icap client waits for the response from icap server. type: int more...
    • comment Comment. type: str more...
    • ocr_only (Alias name: ocr-only) Enable/disable this fortigate unit to submit only ocr interested content to the icap server. type: str choices: [disable, enable] more...
    • ocr_only Ocr only. type: str choices: [disable, enable] more...
    • scan_oversize_log (Alias name: scan-oversize-log) Scan oversize log. type: str choices: [disable, enable] more...
    • scan_size_limit (Alias name: scan-size-limit) Scan size limit. type: int more...
    • allow_204_response (Alias name: allow-204-response) Enable/disable allowing of 204 response from icap server. type: str choices: [disable, enable] 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 ICAP profiles.
      fortinet.fmgdevice.fmgd_icap_profile:
        # 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]>
        icap_profile:
          name: "your value" # Required variable, string
          # methods:
          #   - "delete"
          #   - "get"
          #   - "head"
          #   - "options"
          #   - "post"
          #   - "put"
          #   - "trace"
          #   - "other"
          #   - "connect"
          # replacemsg_group: <string>
          # request: <value in [disable, enable]>
          # request_failure: <value in [error, bypass]>
          # request_path: <string>
          # request_server: <string>
          # response: <value in [disable, enable]>
          # response_failure: <value in [error, bypass]>
          # response_path: <string>
          # response_server: <string>
          # streaming_content_bypass: <value in [disable, enable]>
          # icap_headers:
          #   - base64_encoding: <value in [disable, enable]>
          #     content: <string>
          #     id: <integer>
          #     name: <string>
          #     http_header: <string>
          #     sesson_info_type: <value in [client-ip, user, upn, ...]>
          #     source: <value in [content, http-header, session]>
          # preview: <value in [disable, enable]>
          # preview_data_length: <integer>
          # response_req_hdr: <value in [disable, enable]>
          # respmod_default_action: <value in [bypass, forward]>
          # respmod_forward_rules:
          #   - action: <value in [bypass, forward]>
          #     header_group:
          #       - case_sensitivity: <value in [disable, enable]>
          #         header: <string>
          #         header_name: <string>
          #         id: <integer>
          #     host: <string>
          #     http_resp_status_code: <list or integer>
          #     name: <string>
          # 204_response: <value in [disable, enable]>
          # 204_size_limit: <integer>
          # chunk_encap: <value in [disable, enable]>
          # extension_feature:
          #   - "scan-progress"
          # file_transfer:
          #   - "ssh"
          #   - "ftp"
          # file_transfer_failure: <value in [error, bypass]>
          # file_transfer_path: <string>
          # file_transfer_server: <string>
          # icap_block_log: <value in [disable, enable]>
          # scan_progress_interval: <integer>
          # timeout: <integer>
          # comment: <string>
          # ocr_only: <value in [disable, enable]>
          # ocr_only: <value in [disable, enable]>
          # scan_oversize_log: <value in [disable, enable]>
          # scan_size_limit: <integer>
          # allow_204_response: <value in [disable, enable]>

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)