# VMware Skyline Health Diagnostics（SHD）使用 - Part2: 功能操作

###### tags: `skyline` `vmware`

[toc]

vSphere 管理者可以透過 SHD 執行以下維運行為：
- 使用瀏覽器登入至 SHD 執行功能操作
- 透過 SHD 直接連接 vCenter 或 ESXi 主機執行分析和診斷
- 手動上傳及分析日誌包（log bundles）
- 分析結果以報告型態產生
- 可檢視最近 50 次所執行的分析報告

# 更新 SHD
強烈建議 SHD 釋出新版本時，可更新新的補丁或最新版本。補丁和更新可獲得新的特徵碼（增強的分析能力）和新的產品功能。

## 線上更新
若 SHD 可連接至互聯網，可通過簡單的步驟輕鬆更新或升級到最新版本。

### 升級前確認
- 具有 **`shd-admin`** 用戶權限，並可正常登入 SHD 的 HTML5 管理界面。
- SHD 虛擬設備可連接至互聯網。
- 具有 SHD 虛擬設備快照建立和刪除的權限。

### 升級程序
1. 建立 SHD 虛擬設備快照。
2. 使用 **`shd-admin`** 登入至 SHD 管理界面。
3. 點選 **Settings** > **Upgrade & History** > **Tool Update** 選項。
4. 點擊 **CHECK TOOL UPDATES** 檢查是否有更新可用。若有更新可用，則會啟用下載選項。
5. 點擊 **DOWNLOAD UPDATES** 下載更新。
6. 在 **Download Histor Summary** 中顯示所下載更新的版本資訊。
7. 重新啟動 SHD 虛擬設備，在開機程序中會自動更新軟體。


:::info
目前安裝為最新版本 3.0.2，迄今 2022/04/29 仍未有更新可用。
:::

### 升級驗證
1. 升級成功後，登入 SHD 管理界面，選擇 **Settings** > **About**。應會顯示下載所更新的版本資訊。
2. 選擇 **Settings** > **Upgrade & History** > **Tool Update** 選項。確認 **Upgrade History Summary** 和 **Download History Summary** 中顯示的版本訊息是否符合更新版本資訊。
3. 若上述訊息並非下載更新版本，表示更新或升級作業失敗。請收集日誌包並傳至 **[e-mail]** 尋求進一步協助。
4. 若更新且驗證成功，可刪除先前快照。若更新失敗，請恢復至先前快照後刪除該快照。

## VCG 更新
透過 VMware Compatibility Guide（VCG）的更新，可針對 ESXi 主機、硬體和 IO 設備進行相容性確認。

### 更新前確認
- SHD 虛擬設備可連接至互聯網並能與 VCG（https://www.vmware.com）間連線正常。

### 更新程序
1. 登入 SHD 管理界面。選擇 **Settings** > **Upgrade & History** > **VCG Update** 選項。
2. 點擊 **UPDATE VCG DATABASE** 下載更新。


更新過程可能會需要一些時間才能完成。啟動更新程序後，VCG 資料庫會持續進行，此時可操作 UI 其他動作，並不會影響更新動作。

VCG 資料庫更新完成！

# 執行分析診斷
## 連接 vCenter 執行分析診斷
可直接連接到 vCenter Server 並根據 **VMware 安全指南**或 **vSAN 運行狀況**選擇診斷或安全評估，或根據需求選擇任意選項組合。然後從清單中選擇所需的主機來收集日誌並進行分析。成功分析完成後會產生包含問題和解決方案列表的詳細報告。

:::info
**插件資訊**
- 診斷插件（diagnostics plugin）: 與 vSphere 操作有關一般類別的問題。
- 需要透過取得目標主機的日誌包進行分析。
- VMware 安全諮詢插件（VMware Security Advisory）: 提供由 VMSA 識別出的安全問題。
- 需要使用 API 收集的產品構建資料（product build information）。
- vSAN 運行狀況插件（vSAM Health plugin）: 執行與 vSAN 運行狀況相關的檢查和驗證。
- 也是透過 API 進行 vSAN 相關數據收集。
:::

