Skip to content

Latest commit

 

History

History
292 lines (248 loc) · 12.9 KB

fortios_firewall_ssh_setting.rst

File metadata and controls

292 lines (248 loc) · 12.9 KB
Raw
source:fortios_firewall_ssh_setting.py
orphan:

fortios_firewall_ssh_setting -- SSH proxy settings in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_firewall_ssh_setting v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • firewall_ssh_setting - SSH proxy settings. type: dict more...
    Supported Version Ranges
    firewall_ssh_setting v6.0.0 -> latest
    • caname - CA certificate used by SSH Inspection. Source firewall.ssh.local-ca.name. type: str more...
      Supported Version Ranges
      caname v6.0.0 -> latest
    • host_trusted_checking - Enable/disable host trusted checking. type: str choices: enable, disable more...
      Supported Version Ranges
      host_trusted_checking v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • hostkey_dsa1024 - DSA certificate used by SSH proxy. Source firewall.ssh.local-key.name. type: str more...
      Supported Version Ranges
      hostkey_dsa1024 v6.0.0 -> latest
    • hostkey_ecdsa256 - ECDSA nid256 certificate used by SSH proxy. Source firewall.ssh.local-key.name. type: str more...
      Supported Version Ranges
      hostkey_ecdsa256 v6.0.0 -> latest
    • hostkey_ecdsa384 - ECDSA nid384 certificate used by SSH proxy. Source firewall.ssh.local-key.name. type: str more...
      Supported Version Ranges
      hostkey_ecdsa384 v6.0.0 -> latest
    • hostkey_ecdsa521 - ECDSA nid384 certificate used by SSH proxy. Source firewall.ssh.local-key.name. type: str more...
      Supported Version Ranges
      hostkey_ecdsa521 v6.0.0 -> latest
    • hostkey_ed25519 - ED25519 hostkey used by SSH proxy. Source firewall.ssh.local-key.name. type: str more...
      Supported Version Ranges
      hostkey_ed25519 v6.0.0 -> latest
    • hostkey_rsa2048 - RSA certificate used by SSH proxy. Source firewall.ssh.local-key.name. type: str more...
      Supported Version Ranges
      hostkey_rsa2048 v6.0.0 -> latest
    • untrusted_caname - Untrusted CA certificate used by SSH Inspection. Source firewall.ssh.local-ca.name. type: str more...
      Supported Version Ranges
      untrusted_caname v6.0.0 -> latest

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: SSH proxy settings.
  fortinet.fortios.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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.