vSAN Management API
| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - VsanSystemEx(vim.host.VsanSystemEx)
- See also
- HostMaintenanceSpec, Task, VsanHostAbortWipeDiskStatus, VsanHostAboutInfoEx, VsanHostClusterStatus, VsanHostDiskMapping, VsanHostDrsStats, VsanHostRuntimeStats, VsanHostVsanObjectSyncQueryResult, VsanHostWipeDiskStatus, VsanWhatIfEvacResult
- Since
- vSphere API Release 6.5
Managed Object Description
This managed object provides extended APIs to enrich HostVsanSystem's functionality, operating at a single ESXi host level. HostVsanSystem is still valid and provided by vSphere Management SDK. HostVsanSystem and VsanSystemEx should be used in combination for different operations to vSAN. It can be accessed with MOID of 'vsanSystemEx' through vSAN service at ESXi host side. It can be also accessed with MOID of 'vsanSystemEx-<hostId>' through vSAN service at vCenter server side, where <hostId> is the ID at the end of the host's MOID: 'host-<hostId>'. For example, if a host's MOID is 'host-5', then 'vsanSystemEx-5' should be used to access this host's VsanSystemEx MO.Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
VsanGetAboutInfoEx, VsanHostAbortWipeDisk, VsanHostGetRuntimeStats, VsanHostQueryWipeDisk, VsanHostWipeDisk, VsanQueryHostDrsStats, VsanQueryHostStatusEx, VsanQuerySyncingVsanObjects, VsanQueryWhatIfEvacuationResult, VsanUnmountDiskMappingEx |
VsanGetAboutInfoEx(getAboutInfoEx)
Query system information of ESXi such as name, type, version, build type and build number.- Required Privileges
- System.Read
- Since
- 6.6
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanSystemEx used to make the method call. |
Return Value
Type | Description |
---|---|
VsanHostAboutInfoEx | VsanAboutInfoEx |
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
VsanHostAbortWipeDisk(abortWipeDisk)
Abort outstanding secure wipe disk request.- Required Privileges
- Host.Config.Storage
- Since
- vSAN 7.0U1
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanSystemEx used to make the method call. |
disks | xsd:string[] |
Since vSAN 7.0U1 |
Return Value
Type | Description |
---|---|
VsanHostAbortWipeDiskStatus[] | VsanHostAbortWipeDiskStatus[] which contain each disk abort wipe return status. |
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
VsanHostGetRuntimeStats(getRuntimeStats)
Get vSAN runtime stats of vSAN host. This API is used to retrieve host's vSAN runtime stats. It bases on specified stats type list, to retrieve expected vSAN runtime stats.- Required Privileges
- System.Read
- Since
- 6.6
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanSystemEx used to make the method call. |
stats* | xsd:string[] |
List of vSAN runtime stats type. Supported vSAN runtime stats
types are declared in VsanHostStatsType.
If this parameter is omitted, all supported runtime stats will
be collected and returned.
Since 6.6 |
clusterUuid* | xsd:string |
The cluster uuid used for vSAN runtime stats of
configGeneration in VsanHostStatsType.
Since 6.6 |
Return Value
Type | Description |
---|---|
VsanHostRuntimeStats | vim.vsan.host.RuntimeStats |
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
VsanHostQueryWipeDisk(queryWipeDiskStatus)
Query disk level information for securely wipe disk.- Required Privileges
- System.Read
- Since
- vSAN 7.0U1
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanSystemEx used to make the method call. |
disks | xsd:string[] |
Since vSAN 7.0U1 |
Return Value
Type | Description |
---|---|
VsanHostWipeDiskStatus[] | VsanHostWipeDiskStatus[] which contain each disk wipe status. |
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. |
VsanFault |
Events
Type | |
---|---|
None |
Show WSDL type definition
VsanHostWipeDisk(wipeDisk)
Initiate task for securely wipe disk.- Required Privileges
- Host.Config.Storage
- Since
- vSAN 7.0U1
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanSystemEx used to make the method call. |
disks | xsd:string[] |
Since vSAN 7.0U1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | A Task to track secure wipe progress, and the task is not cancelable. |
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. |
VsanFault |
Events
Type | |
---|---|
None |
Show WSDL type definition
VsanQueryHostDrsStats(queryHostDrsStats)
Query vSAN DRS stats of this host and all vSAN VMs registered on this host.
- Required Privileges
- System.Read
- Since
- VMC M5
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanSystemEx used to make the method call. |
hostUuids* | xsd:string[] |
In regular vSAN cluster, it indicates sorted
list of vSAN member host Uuid. It is used to
determine the full set of vSAN member hosts
and the sequence to organize vSAN VM stats.
In stretched compute only cluster, it is an array
filled by '0' and '1', to indicate the host
membership of configured site fault domains,
this is to fill in the gap of absence of
vSAN host fault domain on vSAN enabled node.
Since VMC M5 |
vms* | xsd:string[] |
List of VM instance UUID. If specified, only stats of
given VMs will be returned, otherwise all vSAN VMs
registered on this host will be involved if this
parameter is omitted. By default template VM will be
ignored unless it is specified by this paramter.
Since VMC M5 |
hostIndex* | xsd:int |
Only applicable to stretched compute only node,
to indicate the index of the target host in
parameter 'hostUuids'.
Since VMC M5 |
Return Value
Type | Description |
---|---|
VsanHostDrsStats | VsanHostDrsStats |
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
VsanQueryHostStatusEx(queryHostStatusEx)
Query this host's current runtime status for the VSAN service.- Required Privileges
- System.Read
- Since
- vSAN 7.0U1
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanSystemEx used to make the method call. |
clusterUuids* | xsd:string[] |
A list of vSAN cluster uuids. If this parameter is
provided, we will only return the runtime status of recognized clusters;
And if it is omitted, we will return that of all clusters associated to
this host.
Since vSAN 7.0U1 |
Return Value
Type | Description |
---|---|
VsanHostClusterStatus[] | An array of ClusterStatus which represent host's cluster status information for the vSAN service. |
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
VsanQuerySyncingVsanObjects(querySyncingVsanObjects)
Query information about vSAN objects that are currently syncing data. It will retrieve information about syncing objects based on query options.- Required Privileges
- System.Read
- Since
- 6.7
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanSystemEx used to make the method call. |
uuids* | xsd:string[] |
Restricts the list of object identities to query.
Since 6.7 |
start* | xsd:int |
Indicates the number of objects to be skipped when returns
query results. A value less than 0 is illegal. Default: 0.
Since 6.7 |
limit* | xsd:int |
Restricts the max number of objects to return. Valid value
is from 0 to 200. A value less than 0 is illegal, 0 is valid
only when "includeSummary" is true. Default: 100.
Since 6.7 |
includeSummary* | xsd:boolean |
Indicates whether to return summary data in query
result. Default: True.
Since 6.7 |
Return Value
Type | Description |
---|---|
VsanHostVsanObjectSyncQueryResult | vim.vsan.host.VsanSyncingObjectQueryResult. |
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
VsanQueryWhatIfEvacuationResult(queryWhatIfEvacuationResult)
Query what it takes for an entity(disk group or host) to be evacuated in various modes. Only account for capacity usage when it determines if an entity can be evacuated in a given mode. Note that this means all other considerations such as fault domain, number of spindles or read cache are ignored and the API will only verify if the cluster has enough capacity to accommodate the affected objects in a specified mode.- Required Privileges
- System.Read
- Since
- 6.6
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanSystemEx used to make the method call. |
evacEntityUuid | xsd:string |
The entity UUID which will be evacuated. It can be
an UUID of disk, disk group or host.
Since 6.6 |
Return Value
Type | Description |
---|---|
VsanWhatIfEvacResult | WhatIfEvacResult which indicate whether the evacuation can be done in current cluster state and specified evacuation mode. If so, this API returns what objects would lose liveness or compliance. Or on the other hand, if the given entity cannot be evacuated, API returns many extra resources needed to satisfy this operation. |
Faults
Type | Description |
---|---|
NotImplemented | |
NotSupported | |
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
VsanUnmountDiskMappingEx(unmountDiskMappingEx)
Unmount vSAN diskgroup, which stops using specified vSAN diskgroup for any vSAN I/O without destroying it. This API extended and deprecated UnmountDiskMapping_Task, added vSAN data migration support, to provide data protection during the process. Without data migration, for vSAN data which is not configured with redundancy (policy hostFailureToTolerate=0), or in incompliant state (data redundancy reduced when policy hostFailureToTolerate>0), its accessibility could be broken after diskgroup unmounted.- Required Privileges
- Host.Config.Storage
- Since
- VMC M5
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanSystemEx used to make the method call. |
mappings | VsanHostDiskMapping[] |
List of diskgroups to be unmounted.
Since VMC M5 |
maintenanceSpec* | HostMaintenanceSpec |
Any additional actions to move data out of the
diskgroup before unmounting it. See
HostMaintenanceSpec. If unspecified,
there is no action taken to move data from the
diskgroup.
Since VMC M5 |
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 VMC M5 |
evacReason* | xsd:string |
The reason to evacuate diskgroup.
Allowed values can be found in
VsanDiskEvacReason
Since VMC M5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | Task to track the diskrgoup unmounting process. |
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. |
VsanFault |
Events
Type | |
---|---|
None |
Show WSDL type definition
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |