Enumerated Types Overview

An enumerated data type (or, simply, an “enumeration”) is a data object that defines a specific set of pre-defined values. Enumerated data types serve the same purpose as constants.

For example, the VsanHealthPerspective enumerated type defines the values that indicate the supported perspectives in vSAN health checks:

beforeConfigureHost
CreateExtendClusterView
defaultView
deployAssist
upgradeAfterExitMM
upgradeBeforeExitMM
upgradePreCheck
vmcUpgradePreChecks
VsanHealthPerspective_Unknown
vsanUpgradeAfterExitMM
vsanUpgradeBeforeExitMM
vsanUpgradePreCheck

A data object property that uses an enumerated type is defined as a string type. For example, the QueryClusterHealthSummary method need a parameter perspective. The value of this parameter is the string equivalent of one of the compliance status enumerated type values.

All enumerations are listed in the frame at the left of this page. Click a name to display the reference documentation for the enumeration. Reference documentation for enumerated types typically includes:

Description of purpose and usage.
A list of valid enum constant values.

To quickly find any entry, start typing its name in the Quick Index.

Back to Home