fortinet.fortios.fortios_ssh_filter_profile – SSH filter profile 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_ssh_filter_profile.

New in version 2.10: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ssh_filter feature and profile 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					Choices: no ← yes	Enable/Disable logging for task.
ssh_filter_profile dictionary						SSH filter profile.
	block list / elements=string				Choices: x11 shell exec port-forward tun-forward sftp unknown scp	SSH blocking options.
	default_command_log string				Choices: enable disable	Enable/disable logging unmatched shell commands.
	file_filter dictionary					File filter.
		entries list / elements=string				File filter entries.
			action string		Choices: log block	Action taken for matched file.
			comment string			Comment.
			direction string		Choices: incoming outgoing any	Match files transmitted in the session"s originating or reply direction.
			file_type list / elements=string			Select file type.
				name string / required		File type name. Source antivirus.filetype.name.
			filter string / required			Add a file filter.
			password_protected string		Choices: True any	Match password-protected files.
			protocol string		Choices: ssh	Protocols to apply with.
		log string			Choices: enable disable	Enable/disable file filter logging.
		scan_archive_contents string			Choices: enable disable	Enable/disable file filter archive contents scan.
		status string			Choices: enable disable	Enable/disable file filter.
	log list / elements=string				Choices: x11 shell exec port-forward tun-forward sftp unknown scp	SSH logging options.
	name string / required					SSH filter profile name.
	shell_commands list / elements=string					SSH command filter.
		action string			Choices: block allow	Action to take for URL filter matches.
		alert string			Choices: enable disable	Enable/disable alert.
		id integer / required				Id.
		log string			Choices: enable disable	Enable/disable logging.
		pattern string				SSH shell command pattern.
		severity string			Choices: low medium high critical	Log severity.
		type string			Choices: simple regex	Matching type.
state string / required					Choices: present absent	Indicates whether to create or remove the object.
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 filter profile.
    fortios_ssh_filter_profile:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      ssh_filter_profile:
        block: "x11"
        default_command_log: "enable"
        file_filter:
            entries:
             -
                action: "log"
                comment: "Comment."
                direction: "incoming"
                file_type:
                 -
                    name: "default_name_11 (source antivirus.filetype.name)"
                filter: "<your_own_value>"
                password_protected: "yes"
                protocol: "ssh"
            log: "enable"
            scan_archive_contents: "enable"
            status: "enable"
        log: "x11"
        name: "default_name_19"
        shell_commands:
         -
            action: "block"
            alert: "enable"
            id:  "23"
            log: "enable"
            pattern: "<your_own_value>"
            severity: "low"
            type: "simple"

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_ssh_filter_profile_module.html