AsBuiltReport.VMware.ESXi
v1.1.3
VMware ESXi en tant que rapport construit est un module PowerShell qui fonctionne en conjonction avec asbuiltreport.core.
Asbuiltreport est un projet communautaire open source qui utilise PowerShell pour produire une documentation telle que construite dans plusieurs formats de documents pour plusieurs fournisseurs et technologies.
Le module VMware ESXi en tant que rapport de rapport construit est utilisé pour générer une documentation construite pour les serveurs VMware ESXi autonomes.
Veuillez vous référer à VMware vSphere Asbuiltreport pour la déclaration des environnements VMware vSphere / VCenter Server.
Veuillez vous référer au site Web d'Asbuiltreport pour des informations plus détaillées sur ce projet.
Vous trouverez ci-dessous les instructions sur la façon d'installer, configurer et générer un rapport VMware ESXi en tant que rapport construit.
Le rapport VMware ESXi en tant que Build prend en charge les versions ESXI suivantes;
Les versions VMware ESXI suivantes ne sont plus testées et / ou prises en charge;
Ce rapport est compatible avec les versions PowerShell suivantes;
| Windows PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
PowerShell 5.1 ou PowerShell 7, et les modules PowerShell suivants sont nécessaires pour générer un rapport VMware ESXi comme rapport.
❗ Si vous n'êtes pas en mesure d'installer .NET Core, vous devez définir ShowCoverPageImage sur False dans le fichier de configuration JSON du rapport.
Un utilisateur avec des privilèges root sur l'hôte ESXi est nécessaire pour générer un rapport VMware ESXi comme construit.
Ouvrez une fenêtre de terminal PowerShell et installez chacun des modules requis.
install-module VMware.PowerCLI - MinimumVersion 12.3 - AllowClobber
install-module AsBuiltReport.VMware.ESXiLe rapport ESXi en tant que construction utilise un fichier JSON pour permettre la configuration des informations de rapport, des options, des détails et des chèques de santé.
Un fichier de configuration du rapport ESXi peut être généré en exécutant la commande suivante;
New-AsBuiltReportConfig - Report VMware.ESXi - Path < User specified folder > - Name < Optional >L'exécution de cette commande copiera la configuration JSON du rapport ESXi par défaut dans un dossier spécifié par l'utilisateur.
Tous les paramètres de rapport peuvent ensuite être configurés via le fichier JSON.
Ce qui suit fournit des informations sur la façon de configurer chaque schéma dans le fichier JSON du rapport.
Le schéma de rapport fournit la configuration des informations du rapport ESXi
| Sous-schéma | Paramètre | Défaut | Description |
|---|---|---|---|
| Nom | Utilisateur défini | VMware ESXi en tant que rapport construit | Le nom du rapport AS construit |
| Version | Utilisateur défini | 1.0 | La version du rapport |
| Statut | Utilisateur défini | Libéré | L'état de la version du rapport |
| ShowcOverpageImage | Vrai / faux | vrai | Basculer pour activer / désactiver l'affichage de l'image de la page de couverture |
| Showheaderfooter | Vrai / faux | vrai | Bascule pour activer / désactiver les en-têtes de documents et les pieds de page |
| Showtablecaptions | Vrai / faux | vrai | Basculer pour activer / désactiver les légendes de la table / numérotation |
Le schéma d'options permet à certaines options du rapport d'être activées ou désactivées
| Sous-schéma | Paramètre | Défaut | Description |
|---|---|---|---|
| Showlicense Keys | Vrai / faux | FAUX | Basculer pour masquer / démasquer les clés de licence ESXi Clé de licence masquée ***** - ***** - ***** - 56YDM-AS12K Clé de licence non masquée Aklu4-pfg8m-w2d8j-56ydm-as12k |
| Showvmsnapshots | Vrai / faux | vrai | Basculer pour activer / désactiver les rapports des instantanés VM |
Le schéma de niveau d'infole permet la configuration de chaque section du rapport à un niveau granulaire. Les sections suivantes peuvent être définies
Il y a 6 niveaux (0-5) de granularité détaillée pour chaque section comme suit;
| Paramètre | Niveau d'infection | Description |
|---|---|---|
| 0 | Désactivé | Ne collecte ni n'affiche aucune information |
| 1 | Activé / Résumé | Fournit des informations résumées pour une collection d'objets |
| 2 | Résumé de l'ADV | Fournit des informations condensées et détaillées pour une collection d'objets |
| 3 | Détaillé | Fournit des informations détaillées pour les objets individuels |
| 4 | Adv détaillé | Fournit des informations détaillées pour les objets individuels, ainsi que des informations pour les objets associés (hôtes, clusters, codes de données, machines virtuelles, etc.) |
| 5 | Complet | Fournit des informations complètes pour les objets individuels, tels que les paramètres de configuration avancés |
Le tableau ci-dessous décrit les paramètres par défaut et maximum des niveaux d'infolét pour chaque section.
| Sous-schéma | Paramètre par défaut | Réglage maximum |
|---|---|---|
| Vmhost | 3 | 5 |
| Réseau | 3 | 4 |
| Stockage | 3 | 4 |
| Machine virtuelle | 3 | 4 |
Le schéma HealthCheck est utilisé pour activer ou désactiver les contrôles de santé.
Le schéma VMHOST est utilisé pour configurer les contrôles de santé des VMHosts.
| Sous-schéma | Paramètre | Défaut | Description | Souligner |
|---|---|---|---|---|
| ConnectionState | Vrai / faux | vrai | Vérifie l'état de connexion VMHOSTS | Entretien Déconnecté |
| Hyperthreading | Vrai / faux | vrai | Souligne les VMhosts qui ont un hyperthreading désactivé | Hyperthreading handicapé |
| Scatchlocation | Vrai / faux | vrai | Met en évidence les VMhosts qui sont configurés avec l'emplacement de rayure par défaut | L'emplacement de grattage est / tmp / scratch |
| Ipv6 | Vrai / faux | vrai | Souligne les VMhosts qui n'ont pas d'IPv6 activé | IPv6 désactivé |
| Uptimedays | Vrai / faux | vrai | Souligne les VMhosts avec des jours de disponibilité supérieurs à 9 mois | 9 - 12 mois > 12 mois |
| Licence | Vrai / faux | vrai | Souligne les VMhosts qui utilisent des licences d'évaluation de la production | Licence d'évaluation des produits utilisée |
| Ssh | Vrai / faux | vrai | Fait saillie si le service SSH est activé | Service TSM / TSM-SSH activé |
| Esxishell | Vrai / faux | vrai | Fait saillie si le service Shell Esxi est activé | Service TSM / TSM-Esxishell activé |
| NTP | Vrai / faux | vrai | Fait saillie si le service NTP s'est arrêté ou est désactivé sur un VMHOST | Le service NTP est arrêté / désactivé |
| Storageadapter | Vrai / faux | vrai | Met en évidence les adaptateurs de stockage qui ne sont pas «en ligne» | L'état de l'adaptateur de stockage est «inconnu» L'état de l'adaptateur de stockage est «hors ligne» |
| NetworkAdapter | Vrai / faux | vrai | Met en évidence les adaptateurs de réseau physique qui ne sont pas «connectés» Met en évidence les adaptateurs de réseau physique qui sont «en panne» | L'adaptateur réseau est «déconnecté» L'adaptateur réseau est «en panne» |
| Mode de verrouillage | Vrai / faux | vrai | Met en évidence les VMhosts qui n'ont pas de mode de verrouillage activé | Mode de verrouillage désactivé |
Le schéma de datastore est utilisé pour configurer les contrôles de santé pour les oreilles de données.
| Sous-schéma | Paramètre | Défaut | Description | Souligner |
|---|---|---|---|---|
| Capacité de capacité | Vrai / faux | vrai | Soutille les surfaces de données avec l'utilisation de la capacité de stockage de plus de 75% | 75 - 90% utilisé > 90% utilisés |
Le schéma VM est utilisé pour configurer les contrôles de santé des machines virtuelles.
| Sous-schéma | Paramètre | Défaut | Description | Souligner |
|---|---|---|---|---|
| Powerstate | Vrai / faux | vrai | Met en évidence les machines virtuelles qui sont éteintes | La machine virtuelle est éteinte |
| ConnectionState | Vrai / faux | vrai | Met en évidence des machines virtuelles qui sont orphelines ou inaccessibles | La machine virtuelle est orpheline ou inaccessible |
| Cpuhotadd | Vrai / faux | vrai | Met en évidence les machines virtuelles qui ont un ADD à chaud CPU activé | CPU Hot Add activé |
| Cpuhotremove | Vrai / faux | vrai | Met en évidence les machines virtuelles qui ont le CPU à chaud enlevé | CPU HOT REPLIAT Activé |
| MemoryHotAdd | Vrai / faux | vrai | Met en évidence les machines virtuelles qui ont une mémoire à chaud activée | Memory Hot Add activé |
| ChangeBlockTracking | Vrai / faux | vrai | Prise en évidence les machines virtuelles qui n'ont pas de suivi de blocage de changement activé | Modifier le suivi des blocs désactivé |
| SPBMPOLYCOMPLICY | Vrai / faux | vrai | Souligne les machines virtuelles qui ne sont pas conformes aux politiques basées sur le stockage | La conformité de la politique basée sur le stockage VM est inconnue VM ne respecte pas les politiques basées sur le stockage |
| Vmtoolsstatus | Vrai / faux | vrai | Prise en évidence les machines virtuelles qui n'ont pas d'installation d'outils de machine virtuelle, sont obsolètes ou ne fonctionnent pas | Outils de machines virtuelles non installées, obsolètes ou non en cours d'exécution |
| Vmsnapshots | Vrai / faux | vrai | Met en évidence des machines virtuelles qui ont des instantanés de plus de 7 jours | VM Snapshot Age> = 7 jours VM Snapshot Age> = 14 jours |
# 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
