fortios_ssh_filter_profile.rst

source:	fortios_ssh_filter_profile.py
orphan:

fortios_ssh_filter_profile -- Configure SSH filter profile in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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

Tips

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

FortiOS Version Compatibility

	Supported Version Ranges
fortios_ssh_filter_profile	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
• state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
• ssh_filter_profile - Configure SSH filter profile. type: dict more...

  	Supported Version Ranges
  ssh_filter_profile	v6.0.0 -> latest

• block - SSH blocking options. type: list choices: x11, shell, exec, port-forward, tun-forward, sftp, scp, unknown more...

  	Supported Version Ranges
  block	v6.0.0 -> latest
  [x11]	v6.0.0 -> latest
  [shell]	v6.0.0 -> latest
  [exec]	v6.0.0 -> latest
  [port-forward]	v6.0.0 -> latest
  [tun-forward]	v6.0.0 -> latest
  [sftp]	v6.0.0 -> latest
  [scp]	v6.2.0 -> latest
  [unknown]	v6.0.0 -> latest

• default_command_log - Enable/disable logging unmatched shell commands. type: str choices: enable, disable more...

  	Supported Version Ranges
  default_command_log	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• file_filter - File filter. type: dict more...

  	Supported Version Ranges
  file_filter	v6.2.0 -> v6.2.7

• entries - File filter entries. type: list member_path: file_filter/entries:filter more...

  	Supported Version Ranges
  entries	v6.2.0 -> v6.2.7

• action - Action taken for matched file. type: str choices: log, block more...

  	Supported Version Ranges
  action	v6.2.0 -> v6.2.7
  [log]	v6.0.0 -> latest
  [block]	v6.0.0 -> latest

• comment - Comment. type: str more...

  	Supported Version Ranges
  comment	v6.2.0 -> v6.2.7

• direction - Match files transmitted in the session"s originating or reply direction. type: str choices: incoming, outgoing, any more...

  	Supported Version Ranges
  direction	v6.2.0 -> v6.2.7
  [incoming]	v6.0.0 -> latest
  [outgoing]	v6.0.0 -> latest
  [any]	v6.0.0 -> latest

• file_type - Select file type. type: list member_path: file_filter/entries:filter/file_type:name more...

  	Supported Version Ranges
  file_type	v6.2.0 -> v6.2.7

• name - File type name. Source antivirus.filetype.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> v6.2.7

• filter - Add a file filter. type: str required: true more...

  	Supported Version Ranges
  filter	v6.2.0 -> v6.2.7

• password_protected - Match password-protected files. type: str choices: yes, any more...

  	Supported Version Ranges
  password_protected	v6.2.0 -> v6.2.7
  [yes]	v6.0.0 -> latest
  [any]	v6.0.0 -> latest

• protocol - Protocols to apply with. type: list choices: ssh more...

  	Supported Version Ranges
  protocol	v6.2.3 -> v6.2.3
  [ssh]	v6.0.0 -> latest

• log - Enable/disable file filter logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  log	v6.2.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• scan_archive_contents - Enable/disable file filter archive contents scan. type: str choices: enable, disable more...

  	Supported Version Ranges
  scan_archive_contents	v6.2.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• status - Enable/disable file filter. type: str choices: enable, disable more...

  	Supported Version Ranges
  status	v6.2.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• log - SSH logging options. type: list choices: x11, shell, exec, port-forward, tun-forward, sftp, scp, unknown more...

  	Supported Version Ranges
  log	v6.0.0 -> latest
  [x11]	v6.0.0 -> latest
  [shell]	v6.0.0 -> latest
  [exec]	v6.0.0 -> latest
  [port-forward]	v6.0.0 -> latest
  [tun-forward]	v6.0.0 -> latest
  [sftp]	v6.0.0 -> latest
  [scp]	v6.2.0 -> latest
  [unknown]	v6.0.0 -> latest

• name - SSH filter profile name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• shell_commands - SSH command filter. type: list member_path: shell_commands:id more...

  	Supported Version Ranges
  shell_commands	v6.0.0 -> latest

• action - Action to take for SSH shell command matches. type: str choices: block, allow more...

  	Supported Version Ranges
  action	v6.0.0 -> latest
  [block]	v6.0.0 -> latest
  [allow]	v6.0.0 -> latest

• alert - Enable/disable alert. type: str choices: enable, disable more...

  	Supported Version Ranges
  alert	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• id - Id. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> latest

• log - Enable/disable logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  log	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• pattern - SSH shell command pattern. type: str more...

  	Supported Version Ranges
  pattern	v6.0.0 -> latest

• severity - Log severity. type: str choices: low, medium, high, critical more...

  	Supported Version Ranges
  severity	v6.0.0 -> latest
  [low]	v6.0.0 -> latest
  [medium]	v6.0.0 -> latest
  [high]	v6.0.0 -> latest
  [critical]	v6.0.0 -> latest

• type - Matching type. type: str choices: simple, regex more...

  	Supported Version Ranges
  type	v6.0.0 -> latest
  [simple]	v6.0.0 -> latest
  [regex]	v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure SSH filter profile.
  fortinet.fortios.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: 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.