Modulo SiemplifyConnectors
class SiemplifyConnectors.SiemplifyConnectorExecution
SiemplifyConnectors.SiemplifyConnectorExecution(mock_stdin=None)
Basi: 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)
Ottieni un parametro dello script del connettore.
Ogni connettore ha parametri che vengono compilati quando viene configurato. Questo metodo
consente di estrarre il valore di un parametro selezionato del connettore
attualmente in esecuzione.\
Parametri
| Nome del parametro | Tipo di parametro | Definizione | Valori possibili | Commenti |
|---|---|---|---|---|
| param_name | {string} | Nome del parametro | N/D | N/D |
| default_value | {any} | Il valore predefinito del parametro. | N/D | (Facoltativo) Il valore specificato verrà restituito se il parametro non è stato impostato (se is_mandatory è impostato su False).Il valore predefinito è None. |
| input_type | {obj} | Il tipo di parametro. Ad esempio, {int} | N/D | (Facoltativo) Il valore restituito verrà convertito nel tipo di input selezionato. Il valore predefinito è str |
| is_mandatory | {boolean} | Definisce se il parametro è obbligatorio | N/D | Se impostato su True e il parametro non è stato compilato,verrà generata un'eccezione. Il valore predefinito è False |
| print_value | {boolean} | Definisce se restituire il valore recuperato del parametro nei log | N/D | Il valore predefinito è False |
Restituisce
Il valore parametro, {string} per impostazione predefinita, a meno che non sia specificato input_type.
Esempio
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)
Comportamento dei risultati
Il valore del parametro selezionato verrà restituito, convertito nel tipo selezionato.
Valore del risultato
C:\Siemplify_Server\Scripting\SampleJob\Logs
fetch_and_save_timestamp
fetch_and_save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181328)
Recupera il timestamp e salvalo nel contesto della richiesta.
Parametri
| Nome del parametro | Tipo di parametro | Definizione | Valori possibili | Commenti |
|---|---|---|---|---|
| datetime_format | {boolean} | Formato per data/ora | True per ottenere il formato data/ora,False per Unix |
False per impostazione predefinita (facoltativo) |
| fuso orario | Parametro non più supportato | |||
| new_timestamp | {int} | Il timestamp da salvare | N/D | Tempo Unix per impostazione predefinita (facoltativo) |
fetch_timestamp
fetch_timestamp(datetime_format=False, timezone=False)
Ottieni il timestamp salvato con save_timestamp.
Parametri
| Nome del parametro | Tipo di parametro | Definizione | Valori possibili | Commenti |
|---|---|---|---|---|
| datetime_format | {boolean} | Se True, restituisci il timestamp come data e ora.Altrimenti, restituisci in formato Unix |
Vero/Falso | False per impostazione predefinita (facoltativo) |
| fuso orario | Parametro non più supportato | |||
Restituisce
Data/ora Unix salvata.
get_connector_context_property
get_connector_context_property(identifier, property_key)
Ottieni una proprietà di contesto del connettore.
Parametri
| Nome del parametro | Tipo di parametro | Definizione | Valori possibili | Commenti |
|---|---|---|---|---|
| identificatore | {string} | Identificatore del contesto | N/D | N/D |
| property_key | {string} | La proprietà principale richiesta | N/D | N/D |
Restituisce
{string} il valore della proprietà
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)
Controlla se l'avviso è in overflow.
Parametri
| Nome del parametro | Tipo di parametro | Definizione | Valori possibili | Commenti |
|---|---|---|---|---|
| produzione | {string} | Nome ambiente | Esempio | N/D |
| alert_identifier | {string} | Identificatore avviso | 12345 | N/D |
| ingestion_time | {long} | Data di importazione dell'avviso | N/D | Se non viene fornito, il valore predefinito è l'ora corrente (formato ora Unix) |
| original_file_path | {string} | Percorso del file contenente i dati non elaborati originali dell'avviso | N/D | N/D |
| original_file_content | {string} | Contenuto del file contenente i dati non elaborati originali dell'avviso | N/D | N/D |
| alert_name | {string} | Nome avviso | N/D | N/D |
| prodotto | {string} | Il nome del prodotto per il dispositivo che ha generato l'avviso | QRadar, Trellix ESM | N/D |
| source_ip | {string} | L'indirizzo IP di origine associato all'avviso | 198.51.100.1 | N/D |
| source_host | {string} | L'indirizzo host di origine associato all'avviso | source@example.com, source.example.com |
N/D |
| destination_ip | {string} | Indirizzo IP di destinazione associato all'avviso | 203.0.113.1 | N/D |
| destination_host | {string} | Indirizzo host di destinazione associato all'avviso | destination.example.com | N/D |
Restituisce
{boolean} True/False
Esempio
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)
Comportamento dei risultati
True se l'avviso verrà sottoposto a overflow durante il processo di importazione. Altrimenti,
False.
Valore del risultato
Vero/Falso
property is_test_run
property log_location
Parametri proprietà
return_package
return_package(cases, output_variables={}, log_items=[])
Dati restituiti.
Parametri
| Nome del parametro | Tipo di parametro | Definizione | Valori possibili | Commenti |
|---|---|---|---|---|
| cases | {[CaseInfo]} | L'elenco degli oggetti CaseInfo | N/D | N/D |
| output_variables | Ritirato | |||
| log_items | Ritirato |
Restituisce
NoneType
Esempio
from SiemplifyConnectors import SiemplifyConnectorExecution siemplify = SiemplifyConnectorExecution() siemplify.return_package(cases, output_variables, log_items)
Valore del risultato
Nessuno
return_test_result
return_test_result(is_success, result_params_dictionary)
property run_folder
Crea il run_folder in base al nome dello script.
Restituisce
Percorso completo di {string}
Valore del risultato
C:Siemplify_ServerScriptingSiemplifyAction<script name>
save_timestamp
save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181328)
Salva il timestamp nel contesto dello script corrente.
Parametri
| Nome del parametro | Tipo di parametro | Definizione | Valori possibili | Commenti |
|---|---|---|---|---|
| datetime_format | {boolean} | N/D | True per il formato data/ora,False per Unix |
Il valore predefinito è False (facoltativo) |
| fuso orario | Parametro non più supportato | |||
| new_timestamp | {long} | Timestamp da salvare nel contesto | N/D | Il timestamp corrisponde per impostazione predefinita al timestamp Unix della chiamata al metodo |
set_connector_context_property
set_connector_context_property(identifier, property_key, property_value)
Imposta una proprietà del contesto del caso utilizzando la coppia chiave/valore.
Parametri
| Nome del parametro | Tipo di parametro | Definizione | Valori possibili | Commenti |
|---|---|---|---|---|
| identificatore | {string} | Identificatore del contesto | N/D | N/D |
| property_key | {string} | Chiave della proprietà | N/D | N/D |
| property_value | {string} | Valore della proprietà | N/D | N/D |