New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
host
-
/ required
|
FortiOS or FortiGate ip address.
|
|||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
||
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
||
ssh_filter_profile
-
|
Default: null
|
SSH filter profile.
|
||
block
-
|
|
SSH blocking options.
|
||
default-command-log
-
|
|
Enable/disable logging unmatched shell commands.
|
||
log
-
|
|
SSH logging options.
|
||
name
-
/ required
|
SSH filter profile name.
|
|||
shell-commands
-
|
SSH command filter.
|
|||
action
-
|
|
Action to take for URL filter matches.
|
||
alert
-
|
|
Enable/disable alert.
|
||
id
-
/ required
|
Id.
|
|||
log
-
|
|
Enable/disable logging.
|
||
pattern
-
|
SSH shell command pattern.
|
|||
severity
-
|
|
Log severity.
|
||
type
-
|
|
Matching type.
|
||
state
-
|
|
Indicates whether to create or remove the object
|
||
username
-
/ required
|
FortiOS or FortiGate username.
|
|||
vdom
-
|
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.
|
Note
- 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"
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.