AsBuiltReport.VMware.ESXi
v1.1.3
VMware ESXi As Build Report adalah modul PowerShell yang berfungsi bersama dengan asbuiltreport.core.
Asbuiltreport adalah proyek komunitas bersumber terbuka yang memanfaatkan PowerShell untuk menghasilkan dokumentasi yang dibangun dalam berbagai format dokumen untuk banyak vendor dan teknologi.
Modul Laporan VMware ESXI sebagai Built digunakan untuk menghasilkan dokumentasi yang dibangun untuk server ESXI VMware mandiri.
Silakan merujuk ke VMware vSphere asbuiltreport untuk melaporkan lingkungan VMware vSphere / vCenter Server.
Silakan merujuk ke situs web Asbuiltreport untuk informasi lebih rinci tentang proyek ini.
Di bawah ini adalah instruksi tentang cara menginstal, mengkonfigurasi, dan menghasilkan VMware ESXi sebagai laporan yang dibangun.
Laporan VMware ESXI sebagai Built mendukung versi ESXI berikut;
Versi ESXI VMware berikut tidak lagi diuji dan/atau didukung;
Laporan ini kompatibel dengan versi PowerShell berikut;
| Windows PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
PowerShell 5.1 atau PowerShell 7, dan modul PowerShell berikut diperlukan untuk menghasilkan VMware ESXi sebagai laporan yang dibangun.
❗ Jika Anda tidak dapat menginstal .NET Core, Anda harus mengatur ShowCoverPageImage ke False dalam Laporan File Konfigurasi JSON.
Pengguna dengan hak istimewa root pada host ESXI diperlukan untuk menghasilkan VMware ESXi sebagai laporan yang dibangun.
Buka jendela terminal PowerShell dan pasang masing -masing modul yang diperlukan.
install-module VMware.PowerCLI - MinimumVersion 12.3 - AllowClobber
install-module AsBuiltReport.VMware.ESXiLaporan ESXI As Build menggunakan file JSON untuk memungkinkan konfigurasi informasi laporan, opsi, detail, dan healthchecks.
File konfigurasi laporan ESXI dapat dihasilkan dengan menjalankan perintah berikut;
New-AsBuiltReportConfig - Report VMware.ESXi - Path < User specified folder > - Name < Optional >Mengeksekusi perintah ini akan menyalin konfigurasi JSON laporan ESXI default ke folder yang ditentukan pengguna.
Semua pengaturan laporan kemudian dapat dikonfigurasi melalui file JSON.
Berikut ini memberikan informasi tentang cara mengkonfigurasi setiap skema dalam file JSON laporan.
Skema laporan menyediakan konfigurasi informasi laporan ESXI
| Subema | Pengaturan | Bawaan | Keterangan |
|---|---|---|---|
| Nama | Pengguna ditentukan | Vmware esxi sebagai laporan yang dibangun | Nama laporan AS yang dibangun |
| Versi | Pengguna ditentukan | 1.0 | Versi Laporan |
| Status | Pengguna ditentukan | Dilepaskan | Status Rilis Laporan |
| ShowCoverPageImage | Benar / Salah | BENAR | Beralih untuk mengaktifkan/menonaktifkan tampilan gambar halaman sampul |
| Showheaderfooter | Benar / Salah | BENAR | Beralih untuk mengaktifkan/menonaktifkan header & footer dokumen |
| ShowTablecaptions | Benar / Salah | BENAR | Beralih untuk mengaktifkan/menonaktifkan teks/penomoran tabel |
Skema opsi memungkinkan opsi tertentu dalam laporan untuk dinyalakan atau dimatikan
| Subema | Pengaturan | Bawaan | Keterangan |
|---|---|---|---|
| Showlicensekeys | Benar / Salah | PALSU | Toggle ke Topeng/Unmask ESXi License Keys Kunci lisensi bertopeng *****-*****-*****-56YDM-AS12K Kunci lisensi yang tidak terdepan AKLU4-PFG8M-W2D8J-56YDM-AS12K |
| Showvmsnapshots | Benar / Salah | BENAR | Beralih untuk mengaktifkan/menonaktifkan pelaporan snapshot VM |
Skema infolevel memungkinkan konfigurasi setiap bagian laporan pada tingkat granular. Bagian berikut dapat diatur
Ada 6 level (0-5) granularitas detail untuk setiap bagian sebagai berikut;
| Pengaturan | Infolevel | Keterangan |
|---|---|---|
| 0 | Dengan disabilitas | Tidak mengumpulkan atau menampilkan informasi apa pun |
| 1 | Diaktifkan / ringkasan | Memberikan informasi yang dirangkum untuk kumpulan objek |
| 2 | Ringkasan Adv | Memberikan informasi yang kental dan terperinci untuk kumpulan objek |
| 3 | Terperinci | Memberikan informasi terperinci untuk masing -masing objek |
| 4 | Adv terperinci | Memberikan informasi terperinci untuk masing -masing objek, serta informasi untuk objek terkait (host, cluster, datastores, VM dll) |
| 5 | Luas | Memberikan informasi komprehensif untuk masing -masing objek, seperti pengaturan konfigurasi lanjutan |
Tabel di bawah ini menguraikan pengaturan infolevel default dan maksimum untuk setiap bagian.
| Subema | Pengaturan default | Pengaturan maksimum |
|---|---|---|
| Vmhost | 3 | 5 |
| Jaringan | 3 | 4 |
| Penyimpanan | 3 | 4 |
| Vm | 3 | 4 |
Skema HealthCheck digunakan untuk mengaktifkan pemeriksaan kesehatan.
Skema VMHOST digunakan untuk mengkonfigurasi pemeriksaan kesehatan untuk VMHosts.
| Subema | Pengaturan | Bawaan | Keterangan | Menyorot |
|---|---|---|---|---|
| ConnectionState | Benar / Salah | BENAR | Memeriksa keadaan koneksi vmhosts | Pemeliharaan Terputus |
| Hyperthreading | Benar / Salah | BENAR | Menyoroti vmhosts yang memiliki hyperthreading dinonaktifkan | Hyperthreading dinonaktifkan |
| Goresan goresan | Benar / Salah | BENAR | Sorotan vMhosts yang dikonfigurasi dengan lokasi awal | Lokasi goresan adalah /tmp /gores |
| IPv6 | Benar / Salah | BENAR | Sorotan vMhosts yang tidak memiliki IPv6 diaktifkan | IPv6 dinonaktifkan |
| Uptimedays | Benar / Salah | BENAR | Menyoroti vmhosts dengan hari uptime lebih dari 9 bulan | 9 - 12 bulan > 12 bulan |
| Lisensi | Benar / Salah | BENAR | Sorotan VMHost yang menggunakan lisensi evaluasi produksi | Lisensi Evaluasi Produk yang Digunakan |
| Ssh | Benar / Salah | BENAR | Sorotan Jika layanan SSH diaktifkan | Layanan TSM / TSM-SSH diaktifkan |
| Esxishell | Benar / Salah | BENAR | Sorotan Jika layanan ESXI Shell diaktifkan | Layanan TSM / TSM-ESXISHELL Diaktifkan |
| NTP | Benar / Salah | BENAR | Sorotan Jika layanan NTP telah berhenti atau dinonaktifkan pada vmhost | Layanan NTP berhenti / dinonaktifkan |
| Storageadapter | Benar / Salah | BENAR | Menyoroti adaptor penyimpanan yang bukan 'online' | Status adaptor penyimpanan 'tidak diketahui' Status adaptor penyimpanan 'offline' |
| NetworkAdapter | Benar / Salah | BENAR | Menyoroti adaptor jaringan fisik yang tidak 'terhubung' Menyoroti adaptor jaringan fisik yang 'turun' | Adaptor jaringan 'terputus' Adaptor jaringan 'turun' |
| LockdownMode | Benar / Salah | BENAR | Menyoroti vmhosts yang tidak memiliki mode penguncian diaktifkan | Mode penguncian dinonaktifkan |
Skema Datastore digunakan untuk mengonfigurasi pemeriksaan kesehatan untuk datastores.
| Subema | Pengaturan | Bawaan | Keterangan | Menyorot |
|---|---|---|---|---|
| Kapasitasutilisasi | Benar / Salah | BENAR | Menyoroti datastores dengan pemanfaatan kapasitas penyimpanan lebih dari 75% | 75 - 90% digunakan > 90% digunakan |
Skema VM digunakan untuk mengonfigurasi pemeriksaan kesehatan untuk mesin virtual.
| Subema | Pengaturan | Bawaan | Keterangan | Menyorot |
|---|---|---|---|---|
| Powerstate | Benar / Salah | BENAR | Sorotan VM yang dimatikan | VM didukung |
| ConnectionState | Benar / Salah | BENAR | Sorotan VM yang yatim piatu atau tidak dapat diakses | VM yatim piatu atau tidak dapat diakses |
| Cpuhotadd | Benar / Salah | BENAR | Sorotan mesin virtual yang memiliki CPU Hot Add diaktifkan | Cpu hot add diaktifkan |
| Cpuhotremove | Benar / Salah | BENAR | Sorotan mesin virtual yang memiliki CPU hot lepas diaktifkan | Cpu hot lepas diaktifkan |
| Memoryhotadd | Benar / Salah | BENAR | Menyoroti VM yang memiliki memori hot add diaktifkan | Memori hot add diaktifkan |
| ChangeBlockTracking | Benar / Salah | BENAR | Sorotan VM yang tidak memiliki perubahan pelacakan blok yang diaktifkan | Ubah pelacakan blok dinonaktifkan |
| SPBMPolicyCompliance | Benar / Salah | BENAR | Sorotan VM yang tidak mematuhi kebijakan berbasis penyimpanan | Kepatuhan Kebijakan Berbasis Penyimpanan VM Tidak Diketahui VM tidak mematuhi kebijakan berbasis penyimpanan |
| Vmtoolsstatus | Benar / Salah | BENAR | Sorotan mesin virtual yang tidak memiliki alat VM terpasang, ketinggalan zaman atau tidak berjalan | Alat VM tidak diinstal, ketinggalan zaman atau tidak berjalan |
| Vmsnapshots | Benar / Salah | BENAR | Menyoroti mesin virtual yang memiliki snapshot lebih tua dari 7 hari | VM Snapshot Age> = 7 hari VM Snapshot Age> = 14 hari |
# 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
