- source
fmgr_sshfilter_profile.py
- orphan
2.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> latest
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- sshfilter_profile - SSH filter profile. type: dict
- block Ssh blocking options. type: list choices: [x11, shell, exec, port-forward, tun-forward, sftp, unknown, scp]
more...
Supported Version Ranges:
v6.0.0 -> latest
- default_command_log (Alias name: default-command-log) Enable/disable logging unmatched shell commands. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- log Ssh logging options. type: list choices: [x11, shell, exec, port-forward, tun-forward, sftp, unknown, scp]
more...
Supported Version Ranges:
v6.0.0 -> latest
- name Ssh filter profile name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- shell_commands (Alias name: shell-commands) Shell-commands. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest
- action Action to take for url filter matches. type: str choices: [block, allow]
more...
Supported Version Ranges:
v6.0.0 -> latest
- alert Enable/disable alert. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- id Id. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- log Enable/disable logging. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- pattern Ssh shell command pattern. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- severity Log severity. type: str choices: [low, medium, high, critical]
more...
Supported Version Ranges:
v6.0.0 -> latest
- type Matching type. type: str choices: [regex, simple]
more...
Supported Version Ranges:
v6.0.0 -> latest
- action Action to take for url filter matches. type: str choices: [block, allow]
more...
- file_filter (Alias name: file-filter) type: dict
- entries type: list
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- action Action taken for matched file. type: str choices: [log, block]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- comment Comment. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- direction Match files transmitted in the sessions originating or reply direction. type: str choices: [any, incoming, outgoing]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- file_type (Alias name: file-type) type: list
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- filter Add a file filter. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- password_protected (Alias name: password-protected) Match password-protected files. type: str choices: [any, yes]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- protocol type: list choices: [ssh]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- action Action taken for matched file. type: str choices: [log, block]
more...
- log Enable/disable file filter logging. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- scan_archive_contents (Alias name: scan-archive-contents) Enable/disable file filter archive contents scan. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- status Enable/disable file filter. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- entries type: list
more...
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work. - To create or update an object, use state: present directive. - To delete an object, use state: absent directive - Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: SSH filter profile.
fortinet.fortimanager.fmgr_sshfilter_profile:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
sshfilter_profile:
block:
- x11
- shell
- exec
- port-forward
- tun-forward
- sftp
- unknown
- scp
default_command_log: <value in [disable, enable]>
log:
- x11
- shell
- exec
- port-forward
- tun-forward
- sftp
- unknown
- scp
name: <string>
shell_commands:
-
action: <value in [block, allow]>
alert: <value in [disable, enable]>
id: <integer>
log: <value in [disable, enable]>
pattern: <string>
severity: <value in [low, medium, high, ...]>
type: <value in [regex, simple]>
file_filter:
entries:
-
action: <value in [log, block]>
comment: <string>
direction: <value in [any, incoming, outgoing]>
file_type: <list or string>
filter: <string>
password_protected: <value in [any, yes]>
protocol:
- ssh
log: <value in [disable, enable]>
scan_archive_contents: <value in [disable, enable]>
status: <value in [disable, enable]>
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:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)