Modul SiemplifyConnectors

class SiemplifyConnectors.SiemplifyConnectorExecution

SiemplifyConnectors.SiemplifyConnectorExecution(mock_stdin=None)

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

Mendapatkan parameter skrip konektor.
Setiap konektor memiliki parameter yang diisi saat dikonfigurasi. Metode ini memungkinkan ekstraksi nilai parameter yang dipilih dari konektor yang sedang berjalan.\

Catatan: Konsep terkait: Konfigurasi integrasi dan parameter skrip

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
param_name	{string}	Nama parameter	T/A	T/A
default_value	{any}	Nilai default parameter.	T/A	(Opsional) Nilai yang diberikan akan ditampilkan jika parameter tidak ditetapkan (jika is_mandatory ditetapkan ke False). Defaultnya adalah Tidak Ada
input_type	{obj}	Jenis parameter. Misalnya, {int}	T/A	(Opsional) Nilai yang ditampilkan akan di-cast ke jenis input yang dipilih. Defaultnya adalah str
is_mandatory	{boolean}	Menentukan apakah parameter wajib diisi	T/A	Jika disetel ke True dan parameter tidak diisi, pengecualian akan ditampilkan. Defaultnya adalah False
print_value	{boolean}	Menentukan apakah akan menampilkan nilai parameter yang diambil ke log	T/A	Default-nya adalah False

Hasil

Nilai parameter, {string} secara default, kecuali jika input_type ditentukan.

Contoh

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)

Perilaku hasil

Nilai parameter yang dipilih akan ditampilkan, ditransmisikan ke jenis yang dipilih.

Nilai hasil

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

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

Ambil stempel waktu dan simpan ke konteks kasus.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
datetime_format	{boolean}	Format untuk tanggal/waktu	True untuk mendapatkan format tanggal dan waktu, False untuk Unix	False secara default (opsional)
zona waktu	Parameter tidak didukung lagi
new_timestamp	{int}	Stempel waktu yang akan disimpan	T/A	Waktu Unix secara default (opsional)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Dapatkan stempel waktu yang disimpan dengan save_timestamp.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
datetime_format	{boolean}	Jika True, menampilkan stempel waktu sebagai datetime. Jika tidak, tampilkan dalam Unix	Benar/Salah	Salah secara default (opsional)
zona waktu	Parameter tidak didukung lagi

Hasil

Waktu/tanggal dan waktu Unix yang disimpan.

get_connector_context_property

get_connector_context_property(identifier, property_key)

Mendapatkan properti konteks konektor.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
ID	{string}	ID konteks	T/A	T/A
property_key	{string}	Properti kunci yang diminta	T/A	T/A

Hasil

{string} nilai properti

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)

Periksa apakah notifikasi meluap.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
lingkungan	{string}	Nama lingkungan	Contoh	T/A
alert_identifier	{string}	ID notifikasi	12345	T/A
ingestion_time	{long}	Waktu penyerapan pemberitahuan	T/A	Jika tidak diberikan, defaultnya adalah waktu saat ini (format waktu Unix)
original_file_path	{string}	Jalur ke file yang berisi data mentah asli pemberitahuan	T/A	T/A
original_file_content	{string}	Konten file yang berisi data mentah asli pemberitahuan	T/A	T/A
alert_name	{string}	Nama notifikasi	T/A	T/A
produk	{string}	Nama produk untuk perangkat yang memicu notifikasi	QRadar, Trellix ESM	T/A
source_ip	{string}	Alamat IP sumber yang terkait dengan pemberitahuan	198.51.100.1	T/A
source_host	{string}	Alamat host sumber yang terkait dengan pemberitahuan	[e-mail], source.example.com	T/A
destination_ip	{string}	Alamat IP tujuan yang terkait dengan pemberitahuan	203.0.113.1	T/A
destination_host	{string}	Alamat host tujuan yang terkait dengan pemberitahuan	destination.example.com	T/A

Hasil

{boolean} Benar/Salah

Contoh

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)

Perilaku hasil

True jika pemberitahuan akan meluap selama proses penyerapan. Jika tidak, False.

Nilai hasil

Benar/Salah

property is_test_run

property log_location

Parameter properti

return_package

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

Menampilkan data.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
kasus	{[CaseInfo]}	Daftar objek CaseInfo	T/A	T/A
output_variables				Tidak digunakan lagi
log_items				Tidak digunakan lagi

Hasil

NoneType

Contoh

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

Nilai hasil

Tidak ada

return_test_result

return_test_result(is_success, result_params_dictionary)

Tidak digunakan lagi: Fungsi ini tidak digunakan lagi.

property run_folder

Buat run_folder berdasarkan nama skrip.

Hasil

Jalur lengkap {string}

Nilai hasil

C:Siemplify_ServerScriptingSiemplifyAction<script name>

save_timestamp

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

Simpan stempel waktu ke konteks skrip saat ini.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
datetime_format	{boolean}	T/A	True untuk format tanggal dan waktu, False untuk Unix	Default-nya adalah False (opsional)
zona waktu	Parameter tidak didukung lagi
new_timestamp	{long}	Stempel waktu untuk disimpan ke konteks	T/A	Stempel waktu default ke stempel waktu Unix saat memanggil metode

set_connector_context_property

set_connector_context_property(identifier, property_key, property_value)

Tetapkan properti konteks kasus menggunakan key-value pair.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
ID	{string}	ID konteks	T/A	T/A
property_key	{string}	Kunci properti	T/A	T/A
property_value	{string}	Nilai properti	T/A	T/A

properti whitelist