Módulo SiemplifyJob

class SiemplifyJob.SiemplifyJob

Bases: Siemplify

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

Recebe um parâmetro de configuração da instância de integração.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
param_name	{string}	Nome do parâmetro a ser buscado	N/A	N/A
default_value	{any}	O valor padrão do parâmetro		(Opcional) O valor especificado será retornado se o parâmetro não tiver sido definido (se "is_mandatory" estiver definido como False). None por padrão
input_type	{obj}	O tipo do parâmetro	N/A	(Opcional) O valor retornado será convertido para o tipo de entrada selecionado. {str} por padrão
is_mandatory	{boolean}	Define se o parâmetro é obrigatório.	N/A	(Opcional) Se definido como "True" e o parâmetro não tiver sido preenchido, uma exceção será gerada. False por padrão
print_value	{boolean}	Define se o valor buscado do parâmetro será enviado aos registros.	N/A	(Opcional) False por padrão

Retorna

O valor do parâmetro, string por padrão, a menos que input_type seja especificado.

Exemplo

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)

Comportamento do resultado

O valor do parâmetro selecionado será retornado, 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=1683034181430)

Extraia o carimbo de data/hora e salve-o no contexto do caso.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
datetime_format	{boolean}	Formato de data/hora	True para obter no formato de data e hora, False para Unix	False por padrão (opcional)
timezone	O parâmetro não é mais compatível
new_timestamp	{int}	O carimbo de data/hora a ser salvo	N/A	Tempo Unix epoch por padrão (opcional)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Receba o carimbo de data/hora salvo com save_timestamp.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
datetime_format	{boolean}	Se True, retorne o carimbo de data/hora como data e hora. Caso contrário, retorne no Unix	Verdadeiro/Falso	False por padrão (opcional)
timezone	O parâmetro não é mais compatível

Retorna

Horário/data e hora do Unix salvos.

get_configuration

get_configuration(provider, environment=None, integration_instance=None)

Receba a configuração da integração.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
provider	{string}	Nome da integração	VirusTotal	O nome do provedor de integração diferencia maiúsculas de minúsculas. Um erro será gerado se a integração não estiver instalada ou se a string não existir.
ambiente	{string}	Configuração para um ambiente específico ou "all"	N/A	(Opcional) Se fornecidas, as credenciais serão recuperadas da configuração de ambiente correspondente. Se nenhum ambiente for declarado, o ambiente do caso será usado por padrão. Se não houver uma configuração para esse ambiente específico, a configuração padrão será retornada.
integration_instance	{string}	Identificador da instância de integração	N/A	N/A

Retorna

Detalhes da configuração {dict}

Exemplo

from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
siemplify.get_configuration(provider="VirusTotal", environment="")

Comportamento do resultado

Um dicionário com as credenciais salvas para a integração do Google Security Operations Marketplace será retornado.

Valor do resultado

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

Recebe todos os jobs de ETL que falharam no número especificado de horas.

Retorna

{dict} jobs com falha

{'Id':{string}, 'Name':{string}, 'Message':{string}, WorkflowId = {string}, CreationTime: {string}, CaseId:{string}}

get_failed_etljobs

get_failed_etljobs(number_of_hours)

Recebe todos os jobs de ETL que falharam no número especificado de horas.

Retorna

{dict} jobs com falha

{ 'Id': {string}, 'Name': {string}, Message: {string}, CreationTime: {string}}

get_faulted_connectors

get_faulted_connectors(start_unix_time, end_unix_time)

Receba todos os conectores que tiveram falha no período entre start_unix_time e end_unix_time.

Retorna

{dict} conectores com falha

Valor do resultado

{'Name': {string}, 'Message': {string}, 'CreationTime': {string}}

get_faulted_jobs

get_faulted_jobs(number_of_hours)

Recebe todos os jobs que falharam no número especificado de horas.

Retorna

{[dict]} jobs com falha

Valor do resultado

[{'Id': {long}, 'Name':{string}, 'Message':{string}, 'CreationTime':{string}}]

get_job_context_property

get_job_context_property(identifier, property_key)

Recebe um valor de contexto de job pela chave especificada.

Parâmetros

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

get_scoped_job_context_property

get_scoped_job_context_property(property_key)

Receba a propriedade de contexto do job com escopo usando o identificador exclusivo de um job.

Parâmetros

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

Retorna

Valor de uma chave específica.

get_system_info

get_system_info(start_time_unixtime_ms)

property log_location

save_publisher_logs

save_publisher_logs(records)

Salve registros de log do editor.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
registros	{list}	Registros a serem salvos	N/A	N/A

save_timestamp

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

Salvar carimbo de data/hora.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
datetime_format	{boolean}	N/A	True para formato de data e hora, False para Unix	O padrão é False (opcional)
timezone	O parâmetro não é mais compatível
new_timestamp	{long}	Marcação de tempo para salvar no contexto	N/A	O carimbo de data/hora padrão é o carimbo de data/hora do Unix de quando o método foi chamado.

send_mail

send_mail(subject, message, recipients, attachment_file_name, attachment_content)

Enviar um e-mail (com anexos).

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
subject	{string}	Assunto do e-mail	N/A	N/A
mensagem	{string}	Mensagem de e-mail	N/A	N/A
attachment_file_name	{string}	Nome do arquivo do anexo	N/A	N/A
destinatários	{[{string}]}	Lista de destinatários	N/A	N/A

set_job_context_property

set_job_context_property(identifier, property_key, property_value)

Defina a propriedade de contexto do job com escopo usando o identificador exclusivo de um job.

Parâmetros

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

set_scoped_job_context_property

set_scoped_job_context_property(property_key, property_value)

Defina a propriedade de contexto do job com escopo usando o identificador exclusivo de um job.

Parâmetros

Nome do parâmetro	Tipo do parâmetro	Definição	Valores possíveis	Comentários
property_key	{string}	A chave da propriedade de contexto do job.	N/A	N/A
property_value	{string}	O valor da propriedade de contexto do job.	N/A	N/A