Scripting Object - VcHostVsanSystem

Scripting-object corresponding to
HostVsanSystem
Attribute of
VcHostConfigManager

Scripting Object Description

The VsanSystem managed object type exposes VSAN configuration primitives and serves as a host-level access point for relevant VSAN data objects.

Attributes

Name Type Description
configVcVsanHostConfigInfo

@since vSphere API 5.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, addDisks_Task, createTrigger, evacuateVsanNode_Task, fetchVsanSharedSecret, initializeDisks_Task, queryDisksForVsan, queryHostStatus, recommissionVsanNode_Task, removeDisk_Task, removeDiskMapping_Task, unmountDiskMapping_Task, updateVsan_Task

fetchVsanSharedSecret

Get the shared secret generated by VSAN VASA provider. This API is internal and intended to be used by VMware internal modules only. @since vSphere API 5.5

Parameters

NameTypeDescription
None

Return Value

Type Description
String

updateVsan_Task

Update the VSAN service on this host according to the given host configuration specification.

Enabling and disabling the VSAN service can be achieved by using the {@link vim.vsan.host.ConfigInfo#enabled} flag. Host storage settings can be specified through use of {@link vim.vsan.host.ConfigInfo#storageInfo}. If this value is omitted, changes will not be made to the existing storage configuration. Host cluster settings can be specified through use of {@link vim.vsan.host.ConfigInfo#clusterInfo}. If this value is omitted, changes will not be made to the existing cluster configuration. Host network settings can be specified through use of {@link vim.vsan.host.ConfigInfo#networkInfo}. If this value is omitted, changes will not be made to the existing network configuration. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcVsanHostConfigInfo


Return Value

Type Description
VcTask

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

evacuateVsanNode_Task

Evacuate this host from VSAN cluster.

The task is cancellable. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcHostMaintenanceSpec

arg1Number


Return Value

Type Description
VcTask

removeDiskMapping_Task

Delete given set of disk mappings from use by the VSAN service on this host. This API may be used to remove all disks in a given mapping, including its {@link DiskMapping#ssd}. This operation is only permitted if the VSAN service on this host is not configured to automatically claim storage.

The task is cancellable.

Upon successful completion of the returned {@link vim.Task}, its {@link vim.TaskInfo#result} field will be populated with an empty {@link vim.vsan.host.DiskMapResult}[]. If any errors are encountered, the returned field will instead contain populated error information. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcVsanHostDiskMapping []

arg1VcHostMaintenanceSpec

arg2Number


Return Value

Type Description
VcTask

initializeDisks_Task

Initialize and use the sets of disks in the given {@link DiskMapping} list for the VSAN service on this host. Users may use this API to specify or change disk mappings when the VSAN service is not configured to automatically claim storage. For appending new non-SSDs to an existing {@link DiskMapping}, users need to specify only the new non-SSDs with its {@link DiskMapping#ssd}.

Mount a {@link DiskMapping} if the specified {@link DiskMapping} is not mounted in this host.

Upon successful completion of the returned {@link vim.Task}, its {@link vim.TaskInfo#result} field will be populated with a {@link vim.vsan.host.DiskMapResult}[] and caller must inspect {@link vim.vsan.host.DiskMapResult}[] to check result for individual {@link DiskMapping}. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcVsanHostDiskMapping []


Return Value

Type Description
VcTask

queryHostStatus

Queries this host's current runtime status for the VSAN service. @since vSphere API 5.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcVsanHostClusterStatus

removeDisk_Task

Remove the set of given disks from use by the VSAN service on this host. Users may use this API to manually remove a {@link DiskMapping#nonSsd} from a {@link DiskMapping}. This operation is only permitted if the VSAN service on this host is not configured to automatically claim storage.

The task is cancellable.

This method may not be used to remove the last {@link DiskMapping#nonSsd} from any given {@link DiskMapping}. Removal of the last {@link DiskMapping#nonSsd} can be accomplished by using {@link VsanSystem#removeDiskMapping}.

Upon successful completion of the returned {@link vim.Task}, its {@link vim.TaskInfo#result} field will be populated with a {@link vim.vsan.host.DiskResult}[]. Sets DiskIsLastRemainingNonSSD fault in returned task if specified disk is the last {@link DiskMapping#nonSsd} member of {@link DiskMapping}. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcHostScsiDisk []

arg1VcHostMaintenanceSpec

arg2Number


Return Value

Type Description
VcTask

recommissionVsanNode_Task

Recommission this host to VSAN cluster.

Users may use this API to recommission a node that has been evacuated in {@link vim.vsan.host.DecommissionMode}. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcTask

addDisks_Task

Add the set of given disks for use by the VSAN service on this host. Users may use this API to manually add disks for use by VSAN, without specifying an explicit {@link DiskMapping}, when the VSAN service not configured to automatically claim storage. Any ineligible disk in the set of given disks and disks which would have exceeded the capacity will be ignored and will not be published in returned {@link vim.TaskInfo#result}.

Mount a {@link DiskMapping} if the specified disk belongs to the unmounted mapping and is of type {@link DiskMapping#ssd}.

Upon successful completion of the returned {@link vim.Task}, its {@link vim.TaskInfo#result} field will be populated with a {@link vim.vsan.host.DiskMapResult}[] and caller must inspect {@link vim.vsan.host.DiskMapResult}[] to check result for individual {@link DiskMapping}. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcHostScsiDisk []


Return Value

Type Description
VcTask

queryDisksForVsan

Queries disks on this host for suitability to use with the VSAN service, and returns the result. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcVsanHostDiskResult []

unmountDiskMapping_Task

Unmount the mounted {@link DiskMapping}. An unmounted volume cannot be used for any VSAN operations. In contrast to {@link VsanSystem#removeDiskMapping}, this operation does not destroy or alter VSAN data on the disks. {@link VsanSystem#addDisks} and {@link VsanSystem#initializeDisks} can be used to re-mount the diskMapping.

In case of shared-SAS, where diskMappings are visible to more than one VSAN hosts, Users may use this API to manually unmount and re-mount diskMappings.

Upon successful completion of the returned {@link vim.Task}, its {@link vim.TaskInfo#result} field will be populated with {@link vim.vsan.host.DiskMapResult}[]. If any errors are encountered, the returned field will instead contain populated error information. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcVsanHostDiskMapping []


Return Value

Type Description
VcTask