modules
init_module
Descripción
Inicializa una plantilla de módulo con valores por defecto.
Parámetros
Nombre |
Tipo
|
Requerido
|
Descripción |
default_values
|
dict
|
Si
|
Módulo en formato dict |
Return
Tipo | Descripción |
dict | Módulo en formato XML |
Versión
- 1.0.0
Ejemplo
import pandoraPlugintools as pt
# Define default values to override the template values
default_module_values = {
"name": "HostAlive",
"type": "generic_proc",
"value": 1,
}
# Initialize a module template with default values
module_template = pt.modules.init_module(default_module_values)
# Print the initialized module template
print("Initialized Module Template:", module_template)
print_module
Descripción
Devuelve el módulo en formato XML.
Parámetros
Nombre |
Tipo
|
Requerido
|
Descripción |
module
|
dict
|
Si
|
Módulo en formato dict |
print_flag
|
bool
|
No
|
Con True muestra el XML del módulo en STDOUT |
Return
Tipo | Descripción |
str | Módulo en formato XML |
Versión
- 1.0.0
Ejemplo
import pandoraPlugintools as pt
# Define module data
module_data = {
"name": "HostAlive",
"type": "generic_proc",
"value": 1,
"desc": "Check if the host is alive",
}
# Print module data in XML format without printing to STDOUT
module_xml = pt.modules.print_module(module_data, print_flag=False)
print("Module XML:\n", module_xml)
init_log_module
Descripción
Inicializa una plantilla de módulo de logs con valores por defecto.
Parámetros
Nombre |
Tipo
|
Requerido
|
Descripción |
default_values
|
dict
|
Si
|
Módulo en formato dict |
Return
Tipo | Descripción |
dict | Módulo de logs en formato XML |
Versión
- 1.0.0
Ejemplo
import pandoraPlugintools as pt
# Define default values for the log module template
default_log_module_values = {
"source": "System",
"value": "The host is not accessible",
}
# Initialize a log module template with default values
log_module_template = pt.modules.init_log_module(default_log_module_values)
# Print the initialized log module template
print("Initialized Log Module Template:", log_module_template)
print_log_module
Descripción
Devuelve el módulo de logs en formato XML.
Parámetros
nombre |
tipo
|
descripción |
module
|
dict
|
Módulo en formato dict |
print_flag
|
bool
|
Si se utiliza muestra el XML de los módulos en STDOUT |
Return
tipo | descripción |
str | Módulo en formato XML |
Versión
- 1.0.0
Ejemplo
import pandoraPlugintools as pt
# Define log module data
log_module_data = {
"source": "System",
"value": "The host is not accessible",
}
# Print the log module in XML format
log_module_xml = pt.modules.print_log_module(log_module_data, print_flag=True)
# Print the generated log module XML
print("Log Module XML:\n", log_module_xml)