SiemplifyConnectors 模块

类 SiemplifyConnectors.SiemplifyConnectorExecution

SiemplifyConnectors.SiemplifyConnectorExecution(mock_stdin=None)

代码库：SiemplifyBase

MAX_NUM_LOG_ROWS= 5000

extract_connector_param

extract_connector_param(param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False)

获取连接器脚本参数。
每个连接器都有在配置时填充的参数。此方法可用于提取当前正在运行的连接器的所选参数的值。\

参数

参数名称 参数类型 定义 可能的值 评论
param_name {string} 参数的名称 不适用 不适用
default_value {any} 参数的默认值。 不适用 （可选）
如果未设置参数（即 is_mandatory 设置为 False），则返回指定的值。
默认值为 None
input_type {obj} 参数的类型。例如，{int} 不适用 （可选）
返回值将转换为所选的输入类型。
默认值为 str
is_mandatory {boolean} 定义参数是否为必需参数 不适用 如果设置为 True 且未填充参数，则会引发异常。

默认值为 False
print_value {boolean} 定义是否将所提取的参数值输出到日志 不适用 默认值为 False

返回值

参数值，默认情况下为 {string}，除非指定了 input_type。

示例

from SiemplifyConnectors import SiemplifyConnectorExecution
siemplify = SiemplifyConnectorExecution()
param_value= siemplify.extract_connectors_param(
                                       "Logs Folder",
                                       default_value="C:\\Siemplify_Server\\Scripting\\JobLogs",
                                       input_type=str,
                                       is_mandatory=False,
                                       print_value=False)

结果行为

系统将返回所选参数的值，并将其转换为所选类型。

结果值

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

fetch_and_save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181328)

提取时间戳并将其保存到支持请求上下文。

参数

参数名称 参数类型 定义 可能的值 评论
datetime_format {boolean} 日期/时间格式 True 用于获取日期时间格式，
False 用于获取 Unix 时间		 默认值为 False（可选）
timezone 相应参数不再受支持
new_timestamp {int} 要保存的时间戳 不适用 默认采用 Unix 时间（可选）

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

获取使用 save_timestamp 保存的时间戳。

参数

参数名称 参数类型 定义 可能的值 评论
datetime_format {boolean} 如果值为 True，则以日期时间格式返回时间戳。
否则，以 Unix 格式返回		 True/False 默认值为 False（可选）
timezone 相应参数不再受支持

返回值

已保存的 Unix 时间/日期时间。

get_connector_context_property

get_connector_context_property(identifier, property_key)

获取连接器上下文属性。

参数

参数名称 参数类型 定义 可能的值 评论
标识符 {string} 上下文标识符 不适用 不适用
property_key {string} 所请求的键属性 不适用 不适用

返回值

{string} 属性值

is_overflowed_alert

is_overflowed_alert(environment, alert_identifier, ingestion_time=1683034181328, original_file_path=None, original_file_content=None, alert_name=None, product=None, source_ip=None, source_host=None, destination_ip=None, destination_host=None)

检查提醒是否溢出。

参数

参数名称 参数类型 定义 可能的值 评论
环境 {string} 环境名称 示例 不适用
alert_identifier {string} 提醒标识符 12345 不适用
ingestion_time {long} 提醒提取时间 不适用 如果未提供，则默认为当前时间（Unix 时间格式）
original_file_path {string} 包含提醒原始原始数据的文件路径 不适用 不适用
original_file_content {string} 包含提醒原始原始数据的文件内容 不适用 不适用
alert_name {string} 提醒名称 不适用 不适用
产品 {string} 生成提醒的设备的商品名称 QRadar、Trellix ESM 不适用
source_ip {string} 与相应提醒关联的来源 IP 地址 198.51.100.1 不适用
source_host {string} 与提醒关联的源主机地址 source@example.com,
source.example.com		 不适用
destination_ip {string} 与提醒关联的目标 IP 地址 203.0.113.1 不适用
destination_host {string} 与提醒关联的目标主机地址 destination.example.com 不适用

返回值

{boolean} True/False

示例

from SiemplifyConnectors import SiemplifyConnectorExecution
siemplify = SiemplifyConnectorExecution()
siemplify.is_overflowed_alert(environment, alert_identifier, ingestion_time=SiemplifyUtils.unix_now(), original_file_path, original_file_content, alert_name, product, source_ip, source_host, destination_ip, destination_host)

结果行为

如果提醒在提取过程中会溢出，则为 True。否则，值为 False。

结果值

True/False

属性 is_test_run

property log_location

媒体资源参数

return_package

return_package(cases, output_variables={}, log_items=[])

返回数据。

参数

参数名称 参数类型 定义 可能的值 评论
支持请求 {[CaseInfo]} CaseInfo 对象的列表 不适用 不适用
output_variables 已弃用
log_items 已弃用

返回值

NoneType

示例

from SiemplifyConnectors import SiemplifyConnectorExecution siemplify = SiemplifyConnectorExecution() siemplify.return_package(cases, output_variables, log_items)

结果值

无

return_test_result

return_test_result(is_success, result_params_dictionary)

property run_folder

根据脚本名称构建 run_folder。

返回值

{string} 完整路径

结果值

C:Siemplify_ServerScriptingSiemplifyAction<script name>

save_timestamp

save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181328)

将时间戳保存到当前脚本上下文。

参数

参数名称 参数类型 定义 可能的值 评论
datetime_format {boolean} 不适用 True 表示日期时间格式，
表示 UnixFalse		 默认值为 False（可选）
timezone 相应参数不再受支持
new_timestamp {long} 要保存到上下文的时间戳 不适用 时间戳默认设置为调用该方法时的 Unix 时间戳

set_connector_context_property

set_connector_context_property(identifier, property_key, property_value)

使用键值对设置案例上下文属性。

参数

参数名称 参数类型 定义 可能的值 评论
标识符 {string} 上下文标识符 不适用 不适用
property_key {string} 相应房源的键 不适用 不适用
property_value {string} 属性的值 不适用 不适用

property whitelist