fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_sshfilter_profile SSH filter profile. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_sshfilter_profile (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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]>
adom: description: The parameter (adom) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool sshfilter_profile: description: The top level parameters set. required: false suboptions: block: choices: - x11 - shell - exec - port-forward - tun-forward - sftp - unknown - scp description: SSH blocking options. elements: str type: list default-command-log: choices: - disable - enable description: Deprecated, please rename it to default_command_log. Enable/disable logging unmatched shell commands. type: str file-filter: description: Deprecated, please rename it to file_filter. suboptions: entries: description: No description. elements: dict suboptions: action: choices: - log - block description: Action taken for matched file. type: str comment: description: Comment. type: str direction: choices: - any - incoming - outgoing description: Match files transmitted in the sessions originating or reply direction. type: str file-type: description: (list) Deprecated, please rename it to file_type. type: raw filter: description: Add a file filter. type: str password-protected: choices: - any - 'yes' description: Deprecated, please rename it to password_protected. Match password-protected files. type: str protocol: choices: - ssh description: No description. elements: str type: list type: list log: choices: - disable - enable description: Enable/disable file filter logging. type: str scan-archive-contents: choices: - disable - enable description: Deprecated, please rename it to scan_archive_contents. Enable/disable file filter archive contents scan. type: str status: choices: - disable - enable description: Enable/disable file filter. type: str type: dict log: choices: - x11 - shell - exec - port-forward - tun-forward - sftp - unknown - scp description: SSH logging options. elements: str type: list name: description: SSH filter profile name. required: true type: str shell-commands: description: Deprecated, please rename it to shell_commands. Shell-Commands. elements: dict suboptions: action: choices: - block - allow description: Action to take for URL filter matches. type: str alert: choices: - disable - enable description: Enable/disable alert. type: str id: description: Id. type: int log: choices: - disable - enable description: Enable/disable logging. type: str pattern: description: SSH shell command pattern. type: str severity: choices: - low - medium - high - critical description: Log severity. type: str type: choices: - regex - simple description: Matching type. type: str type: list type: dict workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list