# Managed Object - HostVsanSystem

Property of
  HostConfigManager
See also
  HostMaintenanceSpec, HostScsiDisk, VsanHostClusterStatus, VsanHostConfigInfo, VsanHostDiskMapping, VsanHostDiskMapResult, VsanHostDiskResult
Since
  vSphere API 5.5

## Managed Object Description

Properties

Name | Type | Description
--- | --- | ---
config P | VsanHostConfigInfo |

P Required privilege: System.Read

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

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call.
disk P | HostScsiDisk[] | Since vSphere API 5.5

P Required privilege: disk

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

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

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call.
maintenanceSpec P | HostMaintenanceSpec | Since vSphere API 6.0
timeout P | xsd:int | Since vSphere API 6.0

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RequestCanceled |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
Timedout |
VsanFault |

Events

Type
None

# InitializeDisks_Task

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call.
mapping P | VsanHostDiskMapping[] | Since vSphere API 5.5

P Required privilege: mapping

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

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

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call.
canonicalName* P | xsd:string[] | Since vSphere API 5.5

*Need not be set P Required privilege: canonicalName

Return Value

Type | Description
--- | ---
VsanHostDiskResult[] |

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

# QueryHostStatus

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 |

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

# RecommissionVsanNode_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 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 ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault |

Events

Type
None

# RemoveDisk_Task

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call.
disk P | HostScsiDisk[] | Since vSphere API 5.5
maintenanceSpec* P | HostMaintenanceSpec | Since vSphere API 5.5
timeout* P | xsd:int | Since vSphere API 5.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

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

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call.
mapping P | VsanHostDiskMapping[] | Since vSphere API 5.5
maintenanceSpec* P | HostMaintenanceSpec | Since vSphere API 5.5
timeout* P | xsd:int | Since vSphere API 5.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

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

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call.
mapping P | VsanHostDiskMapping[] | Since vSphere API 6.0

P Required privilege: mapping

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault |

Events

Type
None

# UpdateVsan_Task

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanSystem used to make the method call.
config P | VsanHostConfigInfo | Since vSphere API 5.5

P Required privilege: config

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

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