diff --git a/monkey/common/agent_configuration/agent_sub_configurations.py b/monkey/common/agent_configuration/agent_sub_configurations.py index 188b9d1bb..b4cc80eaa 100644 --- a/monkey/common/agent_configuration/agent_sub_configurations.py +++ b/monkey/common/agent_configuration/agent_sub_configurations.py @@ -27,6 +27,25 @@ class CustomPBAConfiguration: @dataclass(frozen=True) class PluginConfiguration: + """ + Dataclass for the configuration of plugins + + :param name: Name of the plugin. + Example: "ransomware" + :param options: Any other information/configuration fields relevant to the plugin. + Example: { + "encryption": { + "enabled": True, + "directories": { + "linux_target_dir": "~/this_dir", + "windows_target_dir": "C:\that_dir" + }, + }, + "other_behaviors": { + "readme": True + }, + } + """ name: str options: Dict