### 執行條件
- 具有 vSphere 使用帳戶的有效登入資訊。
- 該 vSphere 使用帳戶需具有收集日誌的有效權限。
- 若計畫從 vCenter 收集日誌，需確認擁有 vCSA 的根憑證。
- 確認 vCenter 使用帳戶具有以下權限：
- 全域診斷（Global.Diagnostics）
- 系統視圖（System.View）
- 對清單物件（數據中心/叢集/主機）具有讀取權限（Read Permissions on the inventory objects (Datacenter/Cluster/Host)）

### 執行步驟
1. 登入 SHD 管理界面。
2. 選擇上方 **Analyze** 功能選單， 點擊左側 **Connect and Analyze** > **vSphere** 選項，進入 **vCenter/ESXi Details** 使用界面。
3. 根據頁面所需項目填入相關資訊：
- **HostName/IP**: 輸入 vCenter 或 ESXi 的主機名稱或 IP 位址。若變更預設服務埠 **`443`**，請使用冒號 **`：`** 輸入。
範例： **`vcenter_hostname:port`**
- **Username**: 有效帳戶名稱。
- **Password**: 有效帳戶密碼。
- **Connect to vCenter Appliance/PSC**: 若想使用 VAMI 界面收集日誌且無法存取 vCenter HTML5 界面，可選擇此選項。若採用此種方式，上述 username/password 用戶資訊請使用 **`root`**。
4. 點擊 **CHECK CONNECTION**，驗證給定資訊是否可正常連接。
5. 驗證欲連接的 vCenter/ESXi 的指紋（thumbprint），點擊 **CONNECT** 繼續。
6. 若連接成功，則會顯示 **`vSphere API connection to vCenter Server successful`**。可點擊 **RUN DIAGNOSTICS** 執行分析診斷。

若連接失敗，則會顯示錯誤訊息。請先針對錯誤進行修正並重複相關步驟。
7. 點擊 **RUN DIAGNOSTICS** 後，將會彈跳視窗顯示診斷所需插件（Plugins）和欲診斷 vCenter/ESXi 清單，其中顯示 vCenter 中可用的所有主機，當然也包含 vCenter 設備。
8. 請根據所需要進行診斷的功能選擇適當的插件。
- Diagnostics Plugins
- VMware Security Advisory Plugins
- vSAN Health Check Plugins
- VCG Check Plugins
- vCenter Health Check Plugins
9. 從清單中選擇需要進行診斷的 vCenter 或 ESXi 主機。
:::info
**注意**
- 若要分析 vCenter，請選擇 **Include vCenter for Analysis**。
- 若選擇以下診斷插件，也請選擇 **Include vCenter for Analysis** 選項。
- **Diagnostics Plugins**
- **VMware Security Advisory Plugins**
- **vSAN Health Check Plugins**
:::

:::success
基本上就**全選**吧!
:::
10. 點擊 **VALIDATE** 後，將出現提交分析（Submit for Analysis）視窗，其中顯示本次進行分析的 vCenter 和 ESXi 主機數量統計。
11. 提交分析可輸入 **標籤名稱（Tag alaysis as）** 標註分析，有助於之後快速搜尋分析報告。
12. 提交分析中提供**日誌分析限制天數（Log Analyze Limit）**，可輸入從日誌收集日期算起的指定 n 天數（限制執行日誌收集的前 n 天內容進行分析診斷）。若不指定任何值，則預設值為 **0**，將會分析所有日誌。
13. 在提交分析視窗點擊 **FINISH**，在 **任務視圖（Tasks）** 中可以檢視分析任務進度。
14. 分析完成後，選擇欲檢視報的任務項目，點擊 **SHOW REPORT** 以檢視報告。點選項目右側的圖標，執行 **下載**/**查看**/**刪除** 報告。
- **下載報告**: 可以依據選擇的報告類別儲存成 HTML 格式。
- **查看報告**: 直接查看報告的詳細資訊。報告當中可再點選下拉項目檢視細部資訊。
- **刪除報告**: 嗯，就是刪除報告而已。

## 斷開連接（disconnected）的 ESXi 主機執行分析診斷
在 vCenter 環境下有斷開連接（disconnected）的 ESXi 主機，也可以透過先前的方式來收集日誌並進行分析。

