Saludos amigos, hace un tiempo que no os hablo de Veeam Availability Console, la herramienta perfecta para proveedores de servicios de Veeam, así como Enterprises que tengan múltiples localizaciones que se protegen usando productos de Veeam.
Ya os conté cómo instalar VAC, administrarlo y añadir tenants y mucho más, permitirme añadir la serie aquí:
Hoy os traigo una entrada muy interesante, y es cómo conectarnos y visualizar resultados usando la nueva RESTful API que Veeam Availability Console trae.
Veeam Availability Console RESTful API
Veeam Availability Console expone sus entidades a través de la API de servicio web basada en el estándard REST (Representational State Transfer) y Open Data Protocol (OData). Veeam Availability Console RESTful API permite a los desarrolladores comunicarse con Veeam Availability Console para consultar información sobre las entidades de Veeam Availability Console y realizar operaciones básicas con ellas utilizando solicitudes HTTPS y métodos HTTP. Podemos realizar la mayoría de las operaciones disponibles en la Web UI utilizando Veeam Availability Console RESTful API.
Veeam Availability Console RESTful API es una interfaz de programación de aplicaciones basada en recursos que utiliza el lenguaje de aplicación Hypertext Application Language (HAL). HAL expresa los recursos y las relaciones entre ellos como hipervínculos y permite la navegación a través de la API. Todos los recursos individuales tienen una representación JSON e identificadores de recursos del sistema, que ayudan a localizar un recurso por su URL. Los recursos del mismo tipo de entidad comprenden una colección. Una colección se modela como una matriz de objetos. Cada colección tiene hipervínculos que terminan con identificadores de recursos y apuntan a sus recursos individuales, recursos relacionados y colecciones.
Veeam Availability Console RESTful API se basa en el modelo cliente-servidor. El cliente realiza una petición al servidor. El servidor procesa la solicitud y devuelve una respuesta con un código de respuesta HTTP convencional, encabezados de respuesta HTTP y un cuerpo de respuesta en formato JSON.
Veeam Availability Console – vistazo rápido con Swagger UI
Para empezar a trabajar con Veeam Availability Console RESTful API, podemos utilizar cualquier aplicación cliente que admita el protocolo HTTPS.
Veeam Availability Console RESTful API está disponible adicionalmente a través de Swagger UI, una herramienta que podemos utilizar para evaluar y explorar las capacidades de Veeam Availability Console RESTful API. La interfaz de usuario de Swagger presenta visualmente los archivos de especificación de la API y nos permite trabajar con los recursos.
Todos los recursos y métodos son ampliables. Al desglosar un método, se obtiene una descripción completa de los parámetros disponibles y un ejemplo generado automáticamente. También podemos enviar solicitudes y ver mensajes de respuesta.
Para acceder a la interfaz de usuario Swagger para la API RESTful API de la consola de disponibilidad de Veeam:
En la barra de direcciones del navegador de Internet, escribiremos la URL de la RESTful API de Veeam Availability Convailability Console. https://IP:1281
En la página de destino, haremos clic en Swagger.
Una vez dentro de Swagger podemos movernos al siguiente paso.
Autenticación dentro de Swagger UI
Aunque veamos todos los métodos que podemos usar y despleguemos las operaciones de los mismos, no vamos a poder realizar nada sin antes autenticarnos, por lo que nos iremos hasta Accounts > Token introduciremos nuestro user y pass de VAC y haremos click en Try it out!
Prestaremos mucha atención a la respuesta, ya que hay varias cosas que tenemos que tener en cuenta:
- Access token: Este es el token que tendremos que usar en las aplicaciones con las que queramos explorar la VAC RESTAPI.
- Token Type: Bearer, a tener cuenta para mas tarde
- Refresh token: El token que podríamos usar para generar un nuevo token que nos conceda otro tiempo de conexión
- Response Code: Si el usuario y contraseña están correctos, el mensaje 200 es correcto, si introducimos un user y contraseña inválidos, aquí tendremos respuesta 400 o 401
Ejemplos de uso de Veeam Availability Console Swagger UI
Una vez que ya tenemos todo listo, tendremos que introducir el token en el campo superior derecho con el typo Bearer delante del token de la siguiente manera:
Con esto ya estaremos listos para usar los métodos y operaciones que nos brinda Veeam Availability Console RESTful API, por ejemplo, veamos el estado de los repositorios.
Nos iremos hasta BackupRepositories > usaremos el método GET de backupRepositories, del tipo application/json y haremos click en Try it out!
El resultado, que es en formato JSON, nos desvela los detalles que necesitamos de manera muy cómoda, por ejemplo en mi caso el Repositorio con ID 1010 llamado VEEAM, con capacidad de 400GB, con espacio libre de unos 300GB, se encuentra en formato OK y es de tipo Windows.
Si quisieramos explorar los Jobs, podríamos usar la categoría de Jobs y el método de GET jobs, y nos daría algo similar a esta imagen, donde podemos ver el nombre del Job, el estado del mismo, el tipo de trabajo, la última vez que se ejecutó, cuando tardó, processing rate, etc.
Si quisieramos explorar Usuarios, Tenants, y otro tipo de recursos que Veeam Availability Console tiene, sería tan sencillo como usar las diferentes categorías y métodos.
Eso es todo amigos, os dejo la serie completa de Veeam Availability Console por si os la perdistéis:
- Veeam Availability Console I – Teoría e información útil sobre el producto
- Veeam Availability Console II – Instalación de Veeam Availability Console
- Veeam Availability Console III – Configuración y conexión con VBR Server
- Veeam Availability Console IV – Administración centralizada de Veeam Backup Agents
- Veeam Availability Console V – Backup de Agentes a diferentes destinos, SMB, Repositorio Veeam o Cloud Connect
- Veeam Availability Console VI – Reportes de Backup de Veeam Agent y Veeam Backup and Replication
- Veeam: Veeam Availability Console, parte VII – Manejando la Facturación de Veeam Agents, Backup and Replication y Cloud Connect
Enlaces interesantes
Os dejo algunos enlaces que seguro os gustan:
- https://helpcenter.veeam.com/docs/vac/rest/overview.html?ver=20
- https://www.cragdoo.co.uk/2017/08/17/veeam-availability-console-api/
Leave a Reply