AsBuiltReport.VMware.ESXi
v1.1.3
VMware ESXI AS構建報告是一個PowerShell模塊，與AsbuiltrePort.Core一起使用。
AsbuiltrePort是一個開源的社區項目，它利用PowerShell為多個供應商和技術以多種文檔格式生產了量的文檔。
VMware ESXI作為構建報告模塊用於生成獨立VMware ESXI服務器的構建文檔。
請參閱VMware AsbuilTrePort的VMware報告，以報告VMware VSphere / Vcenter Server環境。
請參閱AsbuiltrePort網站以獲取有關此項目的更多詳細信息。
以下是有關如何安裝，配置和生成VMware ESXI作為構建報告的說明。
構建報告的VMware ESXI支持以下ESXI版本；
以下VMware ESXI版本不再被測試和/或支持；
該報告與以下Powershell版本兼容。
| Windows Powershell 5.1 | Powershell 7 |
|---|---|
| ✅ | ✅ |
PowerShell 5.1或PowerShell 7，以及以下PowerShell模塊以生成VMware ESXI作為構建報告所需的。
❗如果您無法安裝.NET Core，則必須將ShowCoverPageImage設置為“報告JSON配置文件”中的False 。
需要在ESXI主機上具有根特權的用戶以生成VMware ESXI作為構建的報告。
打開一個PowerShell終端窗口並安裝每個必需的模塊。
install-module VMware.PowerCLI - MinimumVersion 12.3 - AllowClobber
install-module AsBuiltReport.VMware.ESXi構建報告的ESXI使用JSON文件來允許報告報告信息，選項，詳細信息和HealthChecks。
可以通過執行以下命令來生成ESXI報告配置文件；
New-AsBuiltReportConfig - Report VMware.ESXi - Path < User specified folder > - Name < Optional >執行此命令將將默認的ESXI報告JSON配置複製到指定的文件夾。
然後，所有報告設置都可以通過JSON文件進行配置。
以下提供瞭如何在報告的JSON文件中配置每個架構的信息。
報告模式提供ESXI報告信息的配置
| 亞chema | 環境 | 預設 | 描述 |
|---|---|---|---|
| 姓名 | 用戶定義 | VMware ESXI作為構建報告 | 構建報告的名稱 |
| 版本 | 用戶定義 | 1.0 | 報告版本 |
| 地位 | 用戶定義 | 發行 | 報告發布狀態 |
| 展示圖像 | 是 /錯誤 | 真的 | 切換以啟用/禁用封面圖像的顯示 |
| Showheaderfooter | 是 /錯誤 | 真的 | 切換以啟用/禁用文檔標頭和頁腳 |
| ShowTableCaptions | 是 /錯誤 | 真的 | 切換到啟用/禁用表字幕/編號 |
選項模式允許在報告中切換或關閉報告中的某些選項
| 亞chema | 環境 | 預設 | 描述 |
|---|---|---|---|
| showlicensekeys | 是 /錯誤 | 錯誤的 | 切換到蒙版/UNMASK ESXI許可鍵 蒙版許可證密鑰 ***** - ***** - ***** -56YDM-AS12K 未掩蓋的許可證密鑰 AKLU4-PFG8M-W2D8J-56YDM-AS12K |
| Showvmsnapshots | 是 /錯誤 | 真的 | 切換以啟用/禁用VM快照的報告 |
Infolevel模式允許在粒狀級別上配置報告的每個部分。可以設置以下各節
每個部分的細節粒度有6個級別（0-5），如下所示；
| 環境 | 無效 | 描述 |
|---|---|---|
| 0 | 禁用 | 不收集或顯示任何信息 |
| 1 | 啟用 /摘要 | 提供摘要的信息以收集對象 |
| 2 | adv摘要 | 為對象集合提供凝結的詳細信息 |
| 3 | 詳細的 | 為單個對象提供詳細信息 |
| 4 | adv詳細 | 提供有關單個對象的詳細信息，以及關聯對象（主機，群集，數據存儲，VM等）的信息 |
| 5 | 綜合的 | 為單個對象（例如高級配置設置）提供全面信息 |
下表概述了每個部分的默認設置和最大impolevel設置。
| 亞chema | 默認設置 | 最大設置 |
|---|---|---|
| VMHOST | 3 | 5 |
| 網絡 | 3 | 4 |
| 貯存 | 3 | 4 |
| VM | 3 | 4 |
HealthCheck模式用於打開或關閉健康檢查。
VMHOST模式用於配置VMHOST的健康檢查。
| 亞chema | 環境 | 預設 | 描述 | 強調 |
|---|---|---|---|---|
| ConnectionState | 是 /錯誤 | 真的 | 檢查VMHOSTS連接狀態 | 維護 斷開連接 |
| 超線程 | 是 /錯誤 | 真的 | 突出顯示已禁用超線程的VMHOSTS | 超線程禁用 |
| 刮擦 | 是 /錯誤 | 真的 | 突出顯示使用默認刮擦位置配置的VMHOSTS | 刮擦位置為 /tmp /刮擦 |
| IPv6 | 是 /錯誤 | 真的 | 突出顯示未啟用IPv6的VMHOSTS | IPv6禁用 |
| 推動日 | 是 /錯誤 | 真的 | 亮點的VMHOSTS，其運行時間大於9個月 | 9-12個月 > 12個月 |
| 許可 | 是 /錯誤 | 真的 | 突出顯示使用生產評估許可證的VMHOSTS | 使用的產品評估許可證 |
| SSH | 是 /錯誤 | 真的 | 突出顯示是否啟用了SSH服務 | 啟用TSM / TSM-SSH服務 |
| Esxishell | 是 /錯誤 | 真的 | 突出顯示是否啟用了ESXI Shell服務 | 啟用TSM / TSM-ESXISHELL服務 |
| NTP | 是 /錯誤 | 真的 | 突出顯示NTP服務是否已停止或在VMHOST上禁用 | NTP服務停止 /禁用 |
| Storageadapter | 是 /錯誤 | 真的 | 突出顯示的存儲適配器不是“在線” | 存儲適配器狀態是“未知” 存儲適配器狀態為“離線” |
| NetworkAdapter | 是 /錯誤 | 真的 | 突出顯示未“連接”的物理網絡適配器 突出顯示“下降”的物理網絡適配器 | 網絡適配器已“斷開連接” 網絡適配器是“下降” |
| LockDownMode | 是 /錯誤 | 真的 | 突出顯示未啟用鎖定模式的VMHOSTS | 禁用鎖定模式 |
數據存儲模式用於配置數據存儲的健康檢查。
| 亞chema | 環境 | 預設 | 描述 | 強調 |
|---|---|---|---|---|
| 容量化 | 是 /錯誤 | 真的 | 突出顯示存儲容量利用率超過75％的數據存儲 | 75-90％使用 >使用> 90％ |
VM模式用於配置虛擬機的健康檢查。
| 亞chema | 環境 | 預設 | 描述 | 強調 |
|---|---|---|---|---|
| Powerstate | 是 /錯誤 | 真的 | 突出顯示電源的VM | VM電源關閉 |
| ConnectionState | 是 /錯誤 | 真的 | 突出顯示孤立或無法訪問的VM | VM是孤兒或無法訪問的 |
| cpuhotadd | 是 /錯誤 | 真的 | 突出顯示具有CPU熱添加啟用的虛擬機 | CPU熱添加啟用 |
| cpuhotremove | 是 /錯誤 | 真的 | 突出顯示具有CPU HOT啟用啟用CPU的虛擬機 | CPU HOT啟用了啟用 |
| MemoryHotadd | 是 /錯誤 | 真的 | 突出顯示具有內存熱添加啟用的VM | 內存熱添加啟用 |
| ChangeBlockTracking | 是 /錯誤 | 真的 | 突出顯示沒有變化塊跟踪啟用的VM | 變更塊跟踪禁用 |
| SPBMPolicyCompliance | 是 /錯誤 | 真的 | 突出顯示不符合基於存儲策略的VM | 基於VM存儲的策略合規性未知 VM不符合基於存儲的策略 |
| vmtoolsstatus | 是 /錯誤 | 真的 | 突出顯示未安裝VM工具，已過時或未運行的虛擬機 | VM工具未安裝，過時或不運行 |
| VMSNAPSHOTS | 是 /錯誤 | 真的 | 亮點的虛擬機，其快照以上超過7天 | VM快照年齡> = 7天 VM快照年齡> = 14天 |
# 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
