AsBuiltReport.VMware.ESXi
v1.1.3
VMware ESXI AS Built Report es un módulo PowerShell que funciona junto con asBuiltReport.core.
AsbuiltReport es un proyecto comunitario de código abierto que utiliza PowerShell para producir documentación basada en múltiples formatos de documentos para múltiples proveedores y tecnologías.
El VMware ESXi como el módulo de informe construido se utiliza para generar como documentación construida para servidores ESXI VMware independientes.
Consulte el VMware vSphere AsBuiltReport para informar los entornos de servidor VSPhere / vCenter.
Consulte el sitio web de AsBuiltReport para obtener información más detallada sobre este proyecto.
A continuación se presentan las instrucciones sobre cómo instalar, configurar y generar un VMware ESXI como informe construido.
El informe VMware ESXI AS Built admite las siguientes versiones ESXI;
Las siguientes versiones de VMware ESXI ya no se están probando y/o compatibles;
Este informe es compatible con las siguientes versiones de PowerShell;
| Windows PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
PowerShell 5.1 o PowerShell 7, y los siguientes módulos de PowerShell son necesarios para generar un VMware ESXI como informe construido.
❗ Si no puede instalar .NET Core, debe establecer ShowCoverPageImage en False en el archivo de configuración del informe JSON.
Se requiere un usuario con privilegios raíz en el host ESXI para generar un VMware ESXi como informe construido.
Abra una ventana de terminal de PowerShell e instale cada uno de los módulos requeridos.
install-module VMware.PowerCLI - MinimumVersion 12.3 - AllowClobber
install-module AsBuiltReport.VMware.ESXiEl informe ESXI AS Built utiliza un archivo JSON para permitir la configuración de la información del informe, las opciones, los detalles y las cheques de salud.
Se puede generar un archivo de configuración del informe ESXI ejecutando el siguiente comando;
New-AsBuiltReportConfig - Report VMware.ESXi - Path < User specified folder > - Name < Optional >Ejecución de este comando Copiará la configuración de JSON del informe ESXi predeterminado a una carpeta especificada por el usuario.
Todas las configuraciones del informe se pueden configurar a través del archivo JSON.
A continuación se proporciona información sobre cómo configurar cada esquema dentro del archivo JSON del informe.
El esquema del informe proporciona la configuración de la información del informe ESXI
| Subpraso | Configuración | Por defecto | Descripción |
|---|---|---|---|
| Nombre | Usuario definido | VMware esxi como informe construido | El nombre del informe AS Built |
| Versión | Usuario definido | 1.0 | La versión del informe |
| Estado | Usuario definido | Liberado | El estado de la liberación del informe |
| ShowcoverPageImage | verdadero / falso | verdadero | Alternar para habilitar/deshabilitar la visualización de la imagen de la portada de la portada |
| Showheaderfooter | verdadero / falso | verdadero | Alternar para habilitar/deshabilitar encabezados de documentos y pies de página |
| ShowtableCaptions | verdadero / falso | verdadero | Alternar para habilitar/deshabilitar las subtítulos de la tabla/numeración |
El esquema de opciones permite que ciertas opciones dentro del informe se activen o desactiven
| Subpraso | Configuración | Por defecto | Descripción |
|---|---|---|---|
| Showlicensekeys | verdadero / falso | FALSO | Alternar para enmascarar/desenmascarar claves de licencia ESXi Clave de licencia enmascarada *****-*****-*****-56YDM-AS12K Clave de licencia desenmascarada AKLU4-PFG8M-W2D8J-56YDM-AS12K |
| Showvmsnapshots | verdadero / falso | verdadero | Alternar para habilitar/deshabilitar informes de instantáneas de VM |
El esquema infolel permite la configuración de cada sección del informe a nivel granular. Se pueden establecer las siguientes secciones
Hay 6 niveles (0-5) de granularidad detallada para cada sección de la siguiente manera;
| Configuración | Infolel | Descripción |
|---|---|---|
| 0 | Desactivado | No recopila ni muestra ninguna información |
| 1 | Habilitado / resumen | Proporciona información resumida para una colección de objetos |
| 2 | Resumen de adv | Proporciona información condensada y detallada para una colección de objetos |
| 3 | Detallado | Proporciona información detallada para objetos individuales |
| 4 | Adv detallado | Proporciona información detallada para objetos individuales, así como información para objetos asociados (hosts, clústeres, almacenes de datos, máquinas virtuales, etc.) |
| 5 | Integral | Proporciona información completa para objetos individuales, como la configuración de configuración avanzada |
La siguiente tabla describe la configuración de infolevel predeterminada y máxima para cada sección.
| Subpraso | Configuración predeterminada | Ajuste máximo |
|---|---|---|
| Vmhost | 3 | 5 |
| Red | 3 | 4 |
| Almacenamiento | 3 | 4 |
| VM | 3 | 4 |
El esquema HealthCheck se utiliza para alternar o desactivar los controles de salud.
El esquema VMHost se utiliza para configurar las verificaciones de salud para VMHosts.
| Subpraso | Configuración | Por defecto | Descripción | Destacar |
|---|---|---|---|---|
| ConnectionState | verdadero / falso | verdadero | Comprueba el estado de conexión VMHosts | Mantenimiento Desconectado |
| Hiperatria | verdadero / falso | verdadero | Destaca los vmhosts que tienen discapacitados de hyperThreading | HyperThreading discapacitado |
| Tabla de raspadía | verdadero / falso | verdadero | Resalta los vmhosts que están configurados con la ubicación de rascar predeterminada | La ubicación de Scratch es /TMP /Scratch |
| IPv6 | verdadero / falso | verdadero | Resalta los vmhosts que no tienen IPv6 habilitado | IPv6 deshabilitado |
| Repasados | verdadero / falso | verdadero | Destaca VMHosts con días de actividad superiores a 9 meses | 9 - 12 meses > 12 meses |
| Licencia | verdadero / falso | verdadero | Destaca los VMHosts que están utilizando licencias de evaluación de producción | Licencia de evaluación del producto en uso |
| Ssh | verdadero / falso | verdadero | Destacado si el servicio SSH está habilitado | Servicio TSM / TSM-SSH habilitado |
| Esxishell | verdadero / falso | verdadero | Destacado si el servicio ESXI Shell está habilitado | TSM / TSM-ESXISHELL Service habilitado |
| NTP | verdadero / falso | verdadero | Destacado si el servicio NTP se ha detenido o está deshabilitado en un VMHost | Servicio NTP detenido / deshabilitado |
| Storageadapter | verdadero / falso | verdadero | Destaca los adaptadores de almacenamiento que no están 'en línea' | El estado del adaptador de almacenamiento es 'desconocido' El estado del adaptador de almacenamiento está 'fuera de línea' |
| NetworkAdapter | verdadero / falso | verdadero | Destaca los adaptadores de red física que no están 'conectados' Destaca los adaptadores de red física que están 'inactivamente' | El adaptador de red está 'desconectado' El adaptador de red está 'inactivo' |
| LockdownMode | verdadero / falso | verdadero | Resalta los vmhosts que no tienen el modo de bloqueo habilitado | Modo de bloqueo deshabilitado |
El esquema del almacén de datos se utiliza para configurar las verificaciones de salud para los almacenes de datos.
| Subpraso | Configuración | Por defecto | Descripción | Destacar |
|---|---|---|---|---|
| Capacidadutilización | verdadero / falso | verdadero | Destaca los almacenes de datos con la utilización de la capacidad de almacenamiento por encima del 75% | 75 - 90% utilizado > 90% utilizado |
El esquema VM se utiliza para configurar las verificaciones de salud para máquinas virtuales.
| Subpraso | Configuración | Por defecto | Descripción | Destacar |
|---|---|---|---|---|
| Powerstate | verdadero / falso | verdadero | Resaltados las máquinas virtuales que están encendidas | VM está encendido |
| ConnectionState | verdadero / falso | verdadero | Destaca las máquinas virtuales que están huérfanas o inaccesibles | VM está huérfano o inaccesible |
| Cpuhotadd | verdadero / falso | verdadero | Destaca máquinas virtuales que tienen CPU Hot Add habilitado | CPU Hot Add habilitado |
| Cpuhotremove | verdadero / falso | verdadero | Destaca las máquinas virtuales que tienen la eliminación de CPU Hot habilitado | CPU Hot Retire habilitado |
| Memoryhotadd | verdadero / falso | verdadero | Destaca las máquinas virtuales que tienen la memoria Hot Add habilitado | Memory Hot Add habilitado |
| Chogblocktracking | verdadero / falso | verdadero | Destacados las máquinas virtuales que no tienen el seguimiento de bloques de cambio habilitado | Cambiar el seguimiento de bloques discapacitado |
| SPBMPOLICYCOMPLIO | verdadero / falso | verdadero | Destaca las máquinas virtuales que no cumplen con las políticas basadas en el almacenamiento | Se desconoce el cumplimiento de la política basado en el almacenamiento de VM es desconocido VM no cumple con las políticas basadas en el almacenamiento |
| Vmtoolsstatus | verdadero / falso | verdadero | Destaca las máquinas virtuales que no tienen herramientas de VM instaladas, están desactualizadas o no se están ejecutando | Herramientas de VM no instaladas, desactualizadas o no ejecutándose |
| VMSNAPSHOTS | verdadero / falso | verdadero | Destaca las máquinas virtuales que tienen instantáneas mayores de 7 días | VM Snapshot Age> = 7 días VM Snapshot Age> = 14 días |
# Generate an ESXi As Built Report for ESXi server 'esxi-01.corp.local' using specified credentials. Export report to HTML & DOCX formats. Use default report style. Append timestamp to report filename. Save reports to 'C:UsersTimDocuments'
PS C: > New-AsBuiltReport - Report VMware.ESXi - Target ' esxi-01.corp.local ' - Username ' root ' - Password ' VMware1! ' - Format Html , Word - OutputFolderPath ' C:UsersTimDocuments ' - Timestamp
# Generate an ESXi As Built Report for ESXi server 'esxi-01.corp.local' using specified credentials and report configuration file. Export report to Text, HTML & DOCX formats. Use default report style. Save reports to 'C:UsersTimDocuments'. Display verbose messages to the console.
PS C: > New-AsBuiltReport - Report VMware.ESXi - Target ' esxi-01.corp.local ' - Username ' root ' - Password ' VMware1! ' - Format Text , Html , Word - OutputFolderPath ' C:UsersTimDocuments ' - ReportConfigFilePath ' C:UsersTimAsBuiltReportAsBuiltReport.VMware.ESXi.json ' - Verbose
# Generate an ESXi As Built Report for ESXi server 'esxi-01.corp.local' using stored credentials. Export report to HTML & Text formats. Use default report style. Highlight environment issues within the report. Save reports to 'C:UsersTimDocuments'.
PS C: > $Creds = Get-Credential
PS C: > New-AsBuiltReport - Report VMware.ESXi - Target ' esxi-01.corp.local ' - Credential $Creds - Format Html , Text - OutputFolderPath ' C:UsersTimDocuments ' - EnableHealthCheck
# Generate a single ESXi As Built Report for ESXi servers 'esxi-01.corp.local' and 'esxi-02.corp.local' using specified credentials. Report exports to Word format by default. Apply custom style to the report. Reports are saved to the user profile folder by default.
PS C: > New-AsBuiltReport - Report VMware.ESXi - Target ' esxi-01.corp.local ' , ' esxi-02.corp.local ' - Username ' root ' - Password ' VMware1! ' - StylePath ' C:ScriptsStylesMyCustomStyle.ps1 '
# Generate an ESXi As Built Report for ESXi server 'esxi-01.corp.local' using specified credentials. Export report to HTML & DOCX formats. Use default report style. Reports are saved to the user profile folder by default. Attach and send reports via e-mail.
PS C: > New-AsBuiltReport - Report VMware.ESXi - Target ' esxi-01.corp.local ' - Username ' root ' - Password ' VMware1! ' - Format Html , Word - OutputFolderPath ' C:UsersTimDocuments ' - SendEmail
