ansible.builtin.fortios_firewall_ssl_setting (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 firewall_ssl feature and setting 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: SSL proxy settings.
    fortios_firewall_ssl_setting:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      firewall_ssl_setting:
        abbreviate-handshake: "enable"
        cert-cache-capacity: "4"
        cert-cache-timeout: "5"
        kxp-queue-threshold: "6"
        no-matching-cipher-action: "bypass"
        proxy-connect-timeout: "8"
        session-cache-capacity: "9"
        session-cache-timeout: "10"
        ssl-dh-bits: "768"
        ssl-queue-threshold: "12"
        ssl-send-empty-frags: "enable"

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

firewall_ssl_setting:
    default: null
    description:
    - SSL proxy settings.
    suboptions:
      abbreviate-handshake:
        choices:
        - enable
        - disable
        description:
        - Enable/disable use of SSL abbreviated handshake.
      cert-cache-capacity:
        description:
        - Maximum capacity of the host certificate cache (0 - 500, default = 200).
      cert-cache-timeout:
        description:
        - Time limit to keep certificate cache (1 - 120 min, default = 10).
      kxp-queue-threshold:
        description:
        - Maximum length of the CP KXP queue. When the queue becomes full, the proxy switches
          cipher functions to the main CPU (0 - 512, default = 16).
      no-matching-cipher-action:
        choices:
        - bypass
        - drop
        description:
        - Bypass or drop the connection when no matching cipher is found.
      proxy-connect-timeout:
        description:
        - Time limit to make an internal connection to the appropriate proxy process (1
          - 60 sec, default = 30).
      session-cache-capacity:
        description:
        - Capacity of the SSL session cache (--Obsolete--) (1 - 1000, default = 500).
      session-cache-timeout:
        description:
        - Time limit to keep SSL session state (1 - 60 min, default = 20).
      ssl-dh-bits:
        choices:
        - 768
        - 1024
        - 1536
        - 2048
        description:
        - Bit-size of Diffie-Hellman (DH) prime used in DHE-RSA negotiation (default =
          2048).
      ssl-queue-threshold:
        description:
        - Maximum length of the CP SSL queue. When the queue becomes full, the proxy switches
          cipher functions to the main CPU (0 - 512, default = 32).
      ssl-send-empty-frags:
        choices:
        - enable
        - disable
        description:
        - Enable/disable sending empty fragments to avoid attack on CBC IV (for SSL 3.0
          and TLS 1.0 only).

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