discovery

Global variables

Descripción

Las siguientes variables pueden modificarse de modo global.

Nombre Descripción Valor por defecto
_ERROR_LEVEL
 Esta variable se utiliza para controlar el nivel de error. 0
_SUMMARY
 Este diccionario se utiliza para almacenar un sumario de elementos {}
_INFO
 Esta variable se utiliza para almacenar posibles errores en la ejecución ""
_MONITORING_DATA
 Esta lista se utiliza para almacenar elementos []

 

Para modificar las variables globales use la función :

set_disco_error_level

set_disco_summary

set_disco_info_value

set_disco_monitoring_data

Versión

set_disco_error_level

Descripción

Establece el nivel de error al valor especificado.

Parámetros

Nombre Tipo Requerido Descripción
value int Si El valor del nivel de error. Por defecto es 0

Return 

Tipo
None

Versión

Ejemplo

import pandoraPlugintools as pt

# Set the error level to 1
pt.discovery.set_disco_error_level(1)

# Your code continues here without error level checking
print("Error level has been set to 1. Continue processing...")

set_disco_summary

Descripción

Establecer valor fijo en el diccionario  '_SUMMARY'.

Versión

Ejemplo

import pandoraPlugintools as pt

# Create a sample data dictionary
sample_data = {
    'total_devices': 50,
    'active_devices': 30,
    'inactive_devices': 20
}

# Set the discovery summary using the sample data
pt.set_disco_summary(sample_data)

# Verify by printing the updated _SUMMARY
print(pt._SUMMARY)

set_disco_summary_value

Descripción

Establece un valor fijo para una clave del diccionario '_SUMMARY'.

Parámetros

Nombre  Tipo Requerido Descripción
key str Si Clave para la que se establece el valor
value any Si Valor a asignar a la clave

Return 

Tipo
None

Versión

Ejemplo

import pandoraPlugintools as pt

# Set a fixed value for a specific key in the discovery summary
pt.set_disco_summary_value('total_devices', 100)
pt.set_disco_summary_value('active_devices', 75)
pt.set_disco_summary_value('inactive_devices', 25)

# Verify by printing the updated _SUMMARY
print(pt._SUMMARY)

add_disco_summary_value

Descripción

Añade un valor a una clave del diccionario 'resumen'.

Si la clave ya existe, se incrementará el valor. En caso contrario, se creará una nueva clave.

Parámetros

Nombre Tipo Requerido Descripción
key str SI Clave a la que añadir el valor
value None SI Valor a añadir a la clave

Return 

Tipo
None

Versión

Ejemplo

import pandoraPlugintools as pt

# Add values to existing keys in the discovery summary
pt.set_disco_summary_value('total_devices', 100)
pt.set_disco_summary_value('active_devices', 75)
pt.set_disco_summary_value('inactive_devices', 25)

# Add values to existing keys using add_disco_summary_value function
pt.add_disco_summary_value('total_devices', 10)
pt.add_disco_summary_value('active_devices', 5)
pt.add_disco_summary_value('inactive_devices', 5)

# Add values to new keys using add_disco_summary_value function
pt.add_disco_summary_value('new_key', 50)

# Verify by printing the updated _SUMMARY
print(pt._SUMMARY)

set_disco_info_value

Descripción

Establece un valor fijo en la variable 'info'.

Parámetros

Nombre Tipo Requerido Descripción
value str Si El valor a establecer en la variable 'info'. Por defecto es una cadena vacía.

Return 

Tipo
None

Versión

Ejemplo

import pandoraPlugintools as pt

# Set a value to the _INFO variable
pt.set_disco_info_value("This is some information about the discovery.")

# Verify by printing the updated _INFO
print(discovery._INFO)

add_disco_info_value

Descripción

Añade datos a la variable 'info'.

Parámetros

Nombre Tipo Requerido Descripción
value str Si Los datos a añadir a la variable 'info'. Por defecto es una cadena vacía

Return 

Tipo
None

Versión

Ejemplo

import pandoraPlugintools as pt

# Add data to the _INFO variable
pt.add_disco_info_value("Additional information: ")
pt.add_disco_info_value("System status: OK")

# Verify by printing the updated _INFO variable
print(pt._INFO)

set_disco_monitoring_data

Descripción

Establecer un valor fijo en los datos de seguimiento

Parámetros

Nombre Tipo Requerido Descripción
data list Si Lista con los datos

Return 

Tipo
None

Versión

Ejemplo

import pandoraPlugintools as pt

# Example data for disk monitoring
disk_monitoring_data = [
    {'path': '/dev/sda1', 'usage': '75%'},
    {'path': '/dev/sdb1', 'usage': '42%'},
    {'path': '/dev/sdc1', 'usage': '90%'}
]

# Set the monitoring data for disk usage
pt.set_disco_monitoring_data(disk_monitoring_data)

# Verify by printing the updated _MONITORING_DATA variable
print(pt._MONITORING_DATA)

add_disco_monitoring_data

Descripción

Añadir valor a los datos de seguimiento

Parámetros

Nombre Tipo Requerido Descripción
data dict Si Diccionario con los datos

Return 

Tipo
None

Versión

Ejemplo

import pandoraPlugintools as pt

# Example data for disk monitoring to be added
new_disk_data = {'path': '/dev/sdd1', 'usage': '60%'}

# Add the new disk monitoring data to the global monitoring dataset
pt.add_disco_monitoring_data(new_disk_data)

# Verify by printing the updated _MONITORING_DATA variable
print(pt._MONITORING_DATA)

disco_output

Descripción

Imprime la salida JSON y sale del script.

Requisitos

Ejemplo

import pandoraPlugintools as pt
import sys  # Don't forget to import the sys module for the sys.exit() function

# Set values for _SUMMARY, _INFO, and _MONITORING_DATA (for demonstration purposes)
pt.set_disco_summary({'disk_usage': '80%'})
pt.set_disco_info_value('Disk usage information')
pt.add_disco_monitoring_data({'path': '/dev/sda1', 'usage': '70%'})

# Call the disco_output function to print JSON output and exit with a specific error level
pt.disco_output()