8/6/2021 XtremIO: Host Configuration Validation Script for ESX | Dell UK

Article Number: 000020713 Print

XtremIO: Host Configuration Validation Script for ESX

Summary:
This KBA explains how to use the validation script that checks an ESX host. The script output
flags configuration items that do not comply with the best practices recommendations outlined in the Host
Configuration Guide

Article Content

Instructions

Overview
Proper configuration of the hosts is essential for optimal XtremIO operations. This article describes the ESX validation script that
validates that the ESX host is configured according to the best practices as specified in the  Host Configuration Guide.

Specification
The specifications for the host best practices are found in the XtremIO Host Configuration Guide. The XtremIO Host Configuration
Guide is available from Dell Support and in the Reference Material section of XtremIO SolVe Desktop (SolVe Install and SolVe
Online). The Guide specifies the recommended values for host configuration parameters, as well as their impact (Stability,
Performance, Space Efficiency) and severity (Mandatory, Warning or Recommendation).

The validation script uses PowerCLI, versions 6.5 and above, which is a VMware shell for Windows. The script requires the
VMware vCenter and XMS credentials, it does not use the host's credentials. 

Procedural Notes (for running the ESX Host Configuration Validation script attached to this article):

Execution: This procedure is performed using PowerCLI (or PowerShell console) running on Windows using the VMware vCenter.
 The console must be run as administrator. The vCenter credentials must be for administrator privileges .
Cluster / Host Impact:  The script will not affect the cluster or host. 
Cluster / Storage Controller Reboot Persistency: This procedure does not introduce any changes to the cluster or host.
Non- Disruptive Upgrade (NDU) Considerations: This procedure does not introduce any changes to the cluster or host.
Execution Duration: The script for this task will take approximately one (1) minute per ESX Host to complete.

Supported Configurations
ESX Versions: 5.5 and above

Protocols: iSCSI, FibreChannel    

Note1: iSCSI is in Tech Preview mode.

Note2: iSCSI is not tested on cards that do TCP offloading (TOE).

FibreChannel HBA vendors:

QLogic - both native and vendor drivers.

Emulex.
Cisco UCS - incomplete (see Gaps section below).

MultiPath: Native and PowerPath.

https://www.dell.com/support/kbdoc/en-uk/printview/000020713/10/en 1/8
8/6/2021 XtremIO: Host Configuration Validation Script for ESX | Dell UK

Running the ESX Host Validation Script

Option 1) 

The script attached to this KB can be run standalone on any Windows host with PowerCLI, it will validate all hosts or specific hosts
managed by vCenter (See Notes section below for instruction on running the script). 

Option 2)

The ESXi Grab version 1.3.8 (and newer) have integrated the XtremIO Host Validation Script as a runtime option. The output logs of
the Host Validation Script are included in the ESXi Grab log bundle. See the ESXi Readme  for instruction on running the ESXi Grab
and how to use the XtremIO relevant parameters ( -vcenter_server, -vcenter_user, -vcenter_password, -mixed_storage). When run in
ESXi Grab the output is included in the E-Lab Advisor (ELA) report. 

The ESXi Grab will run the Host Validation for a single host.  The execution policy can be set from the PowerCLI window when run
as Adminstrator: Set-ExecutionPolicy -Scope LocalMachine -ExecutionPolicy RemoteSigned. After running the
script the Execution policy and exiting the script window, the Execution policy will revert to previous values.

Command-line Examples:

Collect data connecting to ESXi and vCenter servers using ESXiGrab and XtremIO Host Validator 

 emcgrab.exe  host <esx host> -user <esx user> -password <esx password> -vcenter_server
<vcenter server> -vcenter_user <vcenter user> -vcenter_password <vcenter password>

Collect data connecting to ESXi and vCenter servers using ESXiGrab and XtremIO Host Validator with (i) mixed non-XtremIO
and XtremIO storage and (ii) connecting to the XMS

emcgrab.exe -host <esx host> -user <esx user> -password <esx password> -vcenter_server
<vcenter server> -vcenter_user <vcenter user> -vcenter_password <vcenter password> -
mixed_storage -xms_name <xms IP address or hostname> -xms_user <xms user> -xms_password
<xms password>

Output of the ESX Host Validation Script

