Steampunk Ansible Documentation - drmofu.fortimanager.fmgr_icap_profile (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

 - 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: Configure ICAP profiles.
      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: <value in [present, absent]>
         icap_profile:
            methods:
              - delete
              - get
              - head
              - options
              - post
              - put
              - trace
              - other
              - connect
            name: <value of string>
            replacemsg-group: <value of string>
            request: <value in [disable, enable]>
            request-failure: <value in [error, bypass]>
            request-path: <value of string>
            request-server: <value of string>
            response: <value in [disable, enable]>
            response-failure: <value in [error, bypass]>
            response-path: <value of string>
            response-server: <value of string>
            streaming-content-bypass: <value in [disable, enable]>
            icap-headers:
              -
                  base64-encoding: <value in [disable, enable]>
                  content: <value of string>
                  id: <value of integer>
                  name: <value of string>
            preview: <value in [disable, enable]>
            preview-data-length: <value of 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: <value of string>
                        header-name: <value of string>
                        id: <value of integer>
                  host: <value of string>
                  http-resp-status-code: <value of integer>
                  name: <value of string>
            204-response: <value in [disable, enable]>
            204-size-limit: <value of 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: <value of string>
            file-transfer-server: <value of string>
            icap-block-log: <value in [disable, enable]>
            scan-progress-interval: <value of integer>
            timeout: <value of integer>
            comment: <value of 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
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

icap_profile:
description: the top level parameters set
required: false
suboptions:
204-response:
choices:
- disable
- enable
description: Enable/disable allowance of 204 response from ICAP server.
type: str
204-size-limit:
description: 204 response size limit to be saved by ICAP client in megabytes
type: int
chunk-encap:
choices:
- disable
- enable
description: Enable/disable chunked encapsulation
type: str
comment:
description: Comment.
type: str
extension-feature:
choices:
- scan-progress
description: description
elements: str
type: list
file-transfer:
choices:
- ssh
- ftp
description: description
elements: str
type: list
file-transfer-failure:
choices:
- error
- bypass
description: Action to take if the ICAP server cannot be contacted when processing
a file transfer.
type: str
file-transfer-path:
description: Path component of the ICAP URI that identifies the file transfer
processing service.
type: str
file-transfer-server:
description: ICAP server to use for a file transfer.
type: str
icap-block-log:
choices:
- disable
- enable
description: Enable/disable UTM log when infection found
type: str
icap-headers:
description: Icap-Headers.
elements: dict
suboptions:
base64-encoding:
choices:
- disable
- enable
description: 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.
type: str
preview:
choices:
- disable
- enable
description: Enable/disable preview of data to ICAP server.
type: str
preview-data-length:
description: Preview data length to be sent to ICAP server.
type: int
replacemsg-group:
description: 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: Action to take if the ICAP server cannot be contacted when processing
an HTTP request.
type: str
request-path:
description: Path component of the ICAP URI that identifies the HTTP request processing
service.
type: str
request-server:
description: ICAP server to use for an HTTP request.
type: str
respmod-default-action:
choices:
- bypass
- forward
description: Default action to ICAP response modification
type: str
respmod-forward-rules:
description: Respmod-Forward-Rules.
elements: dict
suboptions:
action:
choices:
- bypass
- forward
description: Action to be taken for ICAP server.
type: str
header-group:
description: Header-Group.
elements: dict
suboptions:
case-sensitivity:
choices:
- disable
- enable
description: Enable/disable case sensitivity when matching header.
type: str
header:
description: HTTP header regular expression.
type: str
header-name:
description: 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: HTTP response status code.
type: int
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: Action to take if the ICAP server cannot be contacted when processing
an HTTP response.
type: str
response-path:
description: Path component of the ICAP URI that identifies the HTTP response
processing service.
type: str
response-req-hdr:
choices:
- disable
- enable
description: Enable/disable addition of req-hdr for ICAP response modification
type: str
response-server:
description: ICAP server to use for an HTTP response.
type: str
scan-progress-interval:
description: Scan progress interval value.
type: int
streaming-content-bypass:
choices:
- disable
- enable
description: 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
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

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