SiemplifyConnectors-Modul

class SiemplifyConnectors.SiemplifyConnectorExecution

SiemplifyConnectors.SiemplifyConnectorExecution(mock_stdin=None)

Basiert auf: 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)

Einen Connector-Skriptparameter abrufen.
Jeder Connector hat Parameter, die beim Konfigurieren ausgefüllt werden. Mit dieser Methode kann der Wert eines ausgewählten Parameters des aktuell ausgeführten Connectors extrahiert werden.\

Hinweis :Zugehörige Konzepte: Integrationskonfiguration und Skriptparameter

Parameter

Parametername	Parametertyp	Definition	Mögliche Werte	Kommentare
param_name	{string}	Name des Parameters	–	–
default_value	{any}	Der Standardwert des Parameters.	–	(Optional) Der angegebene Wert wird zurückgegeben, wenn der Parameter nicht festgelegt wurde (wenn is_mandatory auf False festgelegt ist). Der Standardwert ist None.
input_type	{obj}	Der Typ des Parameters. Beispiel: {int}	–	(Optional) Der zurückgegebene Wert wird in den ausgewählten Eingabetyp umgewandelt. Der Standardwert ist str.
is_mandatory	{boolean}	Gibt an, ob der Parameter erforderlich ist.	–	Wenn der Parameter auf True festgelegt ist und nicht ausgefüllt wurde, wird eine Ausnahme ausgelöst. Der Standardwert ist False.
print_value	{boolean}	Definiert, ob der abgerufene Wert des Parameters in den Logs ausgegeben werden soll.	–	Standardwert ist False

Gibt Folgendes zurück:

Der Parameterwert, standardmäßig {string}, sofern input_type nicht angegeben ist.

Beispiel

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)

Verhalten bei Ergebnissen

Der Wert des ausgewählten Parameters wird zurückgegeben und in den ausgewählten Typ umgewandelt.

Ergebniswert

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

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

Zeitstempel abrufen und im Fallkontext speichern.

Parameter

Parametername	Parametertyp	Definition	Mögliche Werte	Kommentare
datetime_format	{boolean}	Format für Datum/Uhrzeit	True für das Datum/die Uhrzeit im Datums-/Uhrzeitformat, False für Unix	Standardmäßig False (optional)
Zeitzone	Parameter wird nicht mehr unterstützt
new_timestamp	{int}	Der zu speichernde Zeitstempel	–	Standardmäßig Unix-Zeit (optional)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Ruft den mit save_timestamp gespeicherten Zeitstempel ab.

Parameter

Parametername	Parametertyp	Definition	Mögliche Werte	Kommentare
datetime_format	{boolean}	Bei True wird der Zeitstempel als Datums-/Uhrzeitformat zurückgegeben. Andernfalls wird die Unix-Zeit zurückgegeben.	Wahr/falsch	Standardmäßig „false“ (optional)
Zeitzone	Parameter wird nicht mehr unterstützt

Gibt Folgendes zurück:

Gespeicherte Unix-Zeit/Datum/Uhrzeit.

get_connector_context_property

get_connector_context_property(identifier, property_key)

Eine Kontext-Property für einen Connector abrufen.

Parameter

Parametername	Parametertyp	Definition	Mögliche Werte	Kommentare
identifier	{string}	Kontext-ID	–	–
property_key	{string}	Die angeforderte Haupteigenschaft	–	–

Gibt Folgendes zurück:

{string} – der Attributwert

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)

Prüfen Sie, ob die Benachrichtigung überläuft.

Parameter

Parametername	Parametertyp	Definition	Mögliche Werte	Kommentare
Umgebung	{string}	Name der Umgebung	Beispiel	–
alert_identifier	{string}	Benachrichtigungs-ID	12345	–
ingestion_time	{long}	Aufnahmezeit für Benachrichtigungen	–	Wenn nicht angegeben, wird standardmäßig die aktuelle Zeit (Unix-Zeitformat) verwendet.
original_file_path	{string}	Pfad zur Datei mit den ursprünglichen Rohdaten der Benachrichtigung	–	–
original_file_content	{string}	Inhalt der Datei mit den ursprünglichen Rohdaten der Benachrichtigung	–	–
alert_name	{string}	Name der Benachrichtigung	–	–
Produkt	{string}	Der Produktname des Geräts, das die Benachrichtigung generiert hat	QRadar, Trellix ESM	–
source_ip	{string}	Die Quell-IP-Adresse, die mit der Benachrichtigung verknüpft ist	198.51.100.1	–
source_host	{string}	Die mit der Benachrichtigung verknüpfte Quellhostadresse	[e-mail], source.beispiel.de	–
destination_ip	{string}	Ziel-IP-Adresse, die mit der Benachrichtigung verknüpft ist	203.0.113.1	–
destination_host	{string}	Zielhostadresse, die mit der Benachrichtigung verknüpft ist	destination.example.com	–

Gibt Folgendes zurück:

{boolean} True/False

Beispiel

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)

Verhalten bei Ergebnissen

True, wenn die Benachrichtigung während der Aufnahme überläuft. Andernfalls False.

Ergebniswert

Wahr/falsch

property is_test_run

Property „log_location“

Property-Parameter

return_package

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

Daten zurückgeben.

Parameter

Parametername	Parametertyp	Definition	Mögliche Werte	Kommentare
Fälle	{[CaseInfo]}	Die Liste der CaseInfo-Objekte	–	–
output_variables				Verworfen
log_items				Verworfen

Gibt Folgendes zurück:

NoneType

Beispiel

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

Ergebniswert

Keine

return_test_result

return_test_result(is_success, result_params_dictionary)

Eingestellt :Die Funktion wird nicht mehr unterstützt.

property run_folder

Erstellen Sie die run_folder basierend auf dem Skriptnamen.

Gibt Folgendes zurück:

Vollständiger Pfad {string}

Ergebniswert

C:Siemplify_ServerScriptingSiemplifyAction<script name>

save_timestamp

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

Speichert den Zeitstempel im aktuellen Skriptkontext.

Parameter

Parametername	Parametertyp	Definition	Mögliche Werte	Kommentare
datetime_format	{boolean}	–	True für das Datums-/Uhrzeitformat, False für Unix	Der Standardwert ist False (optional).
Zeitzone	Parameter wird nicht mehr unterstützt
new_timestamp	{long}	Zeitstempel zum Speichern im Kontext	–	Der Zeitstempel ist standardmäßig der Unix-Zeitstempel des Aufrufs der Methode.

set_connector_context_property

set_connector_context_property(identifier, property_key, property_value)

Legen Sie eine Eigenschaft für den Fallkontext mit dem Schlüssel/Wert-Paar fest.

Parameter

Parametername	Parametertyp	Definition	Mögliche Werte	Kommentare
identifier	{string}	Kontext-ID	–	–
property_key	{string}	Schlüssel der Unterkunft	–	–
property_value	{string}	Wert der Property	–	–

property whitelist