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 です。

戻り値

パラメータ値。input_type が指定されていない場合は、デフォルトで {string}。

例

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（datetime 形式で取得）、 、False（Unix）	デフォルトは False（省略可）
タイムゾーン	パラメータのサポートが終了しました
new_timestamp	{int}	保存するタイムスタンプ	なし	デフォルトで Unix 時間（省略可）

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

save_timestamp で保存されたタイムスタンプを取得します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
datetime_format	{boolean}	True の場合、タイムスタンプを datetime として返します。 それ以外の場合は、Unix で返します。	True/False	デフォルトは False（省略可）
タイムゾーン	パラメータのサポートが終了しました

戻り値

保存された Unix 時間/日時。

get_connector_context_property

get_connector_context_property(identifier, property_key)

コネクタ コンテキスト プロパティを取得します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
identifier	{string}	コンテキスト ID	なし	なし
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}	アラート ID	12345	なし
ingestion_time	{long}	アラートの取り込み時間	なし	指定しない場合、デフォルトは現在時刻（Unix タイム形式）
original_file_path	{string}	アラートの元の生データを含むファイルのパス	なし	なし
original_file_content	{string}	アラートの元の生データを含むファイルの内容	なし	なし
alert_name	{string}	アラート名	なし	なし
product	{string}	アラートを生成したデバイスのプロダクト名	QRadar、Trellix ESM	なし
source_ip	{string}	アラートに関連付けられた送信元 IP アドレス	198.51.100.1	なし
source_host	{string}	アラートに関連付けられた送信元ホスト アドレス	[e-mail]、 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

property パラメータ

return_package

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

データを返します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
cases	{[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、Unix の場合は False	デフォルトは False です（省略可）。
タイムゾーン	パラメータのサポートが終了しました
new_timestamp	{long}	コンテキストに保存するタイムスタンプ	なし	タイムスタンプは、メソッドを呼び出したときの Unix タイムスタンプがデフォルト

set_connector_context_property

set_connector_context_property(identifier, property_key, property_value)

Key-Value ペアを使用してケース コンテキスト プロパティを設定します。

パラメータ

パラメータ名	パラメータ型	定義	可能値	コメント
identifier	{string}	コンテキスト ID	なし	なし
property_key	{string}	プロパティのキー	なし	なし
property_value	{string}	プロパティの値	なし	なし

プロパティ whitelist