vSAN Management API
|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - HostVsanSystem(vim.host.VsanSystem)
- Property of
- HostConfigManager
- See also
- HostMaintenanceSpec, HostScsiDisk, VsanHostClusterStatus, VsanHostConfigInfo, VsanHostDiskMapping, VsanHostDiskMapResult, VsanHostDiskResult
- Since
- vSphere API Release 5.5
Managed Object Description
The VsanSystem managed object type exposes VSAN configuration primitives and serves as a host-level access point for relevant VSAN data objects.Properties
| Name | Type | Description |
|---|---|---|
| config P | VsanHostConfigInfo |
The current VSAN service configuration information for this host.
|
Methods
| Methods defined in this Managed Object |
|---|
| AddDisks_Task, EvacuateVsanNode_Task, InitializeDisks_Task, QueryDisksForVsan, QueryHostStatus, RecommissionVsanNode_Task, RemoveDisk_Task, RemoveDiskMapping_Task, UnmountDiskMapping_Task, UpdateVsan_Task |
AddDisks_Task(addDisks)
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 VsanHostDiskMapping, 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 result.Mount a VsanHostDiskMapping if the specified disk belongs to the unmounted mapping and is of type ssd.
Upon successful completion of the returned Task, its
result field will be populated with a
VsanHostDiskMapResult[] and caller must inspect
VsanHostDiskMapResult[] to check result for individual
VsanHostDiskMapping.
See QueryDisksForVsan
See autoClaimStorage
See mounted
- Required Privileges
- Host.Config.Storage
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call. |
| disk | HostScsiDisk[] |
list of disks to add for use by the VSAN service See QueryDisksForVsan See autoClaimStorage See mounted Since vSphere API Release 5.5 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
EvacuateVsanNode_Task(evacuateNode)
Evacuate this host from VSAN cluster.The task is cancellable.
- Required Privileges
- Host.Config.Storage
- Since
- vSphere API Release 6.0
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call. |
| maintenanceSpec | HostMaintenanceSpec |
Specifies the data evacuation mode. See HostMaintenanceSpec.
If unspecified, the default mode chosen will be
vim.vsan.host.DecommissionMode.ObjectAction#ensureObjectAccessibility.
Since vSphere API Release 6.0 |
| timeout | xsd:int |
Time to wait for the task to complete in seconds.
If the value is less than or equal to zero, there
is no timeout. The operation fails with a Timedout
exception if it timed out.
Since vSphere API Release 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidState | Thrown if the host is entering maintenance mode or evacuating data. |
| RequestCanceled | Thrown if the operation is canceled. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| Timedout | Thrown if the operation timed out. |
| VsanFault | Thrown if operation fails with VSAN-specific error. |
Events
| Type | |
|---|---|
| None | |
InitializeDisks_Task(initializeDisks)
Initialize and use the sets of disks in the given VsanHostDiskMapping 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 VsanHostDiskMapping, users need to specify only the new non-SSDs with its ssd.Mount a VsanHostDiskMapping if the specified VsanHostDiskMapping is not mounted in this host.
Upon successful completion of the returned Task, its
result field will be populated with a
VsanHostDiskMapResult[] and caller must inspect
VsanHostDiskMapResult[] to check result for individual
VsanHostDiskMapping.
See QueryDisksForVsan
See autoClaimStorage
- Required Privileges
- Host.Config.Storage
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call. |
| mapping | VsanHostDiskMapping[] |
list of disk mappings to initialize See QueryDisksForVsan See autoClaimStorage Since vSphere API Release 5.5 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
QueryDisksForVsan(queryDisksForVsan)
Queries disks on this host for suitability to use with the VSAN service, and returns the result.See vim.host.ScsiDisk#canonicalName
- Required Privileges
- System.Read
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call. |
| canonicalName* | xsd:string[] |
may be set to restrict the query to the list of
HostScsiDisk objects named by the
given paths See vim.host.ScsiDisk#canonicalName Since vSphere API Release 5.5 |
Return Value
| Type | Description |
|---|---|
| VsanHostDiskResult[] | A list of populated VsanHostDiskResult entries |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
QueryHostStatus(queryHostStatus)
Queries this host's current runtime status for the VSAN service.- Required Privileges
- System.Read
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| VsanHostClusterStatus | A populated VsanHostClusterStatus entry |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
RecommissionVsanNode_Task(recommissionNode)
Recommission this host to VSAN cluster.
Users may use this API to recommission a node that has been
evacuated in VsanHostDecommissionMode.
See EvacuateVsanNode_Task
See VsanHostDecommissionMode
- Required Privileges
- Host.Config.Storage
- Since
- vSphere API Release 6.0
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidState | Thrown if the host is not evacuated. See EvacuateVsanNode_Task See VsanHostDecommissionMode |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| VsanFault | Thrown if operation fails with VSAN-specific error. See EvacuateVsanNode_Task See VsanHostDecommissionMode |
Events
| Type | |
|---|---|
| None | |
RemoveDisk_Task(removeDisk)
Remove the set of given disks from use by the VSAN service on this host. Users may use this API to manually remove a nonSsd from a VsanHostDiskMapping. 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 nonSsd from any given VsanHostDiskMapping. Removal of the last nonSsd can be accomplished by using RemoveDiskMapping_Task.
Upon successful completion of the returned Task, its
result field will be populated with a
VsanHostDiskResult[]. Sets DiskIsLastRemainingNonSSD fault
in returned task if specified disk is the last
nonSsd member of
VsanHostDiskMapping.
See RemoveDiskMapping_Task
See UpdateVsan_Task
See autoClaimStorage
- Required Privileges
- Host.Config.Storage
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call. |
| disk | HostScsiDisk[] |
list of disks to be removed from use by the VSAN service. See RemoveDiskMapping_Task See UpdateVsan_Task See autoClaimStorage Since vSphere API Release 5.5 |
| maintenanceSpec* | HostMaintenanceSpec |
Any additional actions to move data out of the disk
before removing it. See HostMaintenanceSpec.
If unspecified, there is no action taken to move
data from the disk. See RemoveDiskMapping_Task See UpdateVsan_Task See autoClaimStorage Since vSphere API Release 5.5 |
| timeout* | xsd:int |
Time to wait for the task to complete in seconds.
If the value is less than or equal to zero, there
is no timeout. The operation fails with a Timedout
exception if it timed out. See RemoveDiskMapping_Task See UpdateVsan_Task See autoClaimStorage Since vSphere API Release 5.5 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
RemoveDiskMapping_Task(removeDiskMapping)
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 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 Task, its
result field will be populated with an empty
VsanHostDiskMapResult[]. If any errors are encountered,
the returned field will instead contain populated error information.
See RemoveDisk_Task
See UpdateVsan_Task
See autoClaimStorage
- Required Privileges
- Host.Config.Storage
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call. |
| mapping | VsanHostDiskMapping[] |
list of disk mappings to be removed from VSAN usage. See RemoveDisk_Task See UpdateVsan_Task See autoClaimStorage Since vSphere API Release 5.5 |
| maintenanceSpec* | HostMaintenanceSpec |
Any additional actions to move data out of the disk
before removing it. See HostMaintenanceSpec.
If unspecified, there is no action taken to move
data from the disk. See RemoveDisk_Task See UpdateVsan_Task See autoClaimStorage Since vSphere API Release 5.5 |
| timeout* | xsd:int |
Time to wait for the task to complete in seconds.
If the value is less than or equal to zero, there
is no timeout. The operation fails with a Timedout
exception if it timed out. See RemoveDisk_Task See UpdateVsan_Task See autoClaimStorage Since vSphere API Release 5.5 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
UnmountDiskMapping_Task(unmountDiskMapping)
Unmount the mounted VsanHostDiskMapping. An unmounted volume cannot be used for any VSAN operations. In contrast to RemoveDiskMapping_Task, this operation does not destroy or alter VSAN data on the disks. AddDisks_Task and InitializeDisks_Task 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 Task, its
result field will be populated with
VsanHostDiskMapResult[]. If any errors are encountered,
the returned field will instead contain populated error information.
See RemoveDiskMapping_Task
See AddDisks_Task
See InitializeDisks_Task
- Required Privileges
- Host.Config.Storage
- Since
- vSphere API Release 6.0
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call. |
| mapping | VsanHostDiskMapping[] |
See RemoveDiskMapping_Task See AddDisks_Task See InitializeDisks_Task Since vSphere API Release 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidState | Thrown if the VsanHostDiskMapping is already unmounted. See RemoveDiskMapping_Task See AddDisks_Task See InitializeDisks_Task |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| VsanFault | Thrown if operation fails with VSAN-specific error. See RemoveDiskMapping_Task See AddDisks_Task See InitializeDisks_Task |
Events
| Type | |
|---|---|
| None | |
UpdateVsan_Task(update)
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 enabled flag.
Host storage settings can be specified through use of
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
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
networkInfo. If this value is omitted,
changes will not be made to the existing network configuration.
See VsanHostConfigInfo
See storageInfo
See clusterInfo
See networkInfo
See QueryDisksForVsan
- Required Privileges
- Host.Config.Storage
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call. |
| config | VsanHostConfigInfo |
host configuration settings to use for the VSAN service. See VsanHostConfigInfo See storageInfo See clusterInfo See networkInfo See QueryDisksForVsan Since vSphere API Release 5.5 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |