SiemplifyConnectors module

classe 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)

Obtenha um parâmetro do script do conetor.
Cada conetor tem parâmetros que são preenchidos quando é configurado. Este método permite extrair o valor de um parâmetro selecionado do conetor em execução atualmente.

Nota: conceitos relacionados: configuração da integração e parâmetros de script

Parâmetros

Nome do parâmetro	Tipo de parâmetro	Definição	Valores possíveis	Comentários
param_name	{string}	Nome do parâmetro	N/A	N/A
default_value	{any}	O valor predefinido do parâmetro.	N/A	(Opcional) O valor indicado é devolvido se o parâmetro não tiver sido definido (se is_mandatory estiver definido como False). A predefinição é Nenhum
input_type	{obj}	O tipo de parâmetro. Por exemplo, {int}	N/A	(Opcional) O valor devolvido é convertido no tipo de entrada selecionado. O valor predefinido é str
is_mandatory	{boolean}	Define se o parâmetro é obrigatório	N/A	Se estiver definido como True e o parâmetro não tiver sido preenchido, é gerada uma exceção. A predefinição é False
print_value	{boolean}	Define se o valor obtido do parâmetro deve ser apresentado nos registos	N/A	A predefinição é False

Devoluções

O valor do parâmetro, {string} por predefinição, a menos que input_type seja especificado.

Exemplo

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 dos resultados

O valor do parâmetro selecionado é devolvido, convertido para o tipo selecionado.

Valor do resultado

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

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

Obter a data/hora e guardá-la no contexto do registo.

Parâmetros

Nome do parâmetro	Tipo de parâmetro	Definição	Valores possíveis	Comentários
datetime_format	{boolean}	Formato de data/hora	True para obter no formato de data/hora, False para Unix	False por predefinição (opcional)
fuso horário	O parâmetro já não é suportado
new_timestamp	{int}	O carimbo de tempo a guardar	N/A	Tempo Unix por predefinição (opcional)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Obtenha a indicação de tempo guardada com o save_timestamp.

Parâmetros

Nome do parâmetro	Tipo de parâmetro	Definição	Valores possíveis	Comentários
datetime_format	{boolean}	Se True, devolve a data/hora como data/hora. Caso contrário, devolve no formato Unix	Verdadeiro/Falso	Falso por predefinição (opcional)
fuso horário	O parâmetro já não é suportado

Devoluções

Tempo/data e hora Unix guardados.

get_connector_context_property

get_connector_context_property(identifier, property_key)

Obtenha uma propriedade de contexto do conetor.

Parâmetros

Nome do parâmetro	Tipo de parâmetro	Definição	Valores possíveis	Comentários
identificador	{string}	Identificador de contexto	N/A	N/A
property_key	{string}	A propriedade da chave pedida	N/A	N/A

Devoluções

{string} o valor da propriedade

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)

Verifique se o alerta está em excesso.

Parâmetros

Nome do parâmetro	Tipo de parâmetro	Definição	Valores possíveis	Comentários
ambiente	{string}	Nome do ambiente	Exemplo	N/A
alert_identifier	{string}	Identificador do alerta	12345	N/A
ingestion_time	{long}	Hora da carregamento do alerta	N/A	Se não for fornecido, o valor predefinido é a hora atual (formato de hora Unix)
original_file_path	{string}	Caminho para o ficheiro que contém os dados não processados originais do alerta	N/A	N/A
original_file_content	{string}	Conteúdo do ficheiro que contém os dados não processados originais do alerta	N/A	N/A
alert_name	{string}	Nome do alerta	N/A	N/A
produto	{string}	O nome do produto do dispositivo que gerou o alerta	QRadar, Trellix ESM	N/A
source_ip	{string}	O endereço IP de origem associado ao alerta	198.51.100.1	N/A
source_host	{string}	O endereço do anfitrião de origem associado ao alerta	[e-mail], source.example.com	N/A
destination_ip	{string}	Endereço IP de destino associado ao alerta	203.0.113.1	N/A
destination_host	{string}	Endereço do anfitrião de destino associado ao alerta	destination.example.com	N/A

Devoluções

{boolean} Verdadeiro/falso

Exemplo

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 dos resultados

True se o alerta vai ser excedido durante o processo de carregamento. Caso contrário, False.

Valor do resultado

Verdadeiro/Falso

property is_test_run

property log_location

Parâmetros de propriedade

return_package

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

Devolver dados.

Parâmetros

Nome do parâmetro	Tipo de parâmetro	Definição	Valores possíveis	Comentários
casos	{[CaseInfo]}	A lista de objetos CaseInfo	N/A	N/A
output_variables				Descontinuado
log_items				Descontinuado

Devoluções

NoneType

Exemplo

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

Valor do resultado

Nenhum

return_test_result

return_test_result(is_success, result_params_dictionary)

Descontinuado: a função foi descontinuada.

property run_folder

Crie o run_folder com base no nome do script.

Devoluções

Caminho completo de {string}

Valor do resultado

C:Siemplify_ServerScriptingSiemplifyAction<script name>

save_timestamp

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

Guarde a data/hora no contexto do script atual.

Parâmetros

Nome do parâmetro	Tipo de parâmetro	Definição	Valores possíveis	Comentários
datetime_format	{boolean}	N/A	True para o formato de data/hora False para o formato Unix	A predefinição é False (opcional)
fuso horário	O parâmetro já não é suportado
new_timestamp	{long}	Data/hora para guardar no contexto	N/A	A data/hora é predefinida como a data/hora Unix da chamada do método

set_connector_context_property

set_connector_context_property(identifier, property_key, property_value)

Defina uma propriedade de contexto de registo através do par de chave/valor.

Parâmetros

Nome do parâmetro	Tipo de parâmetro	Definição	Valores possíveis	Comentários
identificador	{string}	Identificador de contexto	N/A	N/A
property_key	{string}	Chave da propriedade	N/A	N/A
property_value	{string}	Valor da propriedade	N/A	N/A

propriedade whitelist