fortinet.fortimanager.fmgr_icap_profile (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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.

- 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: Configure ICAP profiles.
      fortinet.fortimanager.fmgr_icap_profile:
        # 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>
        state: present # <value in [present, absent]>
        icap_profile:
          methods:
            - delete
            - get
            - head
            - options
            - post
            - put
            - trace
            - other
            - connect
          name: <string>
          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>
          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>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    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

icap_profile:
    description: The top level parameters set.
    required: false
    suboptions:
      204-response:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to 204_response. Enable/disable allowance
          of 204 response from ICAP server.
        type: str
      204-size-limit:
        description: Deprecated, please rename it to 204_size_limit. 204 response size
          limit to be saved by ICAP client in megabytes
        type: int
      chunk-encap:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to chunk_encap. Enable/disable chunked
          encapsulation
        type: str
      comment:
        description: Comment.
        type: str
      extension-feature:
        choices:
        - scan-progress
        description: Deprecated, please rename it to extension_feature.
        elements: str
        type: list
      file-transfer:
        choices:
        - ssh
        - ftp
        description: Deprecated, please rename it to file_transfer.
        elements: str
        type: list
      file-transfer-failure:
        choices:
        - error
        - bypass
        description: Deprecated, please rename it to file_transfer_failure. Action to
          take if the ICAP server cannot be contacted when processi...
        type: str
      file-transfer-path:
        description: Deprecated, please rename it to file_transfer_path. Path component
          of the ICAP URI that identifies the file transfer proce...
        type: str
      file-transfer-server:
        description: Deprecated, please rename it to file_transfer_server. ICAP server
          to use for a file transfer.
        type: str
      icap-block-log:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to icap_block_log. Enable/disable UTM
          log when infection found
        type: str
      icap-headers:
        description: Deprecated, please rename it to icap_headers. Icap-Headers.
        elements: dict
        suboptions:
          base64-encoding:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to base64_encoding. Enable/disable
              use of base64 encoding of HTTP content.
            type: str
          content:
            description: HTTP header content.
            type: str
          id:
            description: HTTP forwarded header ID.
            type: int
          name:
            description: HTTP forwarded header name.
            type: str
        type: list
      methods:
        choices:
        - delete
        - get
        - head
        - options
        - post
        - put
        - trace
        - other
        - connect
        description: The allowed HTTP methods that will be sent to ICAP server for further
          processing.
        elements: str
        type: list
      name:
        description: ICAP profile name.
        required: true
        type: str
      preview:
        choices:
        - disable
        - enable
        description: Enable/disable preview of data to ICAP server.
        type: str
      preview-data-length:
        description: Deprecated, please rename it to preview_data_length. Preview data
          length to be sent to ICAP server.
        type: int
      replacemsg-group:
        description: Deprecated, please rename it to replacemsg_group. Replacement message
          group.
        type: str
      request:
        choices:
        - disable
        - enable
        description: Enable/disable whether an HTTP request is passed to an ICAP server.
        type: str
      request-failure:
        choices:
        - error
        - bypass
        description: Deprecated, please rename it to request_failure. Action to take if
          the ICAP server cannot be contacted when processing an ...
        type: str
      request-path:
        description: Deprecated, please rename it to request_path. Path component of the
          ICAP URI that identifies the HTTP request processing s...
        type: str
      request-server:
        description: Deprecated, please rename it to request_server. ICAP server to use
          for an HTTP request.
        type: str
      respmod-default-action:
        choices:
        - bypass
        - forward
        description: Deprecated, please rename it to respmod_default_action. Default action
          to ICAP response modification
        type: str
      respmod-forward-rules:
        description: Deprecated, please rename it to respmod_forward_rules. Respmod-Forward-Rules.
        elements: dict
        suboptions:
          action:
            choices:
            - bypass
            - forward
            description: Action to be taken for ICAP server.
            type: str
          header-group:
            description: Deprecated, please rename it to header_group. Header-Group.
            elements: dict
            suboptions:
              case-sensitivity:
                choices:
                - disable
                - enable
                description: Deprecated, please rename it to case_sensitivity. Enable/disable
                  case sensitivity when matching header.
                type: str
              header:
                description: HTTP header regular expression.
                type: str
              header-name:
                description: Deprecated, please rename it to header_name. HTTP header.
                type: str
              id:
                description: ID.
                type: int
            type: list
          host:
            description: Address object for the host.
            type: str
          http-resp-status-code:
            description: (list) Deprecated, please rename it to http_resp_status_code.
              HTTP response status code.
            type: raw
          name:
            description: Address name.
            type: str
        type: list
      response:
        choices:
        - disable
        - enable
        description: Enable/disable whether an HTTP response is passed to an ICAP server.
        type: str
      response-failure:
        choices:
        - error
        - bypass
        description: Deprecated, please rename it to response_failure. Action to take
          if the ICAP server cannot be contacted when processing an...
        type: str
      response-path:
        description: Deprecated, please rename it to response_path. Path component of
          the ICAP URI that identifies the HTTP response processing...
        type: str
      response-req-hdr:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to response_req_hdr. Enable/disable
          addition of req-hdr for ICAP response modification
        type: str
      response-server:
        description: Deprecated, please rename it to response_server. ICAP server to use
          for an HTTP response.
        type: str
      scan-progress-interval:
        description: Deprecated, please rename it to scan_progress_interval. Scan progress
          interval value.
        type: int
      streaming-content-bypass:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to streaming_content_bypass. Enable/disable
          bypassing of ICAP server for streaming content.
        type: str
      timeout:
        description: Time
        type: int
    type: dict

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

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