vSAN Management API


Data Object - VsanPrepareVsanForVcsaSpec(vim.vsan.VsanPrepareVsanForVcsaSpec)

Parameter to
VsanPrepareVsanForVcsa
Extends
DynamicData
See also
VimVsanHostDiskMappingCreationSpec, VsanAddStoragePoolDiskSpec, VsanDataEfficiencyConfig, VsanHostCreateNativeKeyProviderSpec, VsanHostEncryptionInfo
Since
vSphere API Release 6.5

Data Object Description

All configuration parameters for preparing vSAN on a host where VCSA will be deployed

Properties

Name Type Description
createNativeKeyProviderSpec*VsanHostCreateNativeKeyProviderSpec

Specification used to create native key provider on host.

Since 8.0.0.1
taskId*xsd:string

Unique identifier of the task this progress report is for.
vsanAddStoragePoolDiskSpec*VsanAddStoragePoolDiskSpec

If set, vCSA Deployer will claim those disks as vSAN ESA storage pool, and a vSAN ESA datastore will be created. By passing in this spec, it implies the host will be contributing disk storage to a vSAN ESA cluster, therefore vSAN ESA will be automatically enabled on the host, if it's not yet enabled. Note: This paramemter cannot be used together with vsanDiskMappingCreationSpec

Since 8.0.0.1
vsanDataEfficiencyConfig*VsanDataEfficiencyConfig

The data efficiency config for vSAN.
vsanDataEncryptionConfig*VsanHostEncryptionInfo

The data encryption config that will be used to bootstrap single node vSAN cluster, this config contains the fields as below: enabled: True if encryption should be enabled. kmipServers: Array of KmipServerSpec For AWS, KMS server address is AWS KMS key ARN starting with "arn:aws" kmsServerCerts: Certificates of Key Management Servers in PEM encoding. Host will use these certificates to decide if a KMS should be trusted or not. clientKey: Client private key. Host will use this key for authentication when connecting to KMS. clientCert: Client certificate in PEM encoding. Host will use this certificate for authentication when connecting to KMS. Three kms types(KMIP, AWS, NKP) are supported for now. And each KMS type requires different fields as below:
KMS type Required fields
KMIP
  • enabled
  • kmipServers
  • kmsServerCerts
  • clientKey
  • clientCert
AWS
  • enabled
  • kmipServers
  • kmsServerCerts
NKP
  • enabled

Since VMC M5
vsanDiskMappingCreationSpec*VimVsanHostDiskMappingCreationSpec

If set, vCSA Deployer will claim those disks as vSAN disk groups, and a vSAN datastore will be created. By passing in this spec, it implies the host will be contributing disk storage to a vSAN cluster, therefore vSAN will be automatically enabled on the host, if it's not yet enabled.
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition