Understanding available "esxcli vsan debug" parameters
search cancel

Understanding available "esxcli vsan debug" parameters

book

Article ID: 326551

calendar_today

Updated On:

Products

VMware vSAN

Issue/Introduction

This article covers the various vsan debug commands available through esxcli 

Summary of available options: Format: esxcli vsan debug <option> 

disk
Debug commands for vSAN physical disks
object  
Debug commands for vSAN objects
resync
Debug commands for vSAN resyncing objects
controller
Debug commands for vSAN disk controllers
limit
Debug commands for vSAN limits
vmdk
Debug commands for vSAN VMDKs  
evacuation
Debug commands for simulating host, disk or disk group evacuation in various modes and their impact on objects in vSAN cluster
mob
Debug commands for vSAN Managed Object Browser Service.
advcfg
Debug commands for vSAN advanced configuration options.
memory
Debug commands for vSAN memory consumption.

 

VMware strongly recommends to run these commands by professional well versed with it.

Resolution

Physical disk debug parameters 

  • Command: 

#esxcli vsan debug disk summary get

  • Example output: 

   Overall Health: green
   Component Metadata Health: green
   Memory Pools (heaps): green
   Memory Pools (slabs): green
 

  • Command: 

#esxcli vsan debug disk list 

  • Example output: 

UUID: 52b4cf66-e6a6-9cd6-abf2-xxxxxxxxxxxx
   Name: mpx.vmhba2:C0:T0:L0
   SSD: True
   Overall Health: green
   Congestion Health:
         State: green
         Congestion Value: 0
         Congestion Area: none
   In Cmmds: true
   In Vsi: true
   Metadata Health: green
   Operational Health: green
   Space Health:
         State: green
         Capacity: 107365793792 bytes
         Used: 1430257664 bytes
         Reserved: 142606336 bytes 

vSAN object debug parameters  

  • Command: 

#esxcli vsan debug object health summary get 

  • Example output:

 Health Status                                     Number Of Objects
------------------------------------------------  -----------------
data-move                                                         0
nonavailability-related-incompliance                              0
nonavailability-related-reconfig                                  0
reduced-availability-with-no-rebuild-delay-timer                  0
healthy                                                           1
reduced-availability-with-active-rebuild                          0
inaccessible                                                      0
reduced-availability-with-no-rebuild                              0
 

  • Command: 

#esxcli vsan debug object list 

  • Example output: 

Object UUID: e5a6e05a-2f0e-df2d-423c-00505694ee17
   Version: 5
   Health: healthy
   Owner: localhost
   Policy:
      hostFailuresToTolerate: 1
      CSN: 1

   Configuration:

      RAID_1
         Component: xxxxxxxx-d248-632e-0952-xxxxxxxxxxxx
           Component State: ACTIVE,  Address Space(B): 273804165120 (255.00GB),  Disk UUID: xxxxxxxx-284e-3a78-1aac-xxxxxxxxxxxx,  Disk Name: mpx.vmhba0:C0:T2:L0:2
           Votes: 1,  Capacity Used(B): 364904448 (0.34GB),  Physical Capacity Used(B): 360710144 (0.34GB),  Host Name: localhost
         Component: xxxxxxxx-7d4f-642e-79d5-xxxxxxxxxxxx
           Component State: ACTIVE,  Address Space(B): 273804165120 (255.00GB),  Disk UUID: xxxxxxxx-e6a6-9cd6-abf2-xxxxxxxxxxxx,  Disk Name: mpx.vmhba2:C0:T2:L0:2
           Votes: 1,  Capacity Used(B): 364904448 (0.34GB),  Physical Capacity Used(B): 360710144 (0.34GB),  Host Name: localhost
      Witness: xxxxxxxx-5bd0-642e-5800-xxxxxxxxxxxx
        Component State: ACTIVE,  Address Space(B): 0 (0.00GB),  Disk UUID: xxxxxxxx-506b-65cf-6f8a-xxxxxxxxxxxx,  Disk Name: mpx.vmhba0:C0:T2:L0:2
        Votes: 1,  Capacity Used(B): 12582912 (0.01GB),  Physical Capacity Used(B): 4194304 (0.00GB),  Host Name: localhost

   Type: vmnamespace
   Path: /vmfs/volumes/vsan:5211a526aec1466f-xxxxxxxxxxxxxxxx/
   Group UUID: 00000000-0000-0000-0000-000000000000
   Directory Name: testobject 

