Modul soar_ops
TIPCommon.soar_ops.create_slo_message
TIPCommon.soar_ops.create_slo_message(slo: int, interval_days: Iterable[int], existing_comments: Iterable[str])
Mendapatkan pesan peringatan SLO berdasarkan interval waktu dan komentar yang ada.
Untuk parameter interval_days=[0, 1, 7, 14], fungsi mengirimkan pesan yang memperingatkan bahwa SLO akan dilanggar setelah jadwal berikutnya:
- 7-14 hari hingga waktu habis masa berlaku.
- 1-7 hari hingga waktu habis masa berlaku.
- Saat SLO dilanggar.
Jika komentar sudah dikirim dalam interval pelanggaran saat ini, tidak ada komentar baru yang ditampilkan (None ditampilkan).
| Parameter | |
|---|---|
slo |
intTanggal pelanggaran SLO dalam mikrodetik Unix (misalnya, 1_673_774_674_567) |
interval_days |
Iterable[int]Iterable yang berisi jumlah hari sejak peringatan pelanggaran waktu harus dikirim (misalnya, [0, 1, 3, 7, 14]) |
existing_comments |
Iterable[int]Komentar yang ada untuk memeriksa apakah komentar sudah dikirim. |
Meningkatkan
ValueError- Jika salah satu interval waktu negatif.
Hasil
Komentar akan ditampilkan jika ada. Jika tidak, None akan ditampilkan.
TIPCommon.soar_ops.get_clean_comment_body
TIPCommon.soar_ops.get_clean_comment_body(comment: str | CaseComment, prefix: str)
Menghapus awalan dari string komentar atau objek komentar.
| Parameter | |
|---|---|
comment |
str | CaseCommentString komentar atau objek komentar untuk menghapus awalan. |
prefix |
strAwalan yang akan dihapus. |
Meningkatkan
TypeError- Jika jenis komentar bukan str atau CaseComment.
Hasil
Komentar tanpa awalan.
Jenis hasil yang ditampilkan
str
TIPCommon.soar_ops.get_file
TIPCommon.soar_ops.get_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, identifier: str)→ bytes | None
Menampilkan konten file dalam byte.
Parameter
| Parameter | |
|---|---|
chronicle_soar |
ChronicleSOARObjek Google Security Operations SOAR SDK. |
identifier |
strID nama file beserta jalur lengkap. |
Hasil
Data byte ID yang diberikan.
Jenis hasil yang ditampilkan
bytes | None
TIPCommon.soar_ops.get_secops_mode
TIPCommon.soar_ops.get_secops_mode()→ str | None
Menampilkan variabel lingkungan SECOPS_MODE.
Hasil
Variabel lingkungan SECOPS_MODE.
Jenis hasil yang ditampilkan
str | None
TIPCommon.soar_ops.get_soar_case_comments
TIPCommon.soar_ops.get_soar_case_comments(chronicle_soar: SiemplifyAction | SiemplifyJob, case_id: str | int)
Menampilkan daftar objek komentar dari kasus, menggunakan ID-nya.
| Parameter | |
|---|---|
chronicle_soar |
SiemplifyAction | SiemplifyJobObjek SDK. |
case_id |
str | intID kasus yang komentarnya diambil. |
Hasil
Daftar objek komentar.
Jenis hasil yang ditampilkan
list[base.action.CaseComment]
TIPCommon.soar_ops.get_user_by_id
TIPCommon.soar_ops.get_user_by_id(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, user_id: str)→ UserProfileCard | None
Mendapatkan objek UserProfileCard dari ID pengguna.
Parameter
| Parameter | |
|---|---|
chronicle_soar |
ChronicleSOARObjek Google Security Operations SOAR SDK. |
user_id |
strID pengguna, misalnya |
Hasil
Objek pengguna jika ditemukan; jika tidak, None.
Jenis hasil yang ditampilkan
UserProfileCard | None
TIPCommon.soar_ops.get_users_profile_cards_with_pagination
TIPCommon.soar_ops.get_users_profile_cards_with_pagination(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, search_term: str = '', page_size: int = 20, filter_by_role: bool = False, filter_disabled_users: bool = False, filter_support_users: bool = False, fetch_only_support_users: bool = False, filter_permission_types: list[int] | None = None)→ list[UserProfileCard]
Mendapatkan semua kartu profil pengguna menggunakan penomoran halaman. Ukuran halaman berfungsi sebagai batas jumlah pengguna dalam setiap iterasi.
Parameter
| Parameter | |
|---|---|
chronicle_soar |
ChronicleSOARObjek Google Security Operations SOAR SDK. |
search_term |
strIstilah penelusuran. Nilai defaultnya adalah |
page_size |
intJumlah pengguna yang akan ditampilkan. Nilai defaultnya adalah |
filter_by_role |
boolTentukan apakah akan memfilter menurut peran. Nilai defaultnya adalah |
filter_disabled_users |
boolTentukan apakah akan memfilter pengguna yang dinonaktifkan. Nilai defaultnya adalah |
filter_support_users |
boolTentukan apakah akan memfilter pengguna dukungan. Nilai defaultnya adalah |
fetch_only_support_users |
boolMenentukan apakah hanya pengguna dukungan yang akan ditampilkan. Nilai defaultnya adalah |
filter_permission_types |
list[int] | NoneDaftar jenis izin filter (misalnya, Nilai defaultnya adalah |
Hasil
Daftar semua pengguna.
Jenis hasil yang ditampilkan
list[UserProfileCard]
TIPCommon.soar_ops.is_slo_comment
TIPCommon.soar_ops.is_slo_comment(comment: str)
Memeriksa apakah komentar adalah komentar peringatan SLO.
Komentar SLO berupa peringatan SLO ("SLO akan dilanggar dalam {int} hari") atau pesan pelanggaran SLO ("SLO dilanggar").
| Parameter | |
|---|---|
comment |
strKomentar yang akan diperiksa. |
Hasil
True jika komentar adalah komentar SLO. Jika tidak, False akan ditampilkan.
Jenis hasil yang ditampilkan
bool
TIPCommon.soar_ops.remove_prefix_from_comments
TIPCommon.soar_ops.remove_prefix_from_comments(comments: list[str], prefix: str)
Menghapus awalan (jika ada) dari daftar komentar.
| Parameter | |
|---|---|
comments |
list[str]Komentar untuk menghapus awalan. |
prefix |
strAwalan yang akan dihapus. |
Hasil
Daftar semua komentar setelah awalan dihapus dari komentar tersebut
Jenis hasil yang ditampilkan
list[str]
TIPCommon.soar_ops.save_file
TIPCommon.soar_ops.save_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, path: str, name: str, content: bytes)→ bytes | None
Menyimpan file ke bucket Google Cloud atau jalur lokal.
Parameter
| Parameter | |
|---|---|
chronicle_soar |
ChronicleSOARObjek Google Security Operations SOAR SDK. |
path |
strJalur folder tempat file harus disimpan. |
name |
strNama file yang akan disimpan. |
content |
bytesKonten file dalam format byte. |
Hasil
Jalur ke file yang didownload.
Jenis hasil yang ditampilkan
str | None
Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.