ansible.builtin.fortios_icap_profile (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure icap feature and profile category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure ICAP profiles.
    fortios_icap_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      icap_profile:
        state: "present"
        methods: "delete"
        name: "default_name_4"
        replacemsg-group: "<your_own_value> (source system.replacemsg-group.name)"
        request: "disable"
        request-failure: "error"
        request-path: "<your_own_value>"
        request-server: "<your_own_value> (source icap.server.name)"
        response: "disable"
        response-failure: "error"
        response-path: "<your_own_value>"
        response-server: "<your_own_value> (source icap.server.name)"
        streaming-content-bypass: "disable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip adress.
    required: true

vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

icap_profile:
    default: null
    description:
    - Configure ICAP profiles.
    suboptions:
      methods:
        choices:
        - delete
        - get
        - head
        - options
        - post
        - put
        - trace
        - other
        description:
        - The allowed HTTP methods that will be sent to ICAP server for further processing.
      name:
        description:
        - ICAP profile name.
        required: true
      replacemsg-group:
        description:
        - Replacement message group. Source system.replacemsg-group.name.
      request:
        choices:
        - disable
        - enable
        description:
        - Enable/disable whether an HTTP request is passed to an ICAP server.
      request-failure:
        choices:
        - error
        - bypass
        description:
        - Action to take if the ICAP server cannot be contacted when processing an HTTP
          request.
      request-path:
        description:
        - Path component of the ICAP URI that identifies the HTTP request processing service.
      request-server:
        description:
        - ICAP server to use for an HTTP request. Source icap.server.name.
      response:
        choices:
        - disable
        - enable
        description:
        - Enable/disable whether an HTTP response is passed to an ICAP server.
      response-failure:
        choices:
        - error
        - bypass
        description:
        - Action to take if the ICAP server cannot be contacted when processing an HTTP
          response.
      response-path:
        description:
        - Path component of the ICAP URI that identifies the HTTP response processing
          service.
      response-server:
        description:
        - ICAP server to use for an HTTP response. Source icap.server.name.
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      streaming-content-bypass:
        choices:
        - disable
        - enable
        description:
        - Enable/disable bypassing of ICAP server for streaming content.

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str