fortinet.fortimanager.fmgr_icap_profile module – Configure ICAP profiles.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_icap_profile.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • 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.

Parameters

Parameter

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

icap_profile

dictionary

the top level parameters set

icap-headers

list / elements=string

Icap-Headers.

base64-encoding

string

Enable/disable use of base64 encoding of HTTP content.

Choices:

  • disable

  • enable

content

string

HTTP header content.

id

integer

HTTP forwarded header ID.

name

string

HTTP forwarded header name.

methods

list / elements=string

The allowed HTTP methods that will be sent to ICAP server for further processing.

Choices:

  • delete

  • get

  • head

  • options

  • post

  • put

  • trace

  • other

name

string

ICAP profile name.

preview

string

Enable/disable preview of data to ICAP server.

Choices:

  • disable

  • enable

preview-data-length

integer

Preview data length to be sent to ICAP server.

replacemsg-group

string

Replacement message group.

request

string

Enable/disable whether an HTTP request is passed to an ICAP server.

Choices:

  • disable

  • enable

request-failure

string

Action to take if the ICAP server cannot be contacted when processing an HTTP request.

Choices:

  • error

  • bypass

request-path

string

Path component of the ICAP URI that identifies the HTTP request processing service.

request-server

string

ICAP server to use for an HTTP request.

respmod-default-action

string

Default action to ICAP response modification (respmod) processing.

Choices:

  • bypass

  • forward

respmod-forward-rules

list / elements=string

Respmod-Forward-Rules.

action

string

Action to be taken for ICAP server.

Choices:

  • bypass

  • forward

header-group

list / elements=string

Header-Group.

case-sensitivity

string

Enable/disable case sensitivity when matching header.

Choices:

  • disable

  • enable

header

string

HTTP header regular expression.

header-name

string

HTTP header.

id

integer

ID.

host

string

Address object for the host.

http-resp-status-code

integer

HTTP response status code.

name

string

Address name.

response

string

Enable/disable whether an HTTP response is passed to an ICAP server.

Choices:

  • disable

  • enable

response-failure

string

Action to take if the ICAP server cannot be contacted when processing an HTTP response.

Choices:

  • error

  • bypass

response-path

string

Path component of the ICAP URI that identifies the HTTP response processing service.

response-req-hdr

string

Enable/disable addition of req-hdr for ICAP response modification (respmod) processing.

Choices:

  • disable

  • enable

response-server

string

ICAP server to use for an HTTP response.

streaming-content-bypass

string

Enable/disable bypassing of ICAP server for streaming content.

Choices:

  • disable

  • enable

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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

- 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
           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>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)