### 執行條件
- 相關執行條件都與 **連接 vCenter 執行分析診斷** 相同。
- 除此之外，欲分析**斷開連接的 ESXi 主機還需要提供 SSH 連線**才能達成。

### 執行步驟
基本步驟與**連接 vCenter 執行分析診斷**相同，相關步驟就不再贅述。僅針對不同處說明。
- 輸入 vCenter 有效憑證資訊，在資產清單中點選**斷開連接**的 ESXi 主機。
- 提供該主機的 SSH 連線資訊，並點擊 **VALIDATE SSH CREDENTIALS** 驗證。
- 若出現錯誤訊息，請**務必確認 SSH 連線狀態**。
- SSH 連線驗證成功，點擊 **FINISH** 進行報告分析。

## vSAN & VCF 分析診斷
基本上執行條件及步驟類似，輸入 vCenter 和 SDDC Manager 有效帳戶資訊，再選擇對應的 **Health Check Plugins** 完成分析報告即可。
- **vSAN Storage Health Check**
- **VMware Cloud Foundation Health Check**

:::warning
因為沒有 vSAN 或 VCF 佈署環境，這部份請自行腦補。
:::

## 上傳日誌包執行分析診斷
上傳 vCenter 或 ESXi 主機的診斷日誌包，可透過此選項進行分析。也可利用此功能，對於 vCenter 安裝/升級/遷移失敗的日誌進行分析。

