SiemplifyJob-Modul
class SiemplifyJob.SiemplifyJob
Basen: Siemplify
Endpunkte: external/v1/sdk/GetFailedETLOperations
extract_job_param
extract_job_param(param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False)
Konfigurationsparameter aus der Integrationsinstanz abrufen.
Parameter
| Parametername | Parametertyp | Definition | Mögliche Werte | Kommentare |
|---|---|---|---|---|
| param_name | {string} | Name des abzurufenden 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).Standardmäßig None |
|
| input_type | {obj} | Der Typ des Parameters | – | (Optional) Der zurückgegebene Wert wird in den ausgewählten Eingabetyp umgewandelt. {str} standardmäßig |
| is_mandatory | {boolean} | Gibt an, ob der Parameter erforderlich ist. | – | (Optional) Wenn auf „True“ gesetzt und der Parameter nicht ausgefüllt wurde, wird eine Ausnahme ausgelöst. Standardmäßig False |
| print_value | {boolean} | Gibt an, ob der abgerufene Wert des Parameters in die Logs ausgegeben werden soll. | – | (Optional) Standardmäßig False |
Gibt Folgendes zurück:
Der Parameterwert, standardmäßig ein String, sofern input_type nicht angegeben ist.
Beispiel
from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
param_value= siemplify.extract_job_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=1683034181430)
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-Epochenzeit (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_configuration
get_configuration(provider, environment=None, integration_instance=None)
Rufen Sie die Integrationskonfiguration ab.
Parameter
| Parametername | Parametertyp | Definition | Mögliche Werte | Kommentare |
|---|---|---|---|---|
| Anbieter | {string} | Name der Integration | VirusTotal | Beim Namen des Integrationsanbieters wird die Groß- und Kleinschreibung beachtet. Ein Fehler wird ausgegeben, wenn die Integration nicht installiert ist oder der String nicht vorhanden ist. |
| Umgebung | {string} | Konfiguration für eine bestimmte Umgebung oder „all“ | – | (Optional) Falls angegeben, werden die Anmeldedaten aus der entsprechenden Umgebungskonfiguration abgerufen. Wenn keine Umgebung angegeben ist, wird standardmäßig die Fallumgebung verwendet. Wenn keine Konfiguration für diese bestimmte Umgebung vorhanden ist, wird die Standardkonfiguration zurückgegeben. |
| integration_instance | {string} | Kennung der Integrationsinstanz | – | – |
Gibt Folgendes zurück:
{dict} Konfigurationsdetails
Beispiel
from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
siemplify.get_configuration(provider="VirusTotal", environment="")
Verhalten bei Ergebnissen
Es wird ein Dictionary mit gespeicherten Anmeldedaten für die Integration aus dem Google Security Operations Marketplace zurückgegeben.
Ergebniswert
{
u'AgentIdentifier': None,
u'Api Key': u'c0c412#########################4f85b22e707',
u'Verify SSL': u'True',
u'RunRemotely': u'False'
}
get_failed_actions
get_failed_actions(number_of_hours)
Alle ETL-Jobs abrufen, die in der angegebenen Anzahl von Stunden fehlgeschlagen sind.
Gibt Folgendes zurück:
{dict} fehlgeschlagene Jobs
{'Id':{string}, 'Name':{string}, 'Message':{string}, WorkflowId = {string}, CreationTime: {string}, CaseId:{string}}
get_failed_etljobs
get_failed_etljobs(number_of_hours)
Alle ETL-Jobs abrufen, die in der angegebenen Anzahl von Stunden fehlgeschlagen sind.
Gibt Folgendes zurück:
{dict} fehlgeschlagene Jobs
{ 'Id': {string}, 'Name': {string}, Message: {string}, CreationTime: {string}}
get_faulted_connectors
get_faulted_connectors(start_unix_time, end_unix_time)
Alle Connectors abrufen, bei denen zwischen start_unix_time und end_unix_time ein Fehler aufgetreten ist.
Gibt Folgendes zurück:
Fehler bei {dict}-Connectors
Ergebniswert
{'Name': {string}, 'Message': {string}, 'CreationTime': {string}}
get_faulted_jobs
get_faulted_jobs(number_of_hours)
Alle Jobs abrufen, die in der angegebenen Anzahl von Stunden fehlgeschlagen sind.
Gibt Folgendes zurück:
{[dict]} fehlgeschlagene Jobs
Ergebniswert
[{'Id': {long}, 'Name':{string}, 'Message':{string}, 'CreationTime':{string}}]
get_job_context_property
get_job_context_property(identifier, property_key)
Ruft einen Jobkontextwert anhand des angegebenen Schlüssels ab.
Parameter
| Parametername | Parametertyp | Definition | Mögliche Werte | Kommentare |
|---|---|---|---|---|
| identifier | {string} | Kontext-ID | – | – |
| property_key | {string} | Der Schlüssel der abzurufenden Property | – | – |
get_scoped_job_context_property
get_scoped_job_context_property(property_key)
Ruft die kontextbezogene Job-Eigenschaft mit dem eindeutigen Bezeichner eines Jobs ab.
Parameter
| Parametername | Parametertyp | Definition | Mögliche Werte | Kommentare |
|---|---|---|---|---|
| property_key | {string} | Der Schlüssel der Kontext-Property des Jobs | – | – |
Gibt Folgendes zurück:
Wert eines bestimmten Schlüssels.
get_system_info
get_system_info(start_time_unixtime_ms)
Property „log_location“
save_publisher_logs
save_publisher_logs(records)
Publisher-Logdatensätze speichern
Parameter
| Parametername | Parametertyp | Definition | Mögliche Werte | Kommentare |
|---|---|---|---|---|
| Aufzeichnungen | {list} | Zu speichernde Datensätze | – | – |
save_timestamp
save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)
Zeitstempel speichern.
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. |
send_mail
send_mail(subject, message, recipients, attachment_file_name, attachment_content)
E-Mail senden (Anhänge sind zulässig).
Parameter
| Parametername | Parametertyp | Definition | Mögliche Werte | Kommentare |
|---|---|---|---|---|
| subject | {string} | E‑Mail-Betreff | – | – |
| Nachricht | {string} | E-Mail-Nachricht | – | – |
| attachment_file_name | {string} | Dateiname des Anhangs | – | – |
| Empfänger | {[{string}]} | Empfängerliste | – | – |
set_job_context_property
set_job_context_property(identifier, property_key, property_value)
Legen Sie die kontextbezogene Job-Eigenschaft mit dem eindeutigen Bezeichner eines Jobs fest.
Parameter
| Parametername | Parametertyp | Definition | Mögliche Werte | Kommentare |
|---|---|---|---|---|
| identifier | {string} | Kontext-ID | – | – |
| property_key | {string} | Der Schlüssel der Kontext-Property des Jobs | – | – |
| property_value | {string} | Der Wert der Kontext-Property des Jobs | – | – |
set_scoped_job_context_property
set_scoped_job_context_property(property_key, property_value)
Legen Sie die kontextbezogene Job-Eigenschaft mit dem eindeutigen Bezeichner eines Jobs fest.
Parameter
| Parametername | Parametertyp | Definition | Mögliche Werte | Kommentare |
|---|---|---|---|---|
| property_key | {string} | Der Schlüssel der Kontext-Property des Jobs | – | – |
| property_value | {string} | Der Wert der Kontext-Property des Jobs | – | – |