מודול SiemplifyJob
class SiemplifyJob.SiemplifyJob
בסיסים: Siemplify
נקודות קצה: 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)
קבלת פרמטר הגדרה ממופע השילוב.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| param_name | {string} | שם הפרמטר לאחזור | לא רלוונטי | לא רלוונטי |
| default_value | {any} | ערך ברירת המחדל של הפרמטר | (אופציונלי) הערך שצוין יוחזר אם הפרמטר לא הוגדר (אם is_mandatory מוגדר כ- False).None כברירת מחדל |
|
| input_type | {obj} | סוג הפרמטר | לא רלוונטי | (אופציונלי) הערך שמוחזר יומר לסוג הקלט שנבחר. {str} כברירת מחדל |
| is_mandatory | {boolean} | הגדרה של חובת הפרמטר | לא רלוונטי | (אופציונלי) אם הערך הוא True והפרמטר לא מולא, תופעל חריגה. False כברירת מחדל |
| print_value | {boolean} | הגדרה שקובעת אם להוציא את הערך שאוחזר של הפרמטר ליומנים. | לא רלוונטי | (אופציונלי)False כברירת מחדל |
מחזירה
ערך הפרמטר, מחרוזת כברירת מחדל, אלא אם מצוין input_type.
דוגמה
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)
התנהגות התוצאה
הערך של הפרמטר שנבחר יוחזר, ויומר לסוג שנבחר.
ערך התוצאה
C:\Siemplify_Server\Scripting\SampleJob\Logs
fetch_and_save_timestamp
fetch_and_save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)
שליפת חותמת הזמן ושמירתה בהקשר של הכרטיסייה.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| 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_configuration
get_configuration(provider, environment=None, integration_instance=None)
אחזור הגדרת השילוב.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| ספק | {string} | שם השילוב | VirusTotal | שם ספק השילוב תלוי באותיות רישיות (case-sensitive). אם השילוב לא מותקן או אם המחרוזת לא קיימת, תוצג שגיאה. |
| environment | {string} | הגדרה לסביבה ספציפית או ל 'הכול' | לא רלוונטי | (אופציונלי) אם מציינים ערך, פרטי הכניסה יאוחזרו מהגדרת הסביבה המתאימה. אם לא מציינים סביבה,המערכת משתמשת בסביבת ברירת המחדל של המקרה. אם אין הגדרה לסביבה הספציפית הזו, המערכת תחזיר את הגדרת ברירת המחדל. |
| integration_instance | {string} | מזהה של מופע השילוב | לא רלוונטי | לא רלוונטי |
מחזירה
פרטי ההגדרות האישיות של {dict}
דוגמה
from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
siemplify.get_configuration(provider="VirusTotal", environment="")
התנהגות התוצאה
יוחזר מילון עם פרטי הכניסה השמורים לשילוב מ-Google Security Operations Marketplace.
ערך התוצאה
{
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)
קבלת כל משימות ה-ETL שנכשלו במספר השעות שצוין.
מחזירה
{dict} משימות שנכשלו
{'Id':{string}, 'Name':{string}, 'Message':{string}, WorkflowId = {string}, CreationTime: {string}, CaseId:{string}}
get_failed_etljobs
get_failed_etljobs(number_of_hours)
קבלת כל משימות ה-ETL שנכשלו במספר השעות שצוין.
מחזירה
{dict} משימות שנכשלו
{ 'Id': {string}, 'Name': {string}, Message: {string}, CreationTime: {string}}
get_faulted_connectors
get_faulted_connectors(start_unix_time, end_unix_time)
קבלת כל המחברים שהמחיקה שלהם נכשלה בין התאריכים start_unix_time ו-end_unix_time.
מחזירה
מחברים שנכשלו: {dict}
ערך התוצאה
{'Name': {string}, 'Message': {string}, 'CreationTime': {string}}
get_faulted_jobs
get_faulted_jobs(number_of_hours)
קבלת כל המשימות שנכשלו במספר השעות שצוין.
מחזירה
{[dict]} משימות שנכשלו
ערך התוצאה
[{'Id': {long}, 'Name':{string}, 'Message':{string}, 'CreationTime':{string}}]
get_job_context_property
get_job_context_property(identifier, property_key)
קבלת ערך של הקשר של המשימה לפי המפתח הנתון.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| מזהה | {string} | מזהה ההקשר | לא רלוונטי | לא רלוונטי |
| property_key | {string} | המפתח של המאפיין שיש לאחזר | לא רלוונטי | לא רלוונטי |
get_scoped_job_context_property
get_scoped_job_context_property(property_key)
קבלת מאפיין של הקשר של משימה בהיקף מסוים באמצעות המזהה הייחודי של המשימה.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| property_key | {string} | המפתח של מאפיין ההקשר של המשימה | לא רלוונטי | לא רלוונטי |
מחזירה
הערך של מפתח ספציפי.
get_system_info
get_system_info(start_time_unixtime_ms)
מאפיין log_location
save_publisher_logs
save_publisher_logs(records)
שמירת רשומות ביומן של בעל האתר.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| רשומות | {list} | רשומות לשמירה | לא רלוונטי | לא רלוונטי |
save_timestamp
save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)
שומרים את חותמת הזמן.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| datetime_format | {boolean} | לא רלוונטי | True לתאריך ושעה, False לזמן יוניקס |
ברירת המחדל היא False (אופציונלי) |
| אזור זמן | הפרמטר כבר לא נתמך | |||
| new_timestamp | {long} | חותמת הזמן לשמירה בהקשר | לא רלוונטי | ברירת המחדל של חותמת הזמן היא חותמת הזמן של מערכת Unix שבה מופעלת השיטה |
send_mail
send_mail(subject, message, recipients, attachment_file_name, attachment_content)
שליחת אימייל (מותר לצרף קבצים).
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| נושא | {string} | נושא האימייל | לא רלוונטי | לא רלוונטי |
| הודעה | {string} | תוכן הודעת האימייל | לא רלוונטי | לא רלוונטי |
| attachment_file_name | {string} | שם הקובץ המצורף | לא רלוונטי | לא רלוונטי |
| נמענים | {[{string}]} | רשימת הנמענים | לא רלוונטי | לא רלוונטי |
set_job_context_property
set_job_context_property(identifier, property_key, property_value)
הגדרת מאפיין של הקשר של משימה בהיקף מסוים באמצעות המזהה הייחודי של המשימה.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| מזהה | {string} | מזהה ההקשר | לא רלוונטי | לא רלוונטי |
| property_key | {string} | המפתח של מאפיין ההקשר של המשימה | לא רלוונטי | לא רלוונטי |
| property_value | {string} | הערך של מאפיין ההקשר של המשרה | לא רלוונטי | לא רלוונטי |
set_scoped_job_context_property
set_scoped_job_context_property(property_key, property_value)
הגדרת מאפיין של הקשר של משימה בהיקף מסוים באמצעות המזהה הייחודי של המשימה.
פרמטרים
| שם הפרמטר | סוג הפרמטר | הגדרה | ערכים אפשריים | תגובות |
|---|---|---|---|---|
| property_key | {string} | המפתח של מאפיין ההקשר של המשימה | לא רלוונטי | לא רלוונטי |
| property_value | {string} | הערך של מאפיין ההקשר של המשרה | לא רלוונטי | לא רלוונטי |