Veeam backup and replication plugin
Plugin para sacar datos de Veeam Backup replication
- Introducción
- Matriz de compatibilidad
- Pre requisitos
- Generar token
- Parámetros
- Ejecución manual
- Configuración en PandoraFMS
- Módulos generados por el plugin
Introducción
Ver. 04-02-2022
Con este plug-in podremos ver datos de nuestro entorno Veeam Backup como el ultimo backup realizado, los trabajos,etc.
Matriz de compatibilidad
Sistemas donde se ha probado |
CentOS 7, Fedora |
Sistemas donde debería funcionar |
Cualquier sistema linux o en windows ejecutandose en un agente software. |
Pre requisitos
Se requiere:
- Generar un token para la API de Veeam backup
- Python3
- Librería requests
Generar token
https://<hostname>:<port>/swagger/ui/index.html
* Port por defecto: 9419
En la página Veeam Backup & Replication REST API 1.0, expanda la sección Login y haga clic en POST api/oauth2/token.
En la ventana del método expandido, haz clic en Probar.
En la lista desplegable grant_type, seleccione password.
En los campos nombre de usuario y contraseña, especifique las credenciales de un usuario creado en Veeam Backup & Replication.
Haga clic en Ejecutar.
Espere la respuesta del servidor. Una operación completada con éxito devuelve el código de respuesta 200. En el cuerpo de la respuesta, Veeam Backup & Replication devuelve un token de acceso, su tiempo de caducidad y un token de actualización.
* Recuerda que la duración del token de acesso es de solo 15 minutos.
Parámetros
Parámetro | Descripción |
-u, --user | Usuario de Veeam |
-p, --password | Password de Veeam |
-i,--ip | ip de tu servidor veeam |
-p,--prefix | Prefijo para los agentes |
-g,--group | Grupo de destino de Pandora FMS (opcional) |
-a, --api_version | Version de la API |
--data_dir | Directorio de datos de Pandora FMS. Por defecto es /var/spool/pandora/data_in/ (opcional) |
--as_agent_plugin | Es opcional, si quieres que el plugin sea de agente y te meta los módulos en el agente de pandora, ejecuta esto con un 1 (opcional |
Ejecución manual
Podemos ejecutar el plugin manualmente para mostrar un xml con los datos por pantalla.
python3 pandora_veeam.py -i <ip with port> -u <user> -p <password> --as_agent_plugin 1
Configuración en PandoraFMS
La mejor forma de manejar plugins de servidor en Pandora es desde "/usr/share/pandora_server/util/plugin" asi que lo enviaremos esa ruta.
Después nos moveremos a la carpeta en la que lo hemos metido ( "/usr/share/pandora_server/util/plugin" es la recomendada").
Recuerda: Tienes que instalar las dependencias que necesita el módulo Requests en tu sistem
Como plugin de servidor
Iremos a servidores > plugins:
Pinchamos en añadir:
Le ponemos en nombre y la descripción que se prefiera:
Metemos como comando la ruta al plugin, y como parámetros los que hemos metido ejecutando el plugin, los campos "_field_" son macros definidas más abajo.
Ponemos por cada macro la descripción que se prefiera y como valor los datos de tu ip y token.
Una vez hecho esto, solo queda llamarlo por lo que iremos a la vista de algún agente y crearemos un módulo de complementos:
Una vez hecho esto, damos a crear.
Si el modulo se muestra con 1, quiere decir que se esta ejecutando correctamente
Le daremos un nombre y en el apartado "plugin" pondremos el que acabamos de configurar.
Como plugin de agente
Lo llamaremos en la última línea del conf del agente con el comando module_plugin , seguido de la ruta del plugin y de los parámetros utilizados.
module_plugin <path pandora_veaambackup.py> -i <ip> -t <token>
Esto también se puede hacer desde la consola si esta la configuración remota habilitada.
Módulos generados por el plugin
El plugin creara 3 agentes con varios módulos, el número de módulos depende de tu entorno de veeam ya que creara uno por cada trabajo creado por ejemplo.
Veeam_Backup_Replication-Services_and_configuration
Veeam_Backup_Replication-Sessions_servers_and_repositories
Veeam_Backup_Replication-Proxyes_and_jobs