Summary
When troubleshooting vSAN issues, analyzing the cmmds-tools command output and local command outputs is essential to get a complete understanding of the vSAN environment. This includes information on the vSAN cluster, nodes, disk group, and objects. However, this manual process can be time-consuming. To save time and effort, we have developed a tool that quickly converts vSAN information from text to graphics, including:
- vSAN cluster topology
- vSAN nodes information
- vSAN disk group information
- VM and object composition
- Component distribution and status
Compared to existing analyzers, our tool decodes more details on vSAN DOM and LSOM, such as type and status distribution, going beyond hardware information and deep into DOM objects. Our tool has three main functions:
- vSAN cluster health information
- VM and object information
- Object distribution
We hope that our tool will enhance your efficiency when resolving vSAN-related issues.
Enjoy!
Requirements
- vSAN OSA 6.x/7.x/8.x
- ESXi
- Python 3
Instructions
You can download the PDF instructions.
1. Deploying the Tool
To deploy the tool, follow these steps:
- Pull the Docker image by running the following command:
docker pull projects.registry.vmware.com/fling_vsan_objects_viewer/fling_vcmd:v1.5.7- Deploy the container by running the following command:
docker run -d -p 30000:80 projects.registry.vmware.com/fling_vsan_objects_viewer/fling_vcmd:v1.5.7- Access the tool by opening a browser and entering the correct IP address and port, for example, http://10.117.203.12:30000/vcmd/graph/. Replace "10.117.203.12" with your IP address.
2. Pre-Deployment Requirements
Before using the tool, run the following command on any ESXi hosts within the vSAN cluster and download the output file to your local laptop or a remote web server:
cmmds-tool find -f json > /tmp/cmmds-tool_find--f-python.txt3. Uploading Files
There are two methods for uploading the output file to the tool:
Method 1: Upload a Local File
- Open VCMD tool e.g. http://10.117.203.12:30000/vcmd/graph/
- Click "Choose File" and select your output file on your laptop
- Click "Upload"
Method 2: Upload a Remote File
If you have a web server, you can import your output file using the following steps:
- Copy the URL of the cmmds-tool_find--f-python.txt file, for example: https://192.168.10.1/xxxxx/logs/cmmds-tool_find--f-python.txt
- Paste the URL of the cmmds-tool_find--f-python.txt file into the tool.
- Click "Load Remote".
vSAN Viewer Overview
Once you've uploaded the output file, you can obtain a comprehensive overview of your vSAN cluster, including the following details:
More details can be found in vSAN Viewer Guide
Video
Changelog
Version 1.5.7
- Updated Yaml file for K8S deployment in the manual guide.
Contributors
Similar Flings
ESXi Embedded Host Client
This version of the ESXi Embedded Host Client is written purely in HTML and JavaScript, and is served directly from your ESXi host and should perform much better than any of the existing solutions.
HCIBench
HCIBench stands for "Hyper-converged Infrastructure Benchmark". It's essentially an automation wrapper around the popular and proven VDbench open source benchmark tool that makes it easier to automate testing across a HCI cluster.
USB Network Native Driver for ESXi
This Fling supports the most popular USB network adapter chipsets found in the market.