AsBuilt Reports
AsBuilt Reports

AsBuilt Reports

Hola a tod@s

Debido al buen recibimiento del post que realice sobre «Rvtools analyzer«, esta vez les traigo otra herramienta muy interesante. Vamos a ver de qué se trata esta.

As Built Report es una herramienta » marco de documentos de configuración» el cual usa Microsoft PowerShell y PScribo para generar y construir informes en formatos HTML, XML, texto y MS Word.

As Built Report es un proyecto de código abierto desarrollado principalmente para los profesionales de TI que les permite producir fácilmente documentación de configuración «as built» que es clara y consistente, a través de múltiples proveedores de TI y tecnologías.

Esta herramienta nos permite a los usuarios ejecutar y generar fácilmente informes de nuestros entornos TI, y proporciona la capacidad de crear nuevos informes para cualquier proveedor de TI y/o tecnología que soporte PowerShell y/o una API RESTful.

Con esta herramienta podremos crear reportes para tecnologías como:

  • VMware vSphere
  • VMware NSX
  • Cisco UCS Manager
  • Nutanix
  • Pure Storage
  • Rubrik

Además se encuentran en desarrollo, para próximas actualizaciones:

  • Zento
  • VMware vCenter SRM
  • VXRAIL
  • Cohesity
  • Kaminario
  • y muchos más

Características de As Built Report

As Built Report proporciona las siguientes características:

  • El diseño modular permite a los colaboradores una forma sencilla de desarrollar nuevos informes.
  • Instalar y actualizar toda la biblioteca de informes o cada informe individualmente, a través de la Galería de PowerShell.
  • Generar informes en uno o más formatos de documento, incluidos DOCX, HTML y texto.
  • Configurar el nivel de detalle para cada sección de un informe. Existe la opción de elaborar un informe resumido, un informe completo o algo intermedio.
  • Compatibilidad con estilos personalizados: Es posible establecer la orientación de la página, el texto y el formato de tabla con fuentes, colores, bordes y celdas y filas resaltadas.
  • Habilitar las comprobaciones de estado para resaltar los problemas de configuración dentro de un informe. Activar o desactivar las comprobaciones de estado individuales según sea necesario.
  • Anexar la hora y la fecha a los informes para mantener los registros.
  • Adjuntar y enviar informes por correo electrónico a uno o más destinatarios.

Compatibilidad con Windows PowerShell

No todas las versiones disponibles son compatibles con los módulos utilizables de la herramienta.

Instalación y configuración de As Built Report

Para poder instalar As Built Report tendremos que iniciar Windows PowerShell. En mi caso lo abriré como administrador.

Lo primero que realizaremos es comprobar si estamos ejecutando Windows PowerShell 5.1 o posterior, con el comando:

  • $PSVersionTable

Para poder instalar As Built Report, tendremos que instalar el módulo  o cmdlets de PowerShell de 3rd party.

Como ejemplo podremos instalar: VMware PowerCLI, Cisco UCS PowerTool, Pure Storage PowerShell SDK.

  • Install-Module -Name VMware.PowerCLI
  • Install-Module -Name Cisco.UCS.Core
  • Install-Module -Name Cisco.UCSManager
  • Install-Module -Name PureStoragePowerShellSDK

Para esta demostración instalaremos el módulo de VMware PowerCLI.

Pulsamos Y.

Pulsamos Y.

Comenzará la instalación de los componentes necesarios.

Para una instalación en línea, instale los módulos de AsBuiltReport mediante la Galería PowerShell:

  • Install-Module -Name AsBuiltReport

Esperamos que termine de instalar los componentes necesarios.

Con el siguiente comando podemos ver la biblioteca completa de módulos disponibles:

  • Find-Module -Name AsBuiltReport.* -Repository PSGallery

Instalamos los siguientes módulos de vSphere con los siguientes comandos:

  • Install-Module -Name AsBuiltReport.Core
  • Install-Module -Name AsBuiltReport.VMware.vSphere
  • Install-Module -Name VMware.PowerCLI -MinimumVersion 10.0

Guardamos los módulos necesarios en una carpeta determinada (para poder usar el software en modo offline) con el siguiente comando:

  • Save-Module -Name AsBuiltReport.VMware.vSphere -Path ‘C:PathToSpecifiedFolder’

Ejecutamos el siguiente comando, en caso que queramos evitar problemas con los certificados.

  • Set-PowerCLIConfiguration -InvalidCertificateAction Ignore

Ahora vamos a lo interesante. Utilizando la siguiente sintaxis podemos crear nuestro primer reporte de nuestro ambiente vSphere.

  • New-AsBuiltReport -Report VMware.vSphere -Target vcenter.domain.local -Username administrator@vsphere.local -Password VMware1! -Format Word,Text -OutputFolderPath ‘C:Reports’ -EnableHealthCheck

Estos son algunos de los parámetros que podemos configurar (algunos son opcionales):

Enter the name of the Author for this As Built Report [Administrator]: [enter]

Would you like to enter Company information for the As Built Report? (y/n): y

Enter the Full Company Name: witcherIT

Enter the Company Short Name: WT

Enter the Company Contact: Alvaro M

Enter the Company Email Address: mail@mail.cl

Enter the Company Phone: xxxxxxxxxx

Enter the Company Address: Santiago xxx

Would you like to enter SMTP configuration? (y/n): n

Enter the full path of the folder to use for storing report configuration files and custom style scripts [C:UsersAdministratorAsBuiltReport]:  [enter]

Would you like to save the As Built Report configuration file? (y/n): y

Enter a name for the As Built Report configuration file [AsBuiltReport]: vSphere

Enter the path to save the As Built Report configuration file [C:UsersAdministratorAsBuiltReport]:  [enter]

Podemos ver más detalles de cada parámetro que podemos usar en la página de los creadores aquí.

Revisión del informe creado con As Built Report

Una vez que termine, podemos ver que se crearon los archivos en la carpeta que especificamos.

Abrimos el documento con MS Word, donde podremos navegar por este revisando la información recopilada de nuestro entorno. Les dejare unos pocos print para que se puedan hacer la idea de los datos que nos muestra este muy útil informe.

Ejemplo de detalles de datastores.

Puede que este informe se adecue o no a sus necesidades, pero es una muy buena opción si no tenemos un informe base el cual presentar a un cliente o para uso interno. Además que la herramienta nos permite poder editar los parámetros para obtener más o menos información, según sea necesario.

Los invito a darle una oportunidad a esta interesante herramienta. Solo queda agradecer a los creadores de esta, por ponerla a disposición de la comunidad.

Espero que esta información les haya sido útil. Si tienes dudas o alguna acotación sobre este post, déjalo en comentarios. Saludos.

Deja una respuesta

Tu dirección de correo electrónico no será publicada.