fortinet.fortios.fortios_firewall_ssh_setting – SSH proxy settings in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_ssh_setting
.
New in version 2.10: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_ssh feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | ||
enable_log boolean |
| Enable/Disable logging for task. | |
firewall_ssh_setting dictionary | SSH proxy settings. | ||
caname string | CA certificate used by SSH Inspection. Source firewall.ssh.local-ca.name. | ||
host_trusted_checking string |
| Enable/disable host trusted checking. | |
hostkey_dsa1024 string | DSA certificate used by SSH proxy. Source firewall.ssh.local-key.name. | ||
hostkey_ecdsa256 string | ECDSA nid256 certificate used by SSH proxy. Source firewall.ssh.local-key.name. | ||
hostkey_ecdsa384 string | ECDSA nid384 certificate used by SSH proxy. Source firewall.ssh.local-key.name. | ||
hostkey_ecdsa521 string | ECDSA nid384 certificate used by SSH proxy. Source firewall.ssh.local-key.name. | ||
hostkey_ed25519 string | ED25519 hostkey used by SSH proxy. Source firewall.ssh.local-key.name. | ||
hostkey_rsa2048 string | RSA certificate used by SSH proxy. Source firewall.ssh.local-key.name. | ||
untrusted_caname string | Untrusted CA certificate used by SSH Inspection. Source firewall.ssh.local-ca.name. | ||
vdom string | Default: "root" | 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. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: SSH proxy settings. fortios_firewall_ssh_setting: vdom: "{{ vdom }}" 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)"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_ssh_setting_module.html