Módulo SiemplifyConnectors

clase SiemplifyConnectors.SiemplifyConnectorExecution

SiemplifyConnectors.SiemplifyConnectorExecution(mock_stdin=None)

Bases: 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)

Obtiene un parámetro de secuencia de comandos de un conector.
Cada conector tiene parámetros que se rellenan cuando se configura. Este método permite extraer el valor de un parámetro seleccionado del conector que se está ejecutando.\

Nota: Conceptos relacionados: Configuración de la integración y parámetros de los scripts

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
param_name	{string}	Nombre del parámetro	N/A	N/A
default_value	{any}	El valor predeterminado del parámetro.	N/A	(Opcional) El valor proporcionado se devolverá si no se ha definido el parámetro (si is_mandatory se ha definido como False). El valor predeterminado es None.
input_type	{obj}	Tipo de parámetro. Por ejemplo, {int}	N/A	(Opcional) El valor devuelto se convertirá al tipo de entrada seleccionado. El valor predeterminado es str.
is_mandatory	{boolean}	Define si el parámetro es obligatorio.	N/A	Si se define como True y el parámetro no se ha rellenado,se generará una excepción . El valor predeterminado es False.
print_value	{boolean}	Define si se debe registrar el valor obtenido del parámetro.	N/A	El valor predeterminado es False.

Devoluciones

El valor del parámetro, que es {string} de forma predeterminada, a menos que se especifique input_type.

Ejemplo

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)

Comportamiento resultante

Se devolverá el valor del parámetro seleccionado, convertido al tipo seleccionado.

Valor de resultado

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

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

Obtiene la marca de tiempo y la guarda en el contexto del caso.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
datetime_format	{boolean}	Formato de fecha y hora	True para obtener el formato de fecha y hora, False para Unix	False de forma predeterminada (opcional)
timezone	El parámetro ya no se admite
new_timestamp	{int}	La marca de tiempo que se va a guardar	N/A	Tiempo Unix de forma predeterminada (opcional)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Obtener la marca de tiempo guardada con save_timestamp.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
datetime_format	{boolean}	Si es True, devuelve la marca de tiempo como fecha y hora. De lo contrario, devuelve el valor en formato Unix.	Verdadero/Falso	False de forma predeterminada (opcional)
timezone	El parámetro ya no se admite

Devoluciones

Tiempo Unix o fecha y hora guardados.

get_connector_context_property

get_connector_context_property(identifier, property_key)

Obtiene una propiedad de contexto de conector.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
identificador	{string}	Identificador de contexto	N/A	N/A
property_key	{string}	La propiedad de clave solicitada	N/A	N/A

Devoluciones

{string} el valor de la propiedad

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)

Comprueba si la alerta se ha desbordado.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
entorno	{string}	Nombre del entorno	Ejemplo	N/A
alert_identifier	{string}	Identificador de alerta	12345	N/A
ingestion_time	{long}	Tiempo de ingestión de alertas	N/A	Si no se proporciona, se utiliza la hora actual (formato de hora Unix) de forma predeterminada.
original_file_path	{string}	Ruta al archivo que contiene los datos sin procesar originales de la alerta.	N/A	N/A
original_file_content	{string}	Contenido del archivo que contiene los datos sin procesar originales de la alerta.	N/A	N/A
alert_name	{string}	Nombre de la alerta	N/A	N/A
producto	{string}	Nombre del producto del dispositivo que ha generado la alerta	QRadar, Trellix ESM	N/A
source_ip	{string}	La dirección IP de origen asociada a la alerta.	198.51.100.1	N/A
source_host	{string}	La dirección del host de origen asociada a la alerta.	[e-mail], source.example.com	N/A
destination_ip	{string}	Dirección IP de destino asociada a la alerta	203.0.113.1	N/A
destination_host	{string}	Dirección del host de destino asociada a la alerta.	destination.example.com	N/A

Devoluciones

{boolean} True/False

Ejemplo

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)

Comportamiento resultante

True si la alerta se desbordará durante el proceso de ingestión. De lo contrario, False.

Valor de resultado

Verdadero/Falso

property is_test_run

property log_location

Parámetros de propiedad

return_package

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

Datos devueltos.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
cases	{[CaseInfo]}	Lista de objetos CaseInfo	N/A	N/A
output_variables				Obsoleto
log_items				Obsoleto

Devoluciones

NoneType

Ejemplo

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

Valor de resultado

Ninguno

return_test_result

return_test_result(is_success, result_params_dictionary)

Obsoleto: la función está obsoleta.

property run_folder

Crea el run_folder en función del nombre de la secuencia de comandos.

Devoluciones

Ruta completa de {string}

Valor de resultado

C:Siemplify_ServerScriptingSiemplifyAction<script name>

save_timestamp

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

Guarda la marca de tiempo en el contexto de la secuencia de comandos actual.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
datetime_format	{boolean}	N/A	True para el formato de fecha y hora, False para Unix	El valor predeterminado es False (opcional).
timezone	El parámetro ya no se admite
new_timestamp	{long}	Marca de tiempo que se guardará en el contexto	N/A	La marca de tiempo es, de forma predeterminada, la marca de tiempo de Unix de la llamada al método.

set_connector_context_property

set_connector_context_property(identifier, property_key, property_value)

Define una propiedad de contexto de caso mediante el par clave-valor.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Posibles valores	Comentarios
identificador	{string}	Identificador de contexto	N/A	N/A
property_key	{string}	Clave de la propiedad	N/A	N/A
property_value	{string}	Valor de la propiedad	N/A	N/A

property whitelist