ansible.builtin.fortios_firewall_ssh_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_ssh 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: SSH proxy settings.
    fortios_firewall_ssh_setting:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      firewall_ssh_setting:
        caname: "<your_own_value> (source firewall.ssh.local-ca.name)"
        host-trusted-checking: "enable"
        hostkey-dsa1024: "myhostname (source firewall.ssh.local-key.name)"
        hostkey-ecdsa256: "myhostname (source firewall.ssh.local-key.name)"
        hostkey-ecdsa384: "myhostname (source firewall.ssh.local-key.name)"
        hostkey-ecdsa521: "myhostname (source firewall.ssh.local-key.name)"
        hostkey-ed25519: "myhostname (source firewall.ssh.local-key.name)"
        hostkey-rsa2048: "myhostname (source firewall.ssh.local-key.name)"
        untrusted-caname: "<your_own_value> (source firewall.ssh.local-ca.name)"

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_ssh_setting:
    default: null
    description:
    - SSH proxy settings.
    suboptions:
      caname:
        description:
        - CA certificate used by SSH Inspection. Source firewall.ssh.local-ca.name.
      host-trusted-checking:
        choices:
        - enable
        - disable
        description:
        - Enable/disable host trusted checking.
      hostkey-dsa1024:
        description:
        - DSA certificate used by SSH proxy. Source firewall.ssh.local-key.name.
      hostkey-ecdsa256:
        description:
        - ECDSA nid256 certificate used by SSH proxy. Source firewall.ssh.local-key.name.
      hostkey-ecdsa384:
        description:
        - ECDSA nid384 certificate used by SSH proxy. Source firewall.ssh.local-key.name.
      hostkey-ecdsa521:
        description:
        - ECDSA nid384 certificate used by SSH proxy. Source firewall.ssh.local-key.name.
      hostkey-ed25519:
        description:
        - ED25519 hostkey used by SSH proxy. Source firewall.ssh.local-key.name.
      hostkey-rsa2048:
        description:
        - RSA certificate used by SSH proxy. Source firewall.ssh.local-key.name.
      untrusted-caname:
        description:
        - Untrusted CA certificate used by SSH Inspection. Source firewall.ssh.local-ca.name.

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