##################################################### # # # Plugin information in English and Spanish. # # # # Información del plugin en Inglés y en Español. # # # ##################################################### ##################################### # Pandora Aruba Plugin (English) # ##################################### To load this plugin go to "Register plug-in" menu, select the ".pspz2" file and upload it. You will have then registered the plugin with the name "Pandora Aruba". Also, you will have new network components called "QNAP_TS-459_Pro_II_and_TS-809U_HdModel", "QNAP_TS-459_Pro_II_and_TS-809U_HdSmartInfo", "QNAP_TS-459_Pro_II_and_TS-809U_HdStatus", "QNAP_TS-459_Pro_II_and_TS-809U_HdTemperature", "QNAP_TS-459_Pro_II_and_TS-809U_sysVolumeFS", "QNAP_TS-459_Pro_II_and_TS-809U_sysVolumeFreeSize", "QNAP_TS-459_Pro_II_and_TS-809U_sysVolumeStatus" and "QNAP_TS-459_Pro_II_and_TS-809U_sysVolumeTotalSize". ############################# # Usage # ############################# This plugin allows you to discover all the SNMP choosen values for a given SNMP tree and automatically create modules for the discovered data. To do that is necesary to specify at least 7 obligatory parameters. There are 2 optional and 6 special parameters too. This plugin can be used as a plugin server module. If it execution goes fine, the plugin returns 1. If it execution have any problem (not enoguh parameters, wrong target, wrong OID base,...), the plugin returns 0. The modules generated by the plugin are created as data server modules, so if the plugin server module is deleted, all the generated modules won't receive new data. Obligatory parameters: - Agent name: The name of the agent where discovered modules will be created. If the agent doesn't exists, the plugin create the agent. By default it takes the _agent_ macro value. - Version: The SNMP version to use in the discovery. Can be 1, 2, 2c and 3. By default it takes 1. - Community: The SNMP community to use in the discovery. By default it takes public. - Host: The target of the SNMP discovery. The host need to have available SNMP checks from the server. By default it takes the _address_ macro value. - OID base: The base OID for the discovery. This is the common part of the OID for names tree and status tree. For example ".1.3.6.1.2.1.2.2.1". - Names tree: The OID base tree to give the name to modules. Using the above example, if names tree is ".1", the plugin will take the data of all OID from ".1.3.6.1.2.1.2.2.1.1" for the modules name, that is, the data of ".1.3.6.1.2.1.2.2.1.1.1", ".1.3.6.1.2.1.2.2.1.1.2", ".1.3.6.1.2.1.2.2.1.1.3", etc. - Status tree: The OID base tree to take the value of the modules. Using the above example, if status tree is ".2", the plugin will take the data of all OID from ".1.3.6.1.2.1.2.2.1.2" for the modules value, that is, the data of ".1.3.6.1.2.1.2.2.1.2.1", ".1.3.6.1.2.1.2.2.1.2.2", ".1.3.6.1.2.1.2.2.1.2.3", etc. Names tree and status tree are related, so if there is a module which name is the data of ".1.3.6.1.2.1.2.2.1.1.1", the module value would be the data of ".1.3.6.1.2.1.2.2.1.2.1". Optional parameters: - Modules name: Aditional information for the modules names. For example, if the data of a names tree OID is "1" (An interface index) and you set modules name as "Interface", the full name of the module would be "1 Interface". - Modules group: The group for the modules discovered. Special parameters: These parameters only work if you choose version 3. - Priv protocol: Set the privacy protocol name in this field. - Auth protocol: Set the authentication protocol in this field. - Context: Set the context name used for SNMPv3 messages. - Priv key: Enter the privacy password in this field. - Security level: Set the security level in this field. - Auth key: Enter the authentication password in this field. ############################# # Example # ############################# With these options, executing the plugin as a plugin server module, it would create modules in the same agent for each interface called " Interface" where could be 1, 2, 3, 4, etc. The values for these modules would be the description of each interface. - Agent name = _agent_ - Version = 1 - Community = public - Host = _address_ - OID base = .1.3.6.1.2.1.2.2.1 - Names tree = .1 - Status tree = .2 - Modules name = Interface ##################################### # Pandora Aruba Plugin (Español) # ##################################### Para cargar este plugin ve al menú "Registro plugin", elige el fichero ".pspz2" y subelo. Entonces tendrás registrado el plugin con el nombre "Pandora Aruba". Además, tendrás nuevos componentes de red llamados "QNAP_TS-459_Pro_II_and_TS-809U_HdModel", "QNAP_TS-459_Pro_II_and_TS-809U_HdSmartInfo", "QNAP_TS-459_Pro_II_and_TS-809U_HdStatus", "QNAP_TS-459_Pro_II_and_TS-809U_HdTemperature", "QNAP_TS-459_Pro_II_and_TS-809U_sysVolumeFS", "QNAP_TS-459_Pro_II_and_TS-809U_sysVolumeFreeSize", "QNAP_TS-459_Pro_II_and_TS-809U_sysVolumeStatus" y "QNAP_TS-459_Pro_II_and_TS-809U_sysVolumeTotalSize". ############################# # Uso # ############################# Este plugin te permite descubrir todos los valores SNMP elegidos de un arbol SNMP dado y automáticamente crear módulos para los datos descubiertos. Para hacer esto es necesario especificar al menos 7 parámetros obligatorios. También hay 2 parámetros opcionales y 6 especiales. Este plugin se puede usar como un modulo del servidor de plugins. Si la ejecución va bien, el plugin devuelve 1. Si la ejecución tiene algún problema (parámetros insuficientes, objetivo inválido, OID base inválido,...), el plugin devuelve 0. Los módulos generados por el plugin son creados como modulosdel servidor de datos, así que si el módulo del servidor de plugins es borrado, todos los módulos generados no recibirán nuevos datos. Parámetros obligatorios: - Agent name: El nombre del agente en el que se crearán los módulos descubiertos. Si el agente no existe, el plugin crea el agente. Por defecto toma el valor de la macro _agent_ . - Version: La version SNMP para usar en el descubrimiento. Puede ser 1, 2, 2c y 3. Por defecto toma la version 1. - Community: La comunidad SNMP para usar en el descubrimiento. Por defecto toma public. - Host: El objetivo del descubrimiento SNMP. El equipo necesita permitir los chequeos SNMP desde el servidor. Por defecto toma el valor de la macro _address_ . - OID base: El OID base para el descubrimieno. El la parte común de los OID para el arbol de nombres y el arbol de estado. Por ejemplo ".1.3.6.1.2.1.2.2.1". - Names tree: El arbol del OID base para dar nombre a los módulos. Usando el ejemplo anterior, si el arbol de nombres es ".1", el plugin tomara los datos de todos los OID a partir de ".1.3.6.1.2.1.2.2.1.1" para el nombre de los módulos, esto es, los datos de ".1.3.6.1.2.1.2.2.1.1.1", ".1.3.6.1.2.1.2.2.1.1.2", ".1.3.6.1.2.1.2.2.1.1.3", etc. - Status tree: El arbol del OID base para tomar el valor de los módulos. Usando el ejemplo anterior, si el arbol de estados es ".2", el plugin tomara los datos de todos los OID a partir de ".1.3.6.1.2.1.2.2.1.2" para el valor de los módulos, esto es, los datos de ".1.3.6.1.2.1.2.2.1.2.1", ".1.3.6.1.2.1.2.2.1.2.2", ".1.3.6.1.2.1.2.2.1.2.3", etc. El arbol de nombres y el arbol de estados están relacinados, así que si hay un módulo cuyo nombre es el dato de ".1.3.6.1.2.1.2.2.1.1.1", el valor del módulo sería el dato de ".1.3.6.1.2.1.2.2.1.2.1". Parámetros opcionales: - Modules name: Información adicional para los nombres de los módulos. Por ejemplo, si el dato de un OID del arbol de nombres es "1" (El indice de un interfaz) y estableces el nombre de los módulos como "Interface", el nombre completo del módulo sería "1 Interface". - Modules group: El grupo para los módulos descubiertos. Parámetros especiales: Estos parámetros solo funcionan si eliges version 3. - Priv protocol: Establece el protocolo de privacidad en este campo. - Auth protocol: Establece el protocolo de autentificación en este campo. - Context: Establece el nombre de contexto para mensajes SNMPv3. - Priv key: Introduce la contraseña de privacidad en este campo. - Security level: Establece el nivel de seguridad en este campo. - Auth key: Introduce la cntraseña de autentificación en este campo. ############################# # Ejemplo # ############################# Con estas opciones, ejecutando el plugin como un módulo del servidor de plugins, crearía modulos en el mismo agente para cada interfaz llamados " Interface" donde podría ser 1, 2, 3, 4, etc. Los valores para estos módulos serían las descripciones de cada interfaz. - Agent name = _agent_ - Version = 1 - Community = public - Host = _address_ - OID base = .1.3.6.1.2.1.2.2.1 - Names tree = .1 - Status tree = .2 - Modules name = Interface