ansible.builtin.fortios_ssh_filter_profile (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 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.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 filter profile.
    fortios_ssh_filter_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      ssh_filter_profile:
        state: "present"
        block: "x11"
        default-command-log: "enable"
        log: "x11"
        name: "default_name_6"
        shell-commands:
         -
            action: "block"
            alert: "enable"
            id:  "10"
            log: "enable"
            pattern: "<your_own_value>"
            severity: "low"
            type: "simple"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    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

ssh_filter_profile:
    default: null
    description:
    - SSH filter profile.
    suboptions:
      block:
        choices:
        - x11
        - shell
        - exec
        - port-forward
        - tun-forward
        - sftp
        - unknown
        description:
        - SSH blocking options.
      default-command-log:
        choices:
        - enable
        - disable
        description:
        - Enable/disable logging unmatched shell commands.
      log:
        choices:
        - x11
        - shell
        - exec
        - port-forward
        - tun-forward
        - sftp
        - unknown
        description:
        - SSH logging options.
      name:
        description:
        - SSH filter profile name.
        required: true
      shell-commands:
        description:
        - SSH command filter.
        suboptions:
          action:
            choices:
            - block
            - allow
            description:
            - Action to take for URL filter matches.
          alert:
            choices:
            - enable
            - disable
            description:
            - Enable/disable alert.
          id:
            description:
            - Id.
            required: true
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable logging.
          pattern:
            description:
            - SSH shell command pattern.
          severity:
            choices:
            - low
            - medium
            - high
            - critical
            description:
            - Log severity.
          type:
            choices:
            - simple
            - regex
            description:
            - Matching type.
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object

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