מודול SiemplifyConnectors
class SiemplifyConnectors.SiemplifyConnectorExecution
SiemplifyConnectors.SiemplifyConnectorExecution(mock_stdin=None)
בסיסים: 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)
קבלת פרמטר של סקריפט מחבר.
לכל מחבר יש פרמטרים שממלאים כשמגדירים אותו. השיטה הזו מאפשרת לחלץ את הערך של פרמטר נבחר של המחבר שפועל כרגע.\
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| param_name | {string} | שם הפרמטר | לא רלוונטי | לא רלוונטי |
| default_value | {any} | ערך ברירת המחדל של הפרמטר. | לא רלוונטי | (אופציונלי) הערך שיוחזר אם הפרמטר לא הוגדר (אם is_mandatory מוגדר כ-False).ברירת המחדל היא None |
| input_type | {obj} | סוג הפרמטר. לדוגמה, {int} | לא רלוונטי | (אופציונלי) הערך שמוחזר יומר לסוג הקלט שנבחר. ברירת המחדל היא str |
| is_mandatory | {boolean} | הגדרה של חובת הפרמטר | לא רלוונטי | אם הערך מוגדר ל-True והפרמטר לא מולא,יוצג חריג. ברירת המחדל היא False |
| print_value | {boolean} | הגדרה שקובעת אם ערך הפרמטר שאוחזר יופיע ביומנים | לא רלוונטי | ברירת המחדל היא False |
מחזירה
ערך הפרמטר, {string} כברירת מחדל, אלא אם מצוין input_type.
דוגמה
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)
התנהגות התוצאה
הערך של הפרמטר שנבחר יוחזר, ויומר לסוג שנבחר.
ערך התוצאה
C:\Siemplify_Server\Scripting\SampleJob\Logs
fetch_and_save_timestamp
fetch_and_save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181328)
שליפת חותמת הזמן ושמירתה בהקשר של הכרטיסייה.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| datetime_format | {boolean} | פורמט של תאריך ושעה | True for getting in datetime format,False for Unix |
False כברירת מחדל (אופציונלי) |
| אזור זמן | הפרמטר כבר לא נתמך | |||
| new_timestamp | {int} | חותמת הזמן לשמירה | לא רלוונטי | זמן יוניקס כברירת מחדל (אופציונלי) |
fetch_timestamp
fetch_timestamp(datetime_format=False, timezone=False)
קבלת חותמת הזמן שנשמרה עם save_timestamp.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| datetime_format | {boolean} | אם True, מחזירה את חותמת הזמן של החזרה כתאריך ושעה.אחרת, מחזירה את הערך בפורמט Unix |
נכון/לא נכון | False כברירת מחדל (אופציונלי) |
| אזור זמן | הפרמטר כבר לא נתמך | |||
מחזירה
זמן יוניקס או תאריך ושעה שנשמרו.
get_connector_context_property
get_connector_context_property(identifier, property_key)
קבלת מאפיין של הקשר של מחבר.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| מזהה | {string} | מזהה ההקשר | לא רלוונטי | לא רלוונטי |
| property_key | {string} | מאפיין המפתח המבוקש | לא רלוונטי | לא רלוונטי |
מחזירה
{string} ערך המאפיין
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)
בודקים אם ההתראה היא הצפה.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| environment | {string} | שם הסביבה | דוגמה | לא רלוונטי |
| alert_identifier | {string} | מזהה התראה | 12345 | לא רלוונטי |
| ingestion_time | {long} | זמן ההטמעה של ההתראה | לא רלוונטי | אם לא מציינים ערך, המערכת משתמשת כברירת מחדל בזמן הנוכחי (בפורמט זמן יוניקס) |
| original_file_path | {string} | הנתיב לקובץ שמכיל את הנתונים הגולמיים המקוריים של ההתראה | לא רלוונטי | לא רלוונטי |
| original_file_content | {string} | תוכן הקובץ שמכיל את הנתונים הגולמיים המקוריים של ההתראה | לא רלוונטי | לא רלוונטי |
| alert_name | {string} | שם ההתראה | לא רלוונטי | לא רלוונטי |
| מוצר | {string} | שם המוצר של המכשיר שיצר את ההתראה | QRadar, Trellix ESM | לא רלוונטי |
| source_ip | {string} | כתובת ה-IP של המקור שמשויכת להתראה | 198.51.100.1 | לא רלוונטי |
| source_host | {string} | כתובת המארח של המקור שמשויכת להתראה | source@example.com, source.example.com |
לא רלוונטי |
| destination_ip | {string} | כתובת ה-IP של היעד שמשויכת להתראה | 203.0.113.1 | לא רלוונטי |
| destination_host | {string} | כתובת המארח של היעד שמשויכת להתראה | destination.example.com | לא רלוונטי |
מחזירה
{boolean} True/False
דוגמה
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)
התנהגות התוצאה
True אם ההתראה תעבור את המכסה במהלך תהליך ההטמעה. אחרת,
False.
ערך התוצאה
נכון/לא נכון
property is_test_run
property log_location
פרמטרים של נכס
return_package
return_package(cases, output_variables={}, log_items=[])
החזרת נתונים.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| cases | {[CaseInfo]} | רשימת אובייקטים של CaseInfo | לא רלוונטי | לא רלוונטי |
| output_variables | הוצא משימוש | |||
| log_items | הוצא משימוש |
מחזירה
NoneType
דוגמה
from SiemplifyConnectors import SiemplifyConnectorExecution siemplify = SiemplifyConnectorExecution() siemplify.return_package(cases, output_variables, log_items)
ערך התוצאה
ללא
return_test_result
return_test_result(is_success, result_params_dictionary)
property run_folder
יוצרים את run_folder על סמך שם הסקריפט.
מחזירה
נתיב מלא {string}
ערך התוצאה
C:Siemplify_ServerScriptingSiemplifyAction<script name>
save_timestamp
save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181328)
שמירת חותמת הזמן בהקשר הנוכחי של הסקריפט.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| datetime_format | {boolean} | לא רלוונטי | True עבור פורמט של תאריך ושעה, False עבור Unix |
ברירת המחדל היא False (אופציונלי) |
| אזור זמן | הפרמטר כבר לא נתמך | |||
| new_timestamp | {long} | חותמת הזמן לשמירה בהקשר | לא רלוונטי | ברירת המחדל של חותמת הזמן היא חותמת הזמן של מערכת Unix שבה מופעלת השיטה |
set_connector_context_property
set_connector_context_property(identifier, property_key, property_value)
מגדירים מאפיין של הקשר של הפנייה באמצעות צמד מפתח/ערך.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| מזהה | {string} | מזהה ההקשר | לא רלוונטי | לא רלוונטי |
| property_key | {string} | המפתח של המאפיין | לא רלוונטי | לא רלוונטי |
| property_value | {string} | ערך המאפיין | לא רלוונטי | לא רלוונטי |