drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_dlp_profile_rule Set up DLP rules for this profile. | "added in version" 2.1.6 of drmofu.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 communitydrmofu.fortimanager.fmgr_dlp_profile_rule (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Set up DLP rules for this profile. fmgr_dlp_profile_rule: 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> profile: <your own value> state: <value in [present, absent]> dlp_profile_rule: action: <value in [log-only, block, quarantine-ip, ...]> archive: <value in [disable, enable]> expiry: <value of string> file-size: <value of integer> file-type: <value of string> filter-by: <value in [fingerprint, sensor, encrypted, ...]> id: <value of integer> label: <value of string> match-percentage: <value of integer> name: <value of string> proto: - smtp - pop3 - imap - http-post - http-get - ftp - nntp - mapi - ssh - cifs sensitivity: <value of string> sensor: <value of string> severity: <value in [info, low, medium, ...]> type: <value in [file, message]>
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 profile: description: the parameter (profile) in requested url required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str dlp_profile_rule: description: the top level parameters set required: false suboptions: action: choices: - log-only - block - quarantine-ip - allow description: Action to take with content that this DLP profile matches. type: str archive: choices: - disable - enable description: Enable/disable DLP archiving. type: str expiry: description: Quarantine duration in days, hours, minutes type: str file-size: description: Match files this size or larger type: int file-type: description: Select the number of a DLP file pattern table to match. type: str filter-by: choices: - fingerprint - sensor - encrypted - none - mip description: Select the type of content to match. type: str id: description: ID. type: int label: description: MIP label dictionary. type: str match-percentage: description: Percentage of fingerprints in the fingerprint databases designated with the selected sensitivity to match. type: int name: description: Filter name. type: str proto: choices: - smtp - pop3 - imap - http-post - http-get - ftp - nntp - mapi - ssh - cifs description: description elements: str type: list sensitivity: description: description type: str sensor: description: description type: str severity: choices: - info - low - medium - high - critical description: Select the severity or threat level that matches this filter. type: str type: choices: - file - message description: Select whether to check the content of messages type: str type: dict bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false 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