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 del conector.
Cada conector tiene parámetros que se completan cuando se configura. Este método permite extraer el valor de un parámetro seleccionado del conector que se está ejecutando actualmente.\

Nota: Conceptos relacionados: Parámetros de configuración y de secuencias de comandos de la integración

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	Comentarios
param_name	{string}	Nombre del parámetro	N/A	N/A
default_value	{any}	Es el valor predeterminado del parámetro.	N/A	(Opcional) Se devolverá el valor proporcionado si no se configuró el parámetro (si is_mandatory se establece en False). El valor predeterminado es None.
input_type	{obj}	El tipo del 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 configura como True y no se completó el parámetro, se generará una excepción. El valor predeterminado es False.
print_value	{boolean}	Define si se debe generar el valor recuperado del parámetro en los registros.	N/A	La cantidad predeterminada es False

Devoluciones

Valor del parámetro, {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 del resultado

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

Valor del resultado

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

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

Recupera la marca de tiempo y guárdala en el contexto del caso.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	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)
Zona horaria	El parámetro ya no se admite
new_timestamp	{int}	Sello de tiempo que se guardará	N/A	Tiempo Unix de forma predeterminada (opcional)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Obtén la marca de tiempo guardada con save_timestamp.

Parámetros

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

Devoluciones

Fecha y hora o hora Unix guardadas.

get_connector_context_property

get_connector_context_property(identifier, property_key)

Obtiene una propiedad de contexto del conector.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	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)

Verifica si la alerta se desbordó.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	Comentarios
entorno	{string}	Nombre del entorno	Ejemplo	N/A
alert_identifier	{string}	Identificador de alerta	12345	N/A
ingestion_time	{long}	Hora de transferencia de la alerta	N/A	Si no se proporciona, el valor predeterminado es la hora actual (formato de hora Unix).
original_file_path	{string}	Ruta de acceso 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 generó la alerta	QRadar, Trellix ESM	N/A
source_ip	{string}	Es la dirección IP de origen asociada a la alerta.	198.51.100.1	N/A
source_host	{string}	Es la dirección del host de origen asociada con la alerta.	[e-mail], source.example.com	N/A
destination_ip	{string}	Dirección IP de destino asociada con la alerta	203.0.113.1	N/A
destination_host	{string}	Dirección del host de destino asociada con la alerta	destination.example.com	N/A

Devoluciones

{boolean} Verdadero/falso

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 del resultado

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

Valor del resultado

Verdadero/Falso

property is_test_run

property log_location

Parámetros de propiedad

return_package

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

Devuelve datos.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	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 del resultado

Ninguno

return_test_result

return_test_result(is_success, result_params_dictionary)

Obsoleto: La función es obsoleta.

Carpeta de ejecución property

Compila el run_folder según el nombre de la secuencia de comandos.

Devoluciones

Ruta completa {string}

Valor del 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	Valores posibles	Comentarios
datetime_format	{boolean}	N/A	True para el formato de fecha y hora, False para Unix	El valor predeterminado es False (opcional).
Zona horaria	El parámetro ya no se admite
new_timestamp	{long}	Marca de tiempo para guardar en el contexto	N/A	La marca de tiempo se establece de forma predeterminada en 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)

Establece una propiedad de contexto del caso con el par clave-valor.

Parámetros

Nombre del parámetro	Tipo de parámetro	Definición	Valores posibles	Comentarios
identificador	{string}	Identificador de contexto	N/A	N/A
property_key	{string}	Es la clave de la propiedad.	N/A	N/A
property_value	{string}	Valor de la propiedad	N/A	N/A

property whitelist