AsBuiltReport.VMware.ESXi
v1.1.3
VMware ESXI As erstellte Bericht ist ein PowerShell -Modul, das in Verbindung mit AsbuilTeport.core funktioniert.
AsbuilTreport ist ein Open-Sourcing-Community-Projekt, bei dem PowerShell zur Erstellung von Dokumentationen in mehreren Dokumentenformaten für mehrere Anbieter und Technologien verwendet wird.
Das VMware ESXI als erstellte Berichtsmodul wird verwendet, um als erstellte Dokumentation für eigenständige VMware ESXi -Server zu generieren.
In der VMware vSphere AsbuilTreport finden Sie die Berichterstattung über VMware vSphere / vCenter Server -Umgebungen.
Weitere Informationen zu diesem Projekt finden Sie auf der AsbuilTerport -Website.
Nachfolgend finden Sie die Anweisungen zum Installieren, Konfigurieren und Generieren eines VMware ESXI als erstellten Bericht.
Der VMware ESXI als erstellter Bericht unterstützt die folgenden ESXi -Versionen.
Die folgenden VMware -ESXi -Versionen werden nicht mehr getestet und/oder unterstützt.
Dieser Bericht ist mit den folgenden PowerShell -Versionen kompatibel.
| Windows PowerShell 5.1 | Powershell 7 |
|---|---|
| ✅ | ✅ |
PowerShell 5.1 oder PowerShell 7 und die folgenden PowerShell -Module sind erforderlich, um einen VMware ESXI als erstellten Bericht zu generieren.
❗ Wenn Sie .NET Core nicht installieren können, müssen Sie ShowCoverPageImage in der JSON -Konfigurationsdatei von Bericht JSON auf False festlegen.
Ein Benutzer mit Root -Berechtigungen auf dem ESXi -Host muss ein VMware ESXI als erstellter Bericht generieren.
Öffnen Sie ein PowerShell -Terminalfenster und installieren Sie jedes der erforderlichen Module.
install-module VMware.PowerCLI - MinimumVersion 12.3 - AllowClobber
install-module AsBuiltReport.VMware.ESXiDer ESXI AS erstellte Bericht verwendet eine JSON -Datei, um die Konfiguration von Berichtsinformationen, Optionen, Details und HealthChecks zu ermöglichen.
Eine ESXi -Berichtskonfigurationsdatei kann durch Ausführen des folgenden Befehls generiert werden.
New-AsBuiltReportConfig - Report VMware.ESXi - Path < User specified folder > - Name < Optional >Durch Ausführen dieses Befehls kopiert der Standard -ESXi -Bericht JSON -Konfiguration in einen von Benutzer angegebenen Ordner.
Alle Berichtseinstellungen können dann über die JSON -Datei konfiguriert werden.
Das Folgende enthält Informationen, wie Sie jedes Schema in der JSON -Datei des Berichts konfigurieren.
Das Berichtsschema bietet eine Konfiguration der ESXi -Berichtsinformationen
| Unterschema | Einstellung | Standard | Beschreibung |
|---|---|---|---|
| Name | Benutzer definiert | VMware ESXI als erstellter Bericht | Der Name des als erstellten Berichts |
| Version | Benutzer definiert | 1.0 | Die Berichtsversion |
| Status | Benutzer definiert | Freigegeben | Der Status der Berichtsfreigabe |
| ShowcoverpageImage | wahr / falsch | WAHR | Umschalten, um die Anzeige des Abdeckseite Bilds zu aktivieren/zu deaktivieren |
| Showheaderfoter | wahr / falsch | WAHR | Umschalten, um Dokumente und Fußzeilen zu aktivieren/zu deaktivieren |
| ShowtableCaptions | wahr / falsch | WAHR | Umschalten, um Tabellenunterschriften/Nummerierung zu aktivieren/zu deaktivieren |
Mit dem Optionsschema können bestimmte Optionen innerhalb des Berichts ein- oder ausgeschaltet werden
| Unterschema | Einstellung | Standard | Beschreibung |
|---|---|---|---|
| Showlicensekeys | wahr / falsch | FALSCH | Umschalten, um die ESXi -Lizenzschlüssel zu maskieren/zu entlarven Maskierter Lizenzschlüssel *****-*****-*****-56YDM-AS12K Entlarved Lizenzschlüssel AKLU4-PFG8M-W2D8J-56YDM-AS12K |
| Showvmsnapshots | wahr / falsch | WAHR | Umschalten, um die Berichterstattung von VM -Schnappschüssen zu aktivieren/zu deaktivieren |
Das Infolvel -Schema ermöglicht die Konfiguration jedes Abschnitts des Berichts auf granularer Ebene. Die folgenden Abschnitte können festgelegt werden
Für jeden Abschnitt gibt es 6 Ebenen (0-5) Detailkörnchen wie folgt;
| Einstellung | Infolen | Beschreibung |
|---|---|---|
| 0 | Deaktiviert | Sammelt oder zeigt keine Informationen an oder zeigt diese an |
| 1 | Aktiviert / Zusammenfassung | Bietet zusammengefasste Informationen für eine Sammlung von Objekten |
| 2 | ADV -Zusammenfassung | Bietet kondensierte, detaillierte Informationen für eine Sammlung von Objekten |
| 3 | Detailliert | Bietet detaillierte Informationen für einzelne Objekte |
| 4 | Adv detailliert | Bietet detaillierte Informationen für einzelne Objekte sowie Informationen für zugehörige Objekte (Hosts, Cluster, Datenspeicher, VMs usw.). |
| 5 | Umfassend | Bietet umfassende Informationen für einzelne Objekte wie erweiterte Konfigurationseinstellungen |
Die folgende Tabelle beschreibt die Standard- und Maximum -Infolvel -Einstellungen für jeden Abschnitt.
| Unterschema | Standardeinstellung | Maximale Einstellung |
|---|---|---|
| Vmhost | 3 | 5 |
| Netzwerk | 3 | 4 |
| Lagerung | 3 | 4 |
| VM | 3 | 4 |
Das HealthCheck -Schema wird verwendet, um die Gesundheitsprüfungen ein- oder auszuschalten.
Das VMHost -Schema wird verwendet, um Gesundheitsprüfungen für VMHosts zu konfigurieren.
| Unterschema | Einstellung | Standard | Beschreibung | Highlight |
|---|---|---|---|---|
| ConnectionState | wahr / falsch | WAHR | Überprüft den Verbindungszustand von VMhosts | Wartung Getrennt |
| Hyperthreading | wahr / falsch | WAHR | Markiert VMhosts, die hyperthreading deaktiviert haben | Hyperthreading deaktiviert |
| Scratchlocation | wahr / falsch | WAHR | Markiert VMhosts, die mit dem Standard -Scratch -Speicherort konfiguriert sind | Kratzort ist /TMP /Scratch |
| IPv6 | wahr / falsch | WAHR | Markiert VMhosts, bei denen IPv6 nicht aktiviert ist | IPv6 deaktiviert |
| UPTIMEDAYS | wahr / falsch | WAHR | Markiert VMhosts mit mehr als 9 Monaten an Laufzeittagen | 9 - 12 Monate > 12 Monate |
| Lizenzierung | wahr / falsch | WAHR | Markiert VMhosts, die Produktionsbewertungslizenzen verwenden | Produktbewertungslizenz im Gebrauch |
| Ssh | wahr / falsch | WAHR | Highlights, ob der SSH -Dienst aktiviert ist | TSM / TSM-SSH-Dienst aktiviert |
| Esxishell | wahr / falsch | WAHR | Highlights, ob der ESXi -Shell -Dienst aktiviert ist | TSM / TSM-ESXISHELL-Service aktiviert |
| NTP | wahr / falsch | WAHR | Highlights, ob der NTP -Dienst gestoppt ist oder auf einem vmhost deaktiviert ist | NTP -Dienst gestoppt / deaktiviert |
| Storageadapter | wahr / falsch | WAHR | Markiert Speicheradapter, die nicht online sind | Der Status des Speicheradapters ist "unbekannt" Der Status des Speicheradapters ist "offline" |
| NetworkAdapter | wahr / falsch | WAHR | Markiert physische Netzwerkadapter, die nicht "verbunden" sind Markiert physische Netzwerkadapter, die "unten" sind | Netzwerkadapter ist "getrennt" Netzwerkadapter ist 'Down' |
| LockdownMode | wahr / falsch | WAHR | Markiert VMhosts, die keinen Sperrmodus aktivieren können | Sperrmodus deaktiviert |
Das Datenspeicherschema wird verwendet, um Gesundheitsprüfungen für Datenspeicher zu konfigurieren.
| Unterschema | Einstellung | Standard | Beschreibung | Highlight |
|---|---|---|---|---|
| Kapazitätsversorgung | wahr / falsch | WAHR | Markiert Datenspeicher mit Speicherkapazitätsauslastung über 75% | 75 - 90% verwendet > 90% verwendet |
Das VM -Schema wird verwendet, um Gesundheitsprüfungen für virtuelle Maschinen zu konfigurieren.
| Unterschema | Einstellung | Standard | Beschreibung | Highlight |
|---|---|---|---|---|
| Powerstate | wahr / falsch | WAHR | Markiert VMs, die ausgeschaltet sind | VM wird ausgeschaltet |
| ConnectionState | wahr / falsch | WAHR | Markiert VMs, die verwaiste oder unzugänglich sind | VM ist verwaiste oder unzugänglich |
| CPUHOTADD | wahr / falsch | WAHR | Markiert virtuelle Maschinen, die CPU -Hot -Add -Add aktiviert haben | CPU HOT ADD VERFAHRT |
| CpuhoTremove | wahr / falsch | WAHR | Markiert virtuelle Maschinen, bei denen CPU heiß entfernen kann | CPU Hot Entfernen aktiviert |
| MemoryHotadd | wahr / falsch | WAHR | Markiert VMs, die einen Speicher Hot Add -Add aktiviert haben | Speicher Hot Add aktiviert aktiviert |
| ChangeBlocktracking | wahr / falsch | WAHR | Markiert VMs, die keine Änderungsblock -Tracking aktiviert haben | Blockverfolgung deaktiviert ändern |
| SPBMPolicyCompliance | wahr / falsch | WAHR | Markiert VMs, die nicht den speicherbasierten Richtlinien entsprechen | VM Speicherbasierte Richtlinienkonformität ist unbekannt VM entspricht nicht den speicherbasierten Richtlinien |
| VMtoolStatus | wahr / falsch | WAHR | Markieren Sie virtuelle Maschinen, bei denen keine VM -Tools installiert sind, veraltet sind oder nicht ausgeführt werden | VM -Tools nicht installiert, veraltet oder nicht ausgeführt |
| Vmsnapshots | wahr / falsch | WAHR | Markiert virtuelle Maschinen mit Schnappschüssen, die älter als 7 Tage haben | VM Snapshot -Alter> = 7 Tage VM Snapshot -Alter> = 14 Tage |
# 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