The script prints its output to log files. If the script is run directly from PowerCLI (option 1 above) then the output is also sent to the
console.

For each configuration validation, the output indicates if the validation is correct or, if not, the severity of the incorrect configuration.The
script prints a message with a prefix that matches the severity of the item: PROBLEM, WARNING or NOTICE, the validation text and the
expected value. For some items where these is no definitive best practices value, the configured value is displayed.

An output directory named <esx name>_<time> will be created in the Logs directory.

When run within the ESXi Grab, the logs are located in the Grab output folder in the folder \XIO_ESX_checker.   The content of the
output file is included in the ELA report when the Grab file is upload to ELA.

The output directory will include the files:

all.log - Contains all output (same as what's printed to the console).
error.log - Contains only error messages/warnings and suspected errors.
EMC_LEGAL_NOTICE-HVS.txt   - The text of the EMC SOFTWARE TOOLS LICENSE AGREEMENT (This does not appear in the log
directory when run in ESXi Grab)

https://www.dell.com/support/kbdoc/en-uk/printview/000020713/10/en 2/8
8/6/2021 XtremIO: Host Configuration Validation Script for ESX | Dell UK

all.log

***************************************************************************************************

Started processing at [19/09/2019 13:37:05] Jerusalem Standard Time.

***************************************************************************************************

Running script version [1.1.0.0].

***************************************************************************************************

Connecting to 11.62.128.40

START DATA COLLECTION FOR ESX 11.62.128.40 ###########

Collecting FCHBAs information

Collecting Device & Paths Configuration...

Collecting vCenter Server Parameters...

Collecting Host Advanced Settings...

Collecting iSCSI Settings...

No iSCSI NICs found

Collecting FibreChannel Settings...

Collecting module QLogic (qlnativefc)

Collecting Native Multipath Settings...

Collecting XtremIO LUNs information...

FINISHED DATA COLLECTION FOR ESX 11.62.128.40 ###########

Invoked:

.\check_esx_config.ps1 -vcenter_server 11.62.128.204 -vcenter_user administrator@vsphere.local -vcenter_password ***********

-esx_host 11.62.128.40

Validating configuration of ESX hosts on vCenter 11.62.128.204 #########

START VALIDATIONS FOR ESX 11.62.128.40 ###########

Did not Detect non-XtremIO storage, hence expecting this host to be configured for XtremIO only

You can override this determination by adding the flag '-mixed_storage true' to the command line

ESX version: 6.7.0 Update 3

Xtremapp version: 6300

In order to perform additional check and improve the certainty of other checks (i.e. validate the multipathing to XtremIO
clusters initially created prior to XtremIO XIOS version 4.x) extracting information from the XMS is required. Would you like
to connect to the XMS? (y/n)

Failed to connect to to XMS vxms-xbrick14.chn.com with the provided credentials

Performing XMS-Connectivity-Dependent Checks ###

Connecting to XMS: vxms-xbrick14.chn.com with provided username and password

XMS connectivity was not detected - Skipping check of "Initiator-OS Configuration on XMS" check

XMS connectivity was not detected - Skipping check of Virtual XMS deployment on managed XtremIO volume...

Checking ISCSI Settings ###

No iSCSI NICs found

Checking FibreChannel Settings ###

Checking module QLogic (qlnativefc):

OK: IO Timeout is not set. The default (30) is the acceptable minimum

Checking Host Parameters ###

Checking vCenter Server Parameters ###

System parameter config.vpxd.ResourceManager.maxCostPerHost is not set, hence

default value (8) applies.

The correct value is as follows, depending on XtremIO cluster size:

Cluster Size | Max Concurrent Operations

--------------------+-------------------------

Starter (5TB) | 8

Single X-Brick | 8

Two X-Bricks | 16

Four X-Bricks | 32

Six or more X-Bricks | 48

Checking VAAI Settings ###

OK: DataMover.HardwareAcceleratedMove setting is correct (1)

https://www.dell.com/support/kbdoc/en-uk/printview/000020713/10/en 3/8
8/6/2021 XtremIO: Host Configuration Validation Script for ESX | Dell UK

OK: DataMover.HardwareAcceleratedInit setting is correct (1)

OK: VMFS3.HardwareAcceleratedLocking setting is correct (1)

1 XtremIO datastores were found

OK: 1 XtremIO datastores are set with "Public ATS-only" locking mode and will work with VAAI

Checking Connectivity Mode ###

Native Multipathing was detected.

Checking Native Multipath Settings ###

Recommendation for multipathing is: for single X-brick minimum of 4 paths; for dual X-brick minimum of 8 paths; three or more
X-brick 16 paths.

OK: Path Selection Policy and path switching frequency are correct (Round Robin, 1) for all mapped XtremIO disks

OK: Number of paths is within limit (up to 16) for all XtremIO disks

OK: Default Native Multipath configuration (for future XtremIO disk mappings) is correct

Checking Paths Configuration ###

OK: All XtremIO paths are active

XMS connectivity was opted out - running in normal mode instead of "absolute certainty" mode.

OK: Paths configuration is correct: the host has at least one path to two storage controllers of the same brick for each LUN

FINISHED VALIDATIONS FOR ESX 11.62.128.40 ###########

Finished Validating configuration of ESX hosts #########

#########################################################

Overview section for host 11.62.128.40 ############

#########################################################

Notice issues for Device paths occurs 1 times

Error issues for Configuration setting occurs 1 times

Warning issues for Configuration setting occurs 3 times

Notice issues for Configuration setting occurs 2 times

#########################################################

Detail section for host 11.62.128.40 #############

#########################################################

NOTICE:# XtremIO Fibre Channel Disk (naa.514f0c585e600006) has 4 paths - See recommendation above

PROBLEM:# Disk.DiskMaxIOSize is set to 32767 rather than the recommended value of 4096.

WARNING:# LUN Queue Depth on volume naa.514f0c585e600006 is set to 64 rather than the recommended value of 256.

WARNING:# LUN Queue Depth is not set and the default value is 64. It must be set to 256.

WARNING:# Max number of outstanding IOs on volume naa.514f0c585e600006 is set to 32 rather than the recommended value of 256.

NOTICE:# Disk.SchedQuantum is set to 8 rather than the recommended value of 64.

NOTICE:# DataMover.MaxHWTransferSize is set to 4096 rather than the recommended value of 256.

***************************************************************************************************

Problems found: 1 issues (1 instances)

Warnings found: 1 issues (3 instances)

Notices found: 2 issues (3 instances)

***************************************************************************************************

Finished processing at [19/09/2019 13:38:25].

***************************************************************************************************

DISCLAIMER: The following recommendations from the Host Configuration Guide are not validated by the script, since we

didn't find a way to determine their values from the host only. Make sure you verify them manually:

1. APD/PDL Connectivity mode setting - defined on the cluster. Check https://support.emc.com/kb/483391

for details.

2. NIC Partitioning should be disabled (NPAR: utilizing iSCSI interface for multiple storage iSCSI).

3. FC Adapter Policy IO Throttle Count for Cisco UCS.

4. Minimum I/O timeout on the HBAs for Cisco UCS.

5. RDM volumes used by the virtual machine should be spanned across SCSI controllers.

6. Virtual machines should be aligned.

7. 'Boot from SAN' should be defined properly (if used).

8. maxCostPerHost on the vCenter (see value above) - the correct value depends on the cluster size (single, dual...)

9. TCP Offloading (TOE) is enabled.

Additional Information

https://www.dell.com/support/kbdoc/en-uk/printview/000020713/10/en 4/8
8/6/2021 XtremIO: Host Configuration Validation Script for ESX | Dell UK

Running the ESX Host Validation Script Directly From the

PowerCLI
1. Download from this article the XtremIO_ESX_Configuration_Validation script.
2. Download the VMware PowerCLI 6.5 . This may already be installed on your PC. If not already installed, then please download as
described in the Downloads section below.
3. Open a PowerCLI console as administrator. One method to perform this is to open the PowerCLI from the Start menu using the
option Run as Administrator.

4. Set the ExecutionPolicy by executing the following command:

> Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass

5. PowerCLI 10.x  and PowerCLI 11.x only: Set the PowerCLI configuration to ignore an invalid certificate. 
Set-PowerCLIConfiguration -InvalidCertificateAction Ignore

6. From the PowerCLI shell invoke the command:

> .\check_esx_config.ps1 [parameters]

The following parameters can be specified:

> .\check_esx_config.ps1 [parameters] -help

-vcenter_server <vCenter server name or ip address>   (mandatory in batch mode unless using the -version or -help
options.)

-vcenter_user <vCenter user name>                    (mandatory in batch mode unless using the -version or -help
options.)

-vcenter_password <vCenter password>                 (mandatory in batch mode unless using the -version or -help
options.)

-esx_host <"all", ESX host name or ip address, or comma separated list>  (mandatory in batch unless using the -
version or -help options. "all" will validate the configuration of all hosts on the given vCenter.)

[-mixed_storage true|false]

 [-logpath <log directory fullpath>]

[-batch]

 [-xms_name <string - IP address or hostname> ]

 [-xms_user <string - XMS authorized user> ]

 [-xms_password <string> ]

[-version]

[-help]

    If a mandatory parameter is not specified and -batch is not specified, the user is prompted to enter it.
https://www.dell.com/support/kbdoc/en-uk/printview/000020713/10/en 5/8
8/6/2021 XtremIO: Host Configuration Validation Script for ESX | Dell UK

-mixed_storage true|false - specifies whether this is a mixed storage environment - with XtremIO and non-XtremIO
clusters attached to the host. By default, the script attempts to determine this value.

-logpath specifies the logs directory. If logpath is not specified, the default is the Logs directory (sibling to the ESX
directory).

-batch  when specified the script will not prompt for inputs.

-version  print the script version and exit

-help     print the help page and exit

Example:

.\check_esx_config.ps1 -vcenter_server applab.lab.emc.com -vcenter_user administrator@vsphere.local -

vcenter_password xxx123Q# -esx_host hpk27.emc.com

7. Log the usage of the script. Documenting the execution of the validation script will ensure that the results will be available for future
Support activities.

a. Link this KBA ( KB Article #000020713 XtremIO: Host Configuration Validation Script for ESX ) to any SR opened
where this script was used.

b. Attach the output logs produced by the script to the SR.

c. Copy pertinent snippets of the output logs to the SR. 

Downloads
PowerCLI 6.5 or PowerCLI 11.5 shell.  Note: you'll need to subscribe for a free account with VMware before you can download.
The validation script is attached below. 
File Size Checksum
MD5:

222431BFD0C3780BC2BBEC154E875782
ESX_Configuration_Validation_1.1.2_csp.zip   41K 
SHA256:

4DC0C9CA9FCB97DD7C7ED4270E3DEB26BF1FABB6061F11B26445192BEC2B2188

  Release Notes  

Updated in 1.1.2

Support to validate that ESXi with Cisco nfnic FC HBAs are using nfnic driver version 4.0.0.63 (or later). VMware KB#80101

Updated in 1.1.1.1

Support to validate VAAI ATS heartbeat setting

Updated in 1.1.1:

Added support for Native OneConnect drivers (nfnic)

Header and footer text updated
Grouping of multiple instances of the same issue

Fixed in 1.0.8:

Fixed bug in the logger that affected incomplete logging of events 

Fixed in 1.0.7

xms credentials are optional parameter, used to (1) improve the multipath validations, (2) to detect if the vXMS is using the storage
it is managing and (3) validate that the OS type assigned assigned in the xms to the Initiators are consistent with the host OS type
of ESX. 
bug in validating the SchedNumReqOutstanding fixed  
Improved multipath validation and error message 

https://www.dell.com/support/kbdoc/en-uk/printview/000020713/10/en 6/8
8/6/2021 XtremIO: Host Configuration Validation Script for ESX | Dell UK

offline XtremIO LUNs are detected with an alert printed

APD/PDL connectivity mode validation on XMS side
improved error message for unsupported HBA detected
fixed various validation issues when using the mixed_storage flag.
Fix bug of not processing correctly multiple ESX hosts provided as arguments via command line (comma separated values)

 
DISCLAIMERS:

This script is provided 'as-is' and is provided in, and expected to be used in, good faith

as a convenient means to validate host systems are configured according to the

recommendations of the Host Configuration Guide. No warranty whatsoever is expressed or

implied and no responsibility nor culpability will be accepted for problems directly or indirectly resulting from its use.

 By downloading all or any portion of the software you accept all of the terms and conditions

of the EMC SOFTWARE TOOLS LICENSE AGREEMENT attached to this KB article.

The following recommendations from the Host Configuration Guide are not validated by the script. These must be manually verified:

vXMS is not deployed on an XtremIO LUN  - unless xms credentials used 

APD/PDL setting - this is a cluster setting. Please see EMC KB 483391 for additional information - unless xms credentials used 
NIC Partitioning should be disabled (NPAR: utilizing iSCSI interface for multiple storage iSCSI).
FC Adapter Policy IO Throttle Count for Cisco UCS.
Minimum I/O timeout on the HBAs for Cisco UCS.
RDM volumes used by the virtual machine should be spanned across SCSI controllers.
Virtual machines should be aligned.
'Boot from SAN' should be defined properly (if used).
maxCostPerHost on the vCenter - the correct value depends on the cluster size (single, dual...)
TCP Offloading (TOE) is enabled.

Known Issues:
Clusters created prior to 4.x (even if currently running 4.x) are not validated for redundant multipathing - unless xms
credentials used 
"Qlogic drivers" in the HVS and in the Host Configuration Guide refers only to drivers with the prefix of "ql". Qlogic drivers with other
prefixes, such as "bnx", are not included.
"Emulex drivers" in the HVS refers only to drivers with the name "lpfc". Emulex drivers with other prefixes, such as "brcmfcoe", are
not included.
When an XMS is managing multiple clusters the initiator detection may incorrectly provide a Warning message that an initiator is
not found in an XMS. This message is printed for each cluster in the XMS without the initiator. In many cases this is valid since the
design may be for the initiator to not be configured for all the clusters. For example:

### Performing XMS-Connectivity-Dependent Checks ###

WARNING: The initiator address 10:00:00:90:fa:d7:16:92 is not configured at all on XtremIO XMS

WARNING: The initiator address 10:00:00:90:fa:d7:16:93 is not configured at all on XtremIO XMS

WARNING: The initiator address 10:00:00:90:fa:d7:11:de is not configured at all on XtremIO XMS

WARNING: The initiator address 10:00:00:90:fa:d7:11:df is not configured at all on XtremIO XMS

Troubleshooting tips when running the HVS from within the ESXi Grab:

When HVS runs successfully there will be a folder named \XIO_ESX_checker in the grab output zip file. Otherwise HVS did not
run successfully. Please try the following steps:   

1. Make sure PowerCLI was downloaded and that the ESXi Grab parameters used include the  host, -vcenter_ switches, see
examples above.
2. Ensure that the Execution Policy is properly set.  The execution policy may be set from the PowerCLI window when run as
Adminstrator:  Set-ExecutionPolicy -Scope LocalMachine -ExecutionPolicy RemoteSigned. After running the
script the Execution policy should be restored to its previous values, e.g. Set-ExecutionPolicy -Scope LocalMachine -
ExecutionPolicy Undefined.

https://www.dell.com/support/kbdoc/en-uk/printview/000020713/10/en 7/8
8/6/2021 XtremIO: Host Configuration Validation Script for ESX | Dell UK

3. A new Windows command window may need to be be opened, to execute the emcgrab command, after the execution policy is
configured.
4. emcgrab.exe should be executed from a windows command prompt not a PowerCLI prompt.

Please watch this video which is also published on YouTube:

XtremIO: How to Run Host Configuration Validation Scripts…

Scripts…

Related KBAs:

The Host Validation for Linux hosts is available: XtremIO: Host Configuration Validation Script for Linux

The Host Validation for Windows hosts is available: XtremIO: Host Configuration Validation Script for Windows
Article Properties

Affected Product

XtremIO Family

Product
XtremIO Family, XtremIO HW Gen2 400GB, XtremIO HW Gen2 400GB Encrypt Capbl, XtremIO HW Gen2 400GB Encrypt Disable,
XtremIO HW Gen2 400GB Exp Encrypt Disable, XtremIO HW Gen2 800GB Encrypt Capbl, XtremIO HW Gen3 40TB, XtremIO HW Gen3
40TB Encrypt Disable, XtremIO HW X2-R, XtremIO HW X2-R Encrypt Disable, XtremIO HW X2-S, XtremIO HW X2-S Encrypt Disable,
XtremIO HW X2-T, XtremIO X1, XtremIO X2

Last Published Date

20 Apr 2021

Version

Article Type
How To

https://www.dell.com/support/kbdoc/en-uk/printview/000020713/10/en 8/8