### 執行條件
- 取得 vCenter 或是 ESXi 主機的日誌包。
- 在 Web Client 中使用 **導出系統日誌（Export System logs）** 或是命令列方式。
- 要取得 VMware 產品診斷資訊，請參考 [VMware KB#1008524](https://kb.vmware.com/s/article/1008524)。
<img width=180 src=https://i.imgur.com/5PAsbYl.png>

### 執行步驟
1. 登入 SHD 管理界面。
2. 選擇上方 **Analyze** 功能選單， 點擊左側 **Upload and Analyze** > **Upload Bundles** 選項。
3. 輸入所需資訊並選擇檔案上傳。
- **標籤名稱**與**日誌分析限制天數**和先前一樣。
- 點擊 **Choose File**，選擇要上傳的日誌包檔案。
4. 點擊 **Upload and analysis**，開始上傳日誌包並進行分析。

:::info
**資訊**
在進行分析診斷作業時，UI 會顯示任務編號(Task ID)。


可 SSH 連線至 SHD 虛擬設備，透過任務編號在目錄 **`/opt/vmware-shd/vmware-shd/log/`** 中找到對應的即時日誌紀錄 **`vmware-shd-task-{TASK_ID}.log`**。


從紀錄檔中可以大致了解 SHD 在分析診斷過程的進程。
- 上傳的日誌包會暫存至目錄 **`/opt/vmware-shd/vmware-shd/logstore/{TASK_ID}`**，解壓分析處理後會自動刪除。
> 如果分析任務執行失敗，可能無法正確刪除該目錄？！
- 根據選擇的插件（Plugins）項目進行分析，以此任務來看，執行了 **Storage**、**Host** 和 **VMSA** 插件檢查。總共從 **298** 組資料中比對出 **32** 組。從 UI 檢視報告內容也可對應出來。
:::

## 檢視診斷報告
先前透過上傳/收集的日誌包，SHD 會進行分析診斷產生比對發現的詳細報告。可以透過 UI 立即查看或儲存至本地端以備之後使用。UI 提供 最近 50 份報告的存取權限。

### 查看報告
1. 選擇上方 **Show Reports** 功能選單。
2. 左側選單顯示 5 個過濾器，根據分析時選擇的插件分類。可依照需求選擇過濾器篩選報告。
- 診斷報告（Diagnostics）
- 安全報告（VMware Security Advisory）
- vSAN 報告（vSAN-HealthCheck）
- VMware 產品兼容報告（VCG Check）
- VMware Cloud Foundation（VCF）報告
3. 顯示列出的報告，可透過以下過濾器進行細部篩選。先前在建立報告時使用的**標籤**，可作為關鍵字快速搜尋。
- Bundle Name
- Analysis Type
- Tags
- User Name
- Start Time

:::info
- 有關報告搜尋可以參考 [**Searching the Analysis Reports**](https://docs.vmware.com/en/VMware-Skyline-Health-Diagnostics/services/Skyline-Health-Diagnostics/GUID-44A14B94-AF5D-4FED-AE07-807CB53EC50E.html) 說明。
- 增加或移除標籤可以參考 [**Adding and Removing Tags for the Analysis Report**](https://docs.vmware.com/en/VMware-Skyline-Health-Diagnostics/services/Skyline-Health-Diagnostics/GUID-D30E7460-8F96-4BE3-9BBA-45C194EF2CE7.html) 說明。
:::
4. 若要在同一視窗查看報告內容，點擊 **`>>`** 展開。另外可點選 **VIEW DETAILS** 或 **Suggested KB 超連結** 檢閱詳細資訊。
5. 點選報告項目右側的圖標，執行 **下載/查看/刪除** 報告。這部份先前已經提過了。

### 下載/刪除多份分析報告
除了對於單一報告進行下載或刪除外，也可以選擇多筆報告後，點擊 **`SAVE MULTIPLE BUBDLES`** 或 **`DELETE MULTIPLE BUNDLES`** 選項，進行多筆報告的下載及刪除。

### 解讀報告
SHD 產出的報告簡單明瞭。只要滑鼠移過去可以點擊的地方，都可以試試看。對於環境根據插件診斷出來的問題，都有連結可以深入研究，真的是一套免費的好工具。

有興趣的可以參考以下說明自行研究囉。
- [Interpreting the Diagnostics Report](https://docs.vmware.com/en/VMware-Skyline-Health-Diagnostics/services/Skyline-Health-Diagnostics/GUID-E5D146BD-410C-4921-9ABD-71891E159973.html)
- [Interpreting VCG/vSAN HCL Validation Summary](https://docs.vmware.com/en/VMware-Skyline-Health-Diagnostics/services/Skyline-Health-Diagnostics/GUID-BAC021B3-82B6-4FF2-BED3-114FB3F89CEA.html)
- [Interpreting VMware vSAN Storage Report](https://docs.vmware.com/en/VMware-Skyline-Health-Diagnostics/services/Skyline-Health-Diagnostics/GUID-5FFEE943-8FD1-4D7E-9A76-86343C85774C.html)
- [Interpreting VMware Cloud Foundation Diagnostics Report](https://docs.vmware.com/en/VMware-Skyline-Health-Diagnostics/services/Skyline-Health-Diagnostics/GUID-DFD9E2B9-FF9D-439C-BD94-CF6264596E98.html)

---

- [Part1: 安裝及界面](https://hackmd.io/@farmer87/shd_01)
- [Part2: 功能操作](https://hackmd.io/@farmer87/shd_02)
- [Part3: 報告排程](https://hackmd.io/@farmer87/shd_03)
- [Part4: API 使用](https://hackmd.io/@farmer87/shd_04)

# 參考資訊
- [Connect and Analyze Log Bundles for vCenter and ESXi](https://docs.vmware.com/en/VMware-Skyline-Health-Diagnostics/services/Skyline-Health-Diagnostics/GUID-FE866386-71D1-457F-9FF5-003755DE8104.html)
- [Connect and Analyze Log Bundles from the Disconnected ESXi Host](https://docs.vmware.com/en/VMware-Skyline-Health-Diagnostics/services/Skyline-Health-Diagnostics/GUID-2A7DF58E-50C2-44DF-8A5A-D4E98D99E247.html)
- [Health Checks for VMware vSAN Storage](https://docs.vmware.com/en/VMware-Skyline-Health-Diagnostics/services/Skyline-Health-Diagnostics/GUID-46E52CF8-2CEC-4FB3-8626-2FE4D2BF1844.html)
- [Health Cheks for VMware Cloud Foundation (Technical Preview Mode)](https://docs.vmware.com/en/VMware-Skyline-Health-Diagnostics/services/Skyline-Health-Diagnostics/GUID-5C3E10BA-FA67-4343-8E2B-1D36F3C43B57.html)