VimVsanReconfigSpec
VimVsanReconfigSpec
The vSAN reconfiguration specification.
AllOf
This class requires all of the following:
JSON Example
{
"_typeName": "string",
"vsanClusterConfig": {
"_typeName": "string",
"enabled": false,
"defaultConfig": {
"_typeName": "string",
"uuid": "string",
"autoClaimStorage": false,
"checksumEnabled": false
},
"vsanEsaEnabled": false
},
"dataEfficiencyConfig": {
"_typeName": "string",
"dedupEnabled": false,
"compressionEnabled": false
},
"diskMappingSpec": {
"_typeName": "string",
"hostDiskMappings": [
{
"_typeName": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"cacheDisks": [
{
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string",
"capacity": {
"_typeName": "string",
"blockSize": 0,
"block": 0
},
"devicePath": "string",
"ssd": false,
"localDisk": false,
"physicalLocation": [
"string"
],
"emulatedDIXDIFEnabled": false,
"vsanDiskInfo": {
"_typeName": "string",
"vsanUuid": "string",
"formatVersion": 0
},
"scsiDiskType": "string",
"usedByMemoryTiering": false
}
],
"capacityDisks": [
{
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string",
"capacity": {
"_typeName": "string",
"blockSize": 0,
"block": 0
},
"devicePath": "string",
"ssd": false,
"localDisk": false,
"physicalLocation": [
"string"
],
"emulatedDIXDIFEnabled": false,
"vsanDiskInfo": {
"_typeName": "string",
"vsanUuid": "string",
"formatVersion": 0
},
"scsiDiskType": "string",
"usedByMemoryTiering": false
}
],
"type": "string"
}
]
},
"faultDomainsSpec": {
"_typeName": "string",
"faultDomains": [
{
"_typeName": "string",
"hosts": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
],
"name": "string"
}
],
"witness": {
"_typeName": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"preferredFaultDomainName": "string",
"diskMapping": {
"_typeName": "string",
"ssd": {
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string",
"capacity": {
"_typeName": "string",
"blockSize": 0,
"block": 0
},
"devicePath": "string",
"ssd": false,
"localDisk": false,
"physicalLocation": [
"string"
],
"emulatedDIXDIFEnabled": false,
"vsanDiskInfo": {
"_typeName": "string",
"vsanUuid": "string",
"formatVersion": 0
},
"scsiDiskType": "string",
"usedByMemoryTiering": false
},
"nonSsd": [
{
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string",
"capacity": {
"_typeName": "string",
"blockSize": 0,
"block": 0
},
"devicePath": "string",
"ssd": false,
"localDisk": false,
"physicalLocation": [
"string"
],
"emulatedDIXDIFEnabled": false,
"vsanDiskInfo": {
"_typeName": "string",
"vsanUuid": "string",
"formatVersion": 0
},
"scsiDiskType": "string",
"usedByMemoryTiering": false
}
]
},
"storagePoolSpec": {
"_typeName": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"disks": [
{
"_typeName": "string",
"diskName": "string",
"diskType": "string"
}
]
}
}
},
"modify": false,
"allowReducedRedundancy": false,
"resyncIopsLimitConfig": {
"_typeName": "string",
"resyncIops": 0
},
"iscsiSpec": {
"_typeName": "string",
"defaultConfig": {
"_typeName": "string",
"networkInterface": "string",
"port": 0,
"iscsiTargetAuthSpec": {
"_typeName": "string",
"authType": "string",
"userNameAttachToTarget": "string",
"userSecretAttachToTarget": "string",
"userNameAttachToInitiator": "string",
"userSecretAttachToInitiator": "string"
}
},
"enabled": false,
"vipConfigs": [
{
"_typeName": "string",
"enabled": false,
"v4NetworkConfig": {
"_typeName": "string",
"ipAddress": "string",
"subnet": "string",
"gateway": "string"
},
"v6NetworkConfig": {
"_typeName": "string",
"ipAddress": "string",
"subnet": "string",
"gateway": "string"
},
"vswitchConfig": {
"_typeName": "string",
"vswitchName": "string",
"vlanId": 0
},
"distributedSwitchConfig": {
"_typeName": "string",
"portGroup": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"dvsUuid": "string"
}
}
],
"homeObjectStoragePolicy": {
"_typeName": "string"
}
},
"dataEncryptionConfig": {
"_typeName": "string",
"encryptionEnabled": false,
"kmsProviderId": {
"_typeName": "string",
"id": "string"
},
"kekId": "string",
"hostKeyId": "string",
"dekGenerationId": 0,
"changing": false,
"eraseDisksBeforeUse": false,
"wrappedDek": "string",
"dekId": "string",
"oldWrappedDek": "string",
"oldDekId": "string",
"kekVerifier": "string",
"dekVerifier": "string",
"oldDekVerifier": "string",
"iv": "string",
"syncing": false
},
"extendedConfig": {
"_typeName": "string",
"objectRepairTimer": 0,
"disableSiteReadLocality": false,
"enableCustomizedSwapObject": false,
"largeScaleClusterSupport": false,
"proactiveRebalanceInfo": {
"_typeName": "string",
"enabled": false,
"threshold": 0
},
"capacityReservationInfo": {
"_typeName": "string",
"hostRebuildThreshold": "string",
"vsanOpSpaceThreshold": "string"
}
},
"datastoreConfig": {
"_typeName": "string",
"datastores": [
{
"_typeName": "string",
"uuid": "string",
"name": "string"
}
]
},
"perfsvcConfig": {
"_typeName": "string",
"enabled": false,
"profile": {
"_typeName": "string"
},
"diagnosticMode": false,
"verboseMode": false
},
"unmapConfig": {
"_typeName": "string",
"enable": false
},
"vumConfig": {
"_typeName": "string",
"baselinePreferenceType": "string"
},
"metricsConfig": {
"_typeName": "string",
"profiles": [
{
"_typeName": "string",
"authToken": "string"
}
]
},
"fileServiceConfig": {
"_typeName": "string",
"enabled": false,
"fileServerMemoryMB": 0,
"fileServerCPUMhz": 0,
"fsvmMemoryMB": 0,
"fsvmCPU": 0,
"network": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"domains": [
{
"_typeName": "string",
"name": "string",
"dnsServerAddresses": [
"string"
],
"dnsSuffixes": [
"string"
],
"fileServerIpConfig": [
{
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
},
"fqdn": "string",
"isPrimary": false,
"gateway": "string",
"affinityLocation": "string",
"ipv6Gateway": "string"
}
],
"directoryServerConfig": {
"_typeName": "string"
},
"version": "string"
}
],
"fileAnalyticsEnabled": false
},
"rdmaConfig": {
"_typeName": "string",
"rdmaEnabled": false
},
"dataInTransitEncryptionConfig": {
"_typeName": "string",
"enabled": false,
"rekeyInterval": 0
},
"mode": "string",
"vsanHealthConfig": {
"_typeName": "string",
"healthCheckThresholdSpec": [
{
"_typeName": "string",
"yellowValue": 0,
"redValue": 0,
"target": "string",
"enabled": false
}
],
"historicalHealthConfig": {
"_typeName": "string",
"enabled": false
}
},
"vsanEsaConfig": {
"_typeName": "string",
"storagePoolSpecs": [
{
"_typeName": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"disks": [
{
"_typeName": "string",
"diskName": "string",
"diskType": "string"
}
]
}
],
"hclDiskClaimEnabled": false,
"datastoreDefaultPolicySelectionConfig": {
"_typeName": "string",
"enabled": false
},
"diskConfiguration": {
"_typeName": "string",
"diskClaimConfiguration": [
{
"_typeName": "string",
"diskType": "string",
"diskNamePrefix": "string",
"numberOfDisks": 0,
"diskModel": "string",
"vendor": "string",
"diskCapacity": 0
}
]
}
},
"xvcDatastoreConfig": {
"_typeName": "string",
"xvcDatastores": [
{
"_typeName": "string",
"datastore": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"ownerVc": "string"
}
]
},
"serverClusterConfig": {
"_typeName": "string",
"serverClusters": [
{
"_typeName": "string",
"clusterUuid": "string",
"networkTopology": "string",
"siteAffinity": [
{
"_typeName": "string",
"clientSite": {
"_typeName": "string",
"name": "string"
},
"serverSite": {
"_typeName": "string",
"name": "string"
}
}
]
}
]
},
"snapServiceConfig": {
"_typeName": "string",
"enabled": false
},
"deconvergedNetConfig": {
"_typeName": "string",
"enabled": false
}
}
vsanClusterConfig
Optional
vSAN configuration, includes default settings for hosts.
dataEfficiencyConfig
Optional
The data efficiency configuration for vSAN.
vSAN 6.2 accomplishes data efficiency by deduplication and compression, which will be enabled or disabled together.
diskMappingSpec
Optional
vSAN disk group configuration specification.
faultDomainsSpec
Optional
Spec for configuring the fault domains.
It includes a list of VimClusterVsanFaultDomainSpec and a VimClusterVsanWitnessSpec. If VimClusterVsanWitnessSpec is specified which indicates it a stretched cluster, the fault domain list needs to include exactly two fault domain items.
boolean
modify
Required
Flag to specify whether the specification ("spec") should be applied incrementally.
If "modify" is false and the operation succeeds, then the configuration of the vSAN cluster matches the specification exactly; in this case any unset portions of the specification will result in unset or default portions of the configuration.
boolean
allowReducedRedundancy
Optional
This optional parameter is applicable to certain vSAN cluster reconfigure operations that need to migrate data across cluster for changing vSAN disk format.
In vSAN version 6.2, enable or disable deduplication and compression in a cluster is such kind of operation. The default value 'false' will instruct the data migration process to move all the storage object data in the host under processing to other hosts to ensure the data stays fully protected; while the value 'true' may make the process move less data for just ensuring storage object accessibility, and some objects will be kept at "reduced redundancy" state, i.e., at a higher risk in case of a hardware failure during the migration process. However, value 'true' is useful and even the only option when cluster does not have enough host or free storage to ensure the data stays fully protected during data migration. See ensureObjectAccessibility and evacuateAllData.
resyncIopsLimitConfig
Optional
vSAN throttling IOPS limit configuration specification.
iscsiSpec
Optional
vSAN iSCSI configuration.
dataEncryptionConfig
Optional
The data encryption configuration for vSAN.
extendedConfig
Optional
vSAN extended configurations.
datastoreConfig
Optional
vSAN datastore configuration.
perfsvcConfig
Optional
vSAN performance service configuration.
unmapConfig
Optional
SCSI unmap command configuration on vSAN.
vumConfig
Optional
vSAN build recommendation engine configuration for this vSAN cluster.
Build recommendation engine would use it to generate different baselines for this vSAN cluster. See VsanVumConfig
metricsConfig
Optional
vSAN metrics configuration for all monitor clients
fileServiceConfig
Optional
vSAN file service configurations.
rdmaConfig
Optional
RDMA Spec for vSAN.
dataInTransitEncryptionConfig
Optional
vSAN configuration for data-in-transit encryption.
vsanHealthConfig
Optional
vSAN Health configuration.
vsanEsaConfig
Optional
Configurations for vSAN ESA.
xvcDatastoreConfig
Optional
vSAN cross VC datastore configuration.
serverClusterConfig
Optional
Server cluster configuration for HCI Mesh.
snapServiceConfig
Optional
The configuration for vSAN Snapshot service.
The Snapshot service configuration will require specific User role and privileges. TODO: Update required privileges and the implementaiton to include the necessary validations.
Since: 8.0.0.4
deconvergedNetConfig
Optional
De-converged network configuration for vSAN.