Object resync debug parameters

  • Command: 

#esxcli vsan debug resync list

  • Example output: 

   Total Number Of Resyncing Objects: 0
   Total Bytes Left To Resync: 0
   Total GB Left To Resync: 0.00 

Disk controllers debug parameters

  • Command: 

#esxcli vsan debug controller list 

  • Example Output: 

Device Name: vmhba2
Device Display Name: VMware Inc. PVSCSI SCSI Controller
Used By VSAN: true
PCI ID: 15ad/07c0/15ad/07c0
Driver Name: pvscsi
Driver Version: 0.1-1vmw.650.1.26.5969303
Max Supported Queue Depth: 1024
 

vSAN limitation debug parameters 

  • Command:

#esxcli vsan debug limit get

  • Example Output: 

   Component Limit Health: green
   Max Components: 562
   Free Components: 561
   Disk Free Space Health: green
   Lowest Free Disk Space: 99 %
   Used Disk Space: 2868903936 bytes
   Used Disk Space (GB): 2.67 GB
   Total Disk Space: 214731587584 bytes
   Total Disk Space (GB): 199.98 GB
   Read Cache Free Reservation Health: green
   Reserved Read Cache Size: 0 bytes
   Reserved Read Cache Size (GB): 0.00 GB
   Total Read Cache Size: 0 bytes
   Total Read Cache Size (GB): 0.00 GB

vmdk debug parameters 

  • Command: 

#esxcli vsan debug vmdk list 

  • Example output: 

   Object: xxxxxxxx-2f0e-df2d-423c-xxxxxxxxxxxx
   Health: healthy
   Type: vmnamespace
   Path: /vmfs/volumes/vsan:5211a526aec1466f-xxxxxxxxxxxxxxxx/
   Directory Name: testobject
 

Evacuation debug parameters 

  • Command:

#esxcli vsan debug evacuation precheck -a ensureAccess -e localhost -v

Switches: 

  -a|--action=<str>     Action filter. Only show a specific type of actions from
                            ensureAccess: Ensure Accessibility
                            evacAllData: Evacuate All Data
                            noAction: No Action
  -e|--entity=<str>     The name or uuid of the disk or disk group or host node. For name, it accepts 'localhost' or a hostname in vSAN cluster, or a device name in a diskgroup such as 'mpx.vmhba1:C0:T1:L0'.
                        (required)
  -v|--verbose          Show full list of inaccessible and non-compliant (redundancy reduced) objects.

Example output: 

Action: Ensure Accessibility
   Evacuation Outcome: Success
   Entity: Host localhost
   Data to Move: 0.00 GB
   Number Of Objects That Would Become Inaccessible: 0
   Objects That Would Become Inaccessible: None
   Number Of Objects That Would Have Redundancy Reduced: 0
   Objects That Would Have Redundancy Reduced: None
   Additional Space Needed for Evacuation: N/A

vSAN MOB service debug parameters

  • Command:

#esxcli vsan debug mob <start|stop>

Description: 
start                 Start vSAN Managed Object Browser Service.
stop                  Stop vSAN Managed Object Browser Service.
 

advcfg debug parameters 

  • Command:

#esxcli vsan debug advcfg

Description: List all advanced configuration options with non-default values. 

Memory debug parameters 

  • Command:

#esxcli vsan debug memory list

Description: Print both userworld and kernel memory consumptions of vSAN.

Example Output:

#esxcli vsan debug memory list
Group          Usage in MB  Reserved in MB  Max in MB
----------        -----------------   ---------------------  --------------
Kernel         106.82             1920.86              2801.36
User World     270.11             606.33                641.00
Total          376.93             2527.19              3442.36

Additional Information

For more details on the vSAN debug command set you may refer to VMware document page: Using esxcli Commands with Virtual SAN

Powered by Wolken Software