Package com.vmware.vim25.mo

Class HostVsanInternalSystem

java.lang.Object

com.vmware.vim25.mo.ManagedObject

com.vmware.vim25.mo.HostVsanInternalSystem

public class HostVsanInternalSystem
extends ManagedObject

Constructor Summary

Constructors

Constructor	Description
HostVsanInternalSystem(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

Modifier and Type	Method	Description
String[]	abdicateDomOwnership(String[] uuids)	Abdicate ownership of DOM objects.
VsanPolicySatisfiability[]	canProvisionObjects(VsanNewPolicyBatch[] npbs)
VsanPolicySatisfiability[]	canProvisionObjects(VsanNewPolicyBatch[] npbs, boolean ignoreSatisfiability)
VsanPolicySatisfiability[]	canProvisionObjects(VsanNewPolicyBatch[] npbs, Boolean ignoreSatisfiability)	Determine if given objects can be provisioned.
HostVsanInternalSystemDeleteVsanObjectsResult[]	deleteVsanObjects(String[] uuids)
HostVsanInternalSystemDeleteVsanObjectsResult[]	deleteVsanObjects(String[] uuids, boolean force)
HostVsanInternalSystemDeleteVsanObjectsResult[]	deleteVsanObjects(String[] uuids, Boolean force)	Delete VSAN objects.
String	getVsanObjExtAttrs(String[] uuids)	Get VSAN object extended attributes.
String	queryCmmds(HostVsanInternalSystemCmmdsQuery[] queries)
String	QueryCmmds(HostVsanInternalSystemCmmdsQuery[] queries)	Deprecated. use queryCmmds(HostVsanInternalSystemCmmdsQuery[])
String	queryObjectsOnPhysicalVsanDisk(String[] disks)
String	queryPhysicalVsanDisks(String[] props)
String	querySyncingVsanObjects(String[] uuids)	Query information about VSAN DOM objects that are currently syncing data.
String	queryVsanObjects(String[] uuids)
String[]	queryVsanObjectUuidsByFilter(String[] uuids, int limit, int version)	Query VSAN object UUIDs by filtering conditions.
String	queryVsanStatistics(String[] labels)	Query VSAN system statistics.
VsanPolicySatisfiability[]	reconfigurationSatisfiable(VsanPolicyChangeBatch[] pcbs)
VsanPolicySatisfiability[]	reconfigurationSatisfiable(VsanPolicyChangeBatch[] pcbs, boolean ignoreSatisfiability)
VsanPolicySatisfiability[]	reconfigurationSatisfiable(VsanPolicyChangeBatch[] pcbs, Boolean ignoreSatisfiability)	Determine if the given objects can be reconfigured with the given policies.
void	reconfigureDomObject(String uuid, String policy)
HostVsanInternalSystemVsanPhysicalDiskDiagnosticsResult[]	runVsanPhysicalDiskDiagnostics(String[] disks)	Runs diagnostics on VSAN physical disks.
HostVsanInternalSystemVsanObjectOperationResult[]	upgradeVsanObjects(String[] uuids, int newVersion)	Upgrade VSAN objects version.

Methods inherited from class com.vmware.vim25.mo.ManagedObject

convertMors, getCurrentProperty, getDatastores, getFilter, getHosts, getManagedObject, getManagedObjects, getManagedObjects, getMOR, getNetworks, getPropertiesByPaths, getPropertyByPath, getResourcePools, getScheduledTasks, getServerConnection, getTasks, getViews, getVimService, getVms, retrieveObjectProperties, setCachedProperty, setMOR, setServerConnection, toString, waitForValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

HostVsanInternalSystem

public HostVsanInternalSystem(ServerConnection serverConnection,
 ManagedObjectReference mor)

Method Details

canProvisionObjects

public VsanPolicySatisfiability[] canProvisionObjects(VsanNewPolicyBatch[] npbs,
 boolean ignoreSatisfiability)
                                               throws VimFault,
RuntimeFault,
RemoteException

Throws:

VimFault

RuntimeFault

RemoteException

deleteVsanObjects

public HostVsanInternalSystemDeleteVsanObjectsResult[] deleteVsanObjects(String[] uuids,
 boolean force)
                                                                  throws VimFault,
RuntimeFault,
RemoteException

Throws:

VimFault

RuntimeFault

RemoteException

reconfigurationSatisfiable

public VsanPolicySatisfiability[] reconfigurationSatisfiable(VsanPolicyChangeBatch[] pcbs,
 boolean ignoreSatisfiability)
                                                      throws VimFault,
RuntimeFault,
RemoteException

Throws:

VimFault

RuntimeFault

RemoteException

reconfigureDomObject

public void reconfigureDomObject(String uuid,
 String policy)
                          throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

abdicateDomOwnership

public String[] abdicateDomOwnership(String[] uuids)
                              throws RuntimeFault,
RemoteException

Abdicate ownership of DOM objects. The objects must be currently owned by this host. Which host has ownership of an object at a given point in time can be queried from QueryVsanObjects() or QueryCmmds() APIs. Abidcating ownership tears down DOM owner in-memory state. Hosts in the cluster will then compete to become the new owner of the object, similar to a host failure event. There is a short interuption of IO flow while the owner re-election is going on, but it is transparent to any consumers of the object. This API is meant as a troubleshooting and debugging tool. It is internal at this point and can be used to resolve issues where DOM owner gets "stuck".

Parameters:

uuids - List of VSAN/DOM object UUIDs.

Returns:

String[]

Throws:

RemoteException

RuntimeFault

Since:

6.0

canProvisionObjects

public VsanPolicySatisfiability[] canProvisionObjects(VsanNewPolicyBatch[] npbs,
 Boolean ignoreSatisfiability)
                                               throws VimFault,
RuntimeFault,
RemoteException

Determine if given objects can be provisioned. Determines if the objects of the given size can be provisioned with the given policies. The API is intended to answer the question: can these objects be provisioned with the given policy using the current cluster topology (#hosts and #disks) and does NOT take into account free space on the disk, size of disks, etc. If the objects cannot be provisioned, the API returns the reason for not being able to satisfy the policy. If the objects can be provisioned, the API returns the cost of provisioning objects with this policy. Please note: This API ignores forceProvisioning.

Parameters:

npbs - List of NewPolicyBatch structure with sizes and policies.

ignoreSatisfiability - Optionally populate PolicyCost even though object cannot be provisioned in the current cluster topology.

Returns:

List of PolicySatisfiability objects, one for each specified size.

Throws:

VimFault

RuntimeFault

RemoteException

Since:

6.0

canProvisionObjects

public VsanPolicySatisfiability[] canProvisionObjects(VsanNewPolicyBatch[] npbs)
                                               throws VimFault,
RuntimeFault,
RemoteException

Throws:

VimFault

RuntimeFault

RemoteException

deleteVsanObjects

public HostVsanInternalSystemDeleteVsanObjectsResult[] deleteVsanObjects(String[] uuids,
 Boolean force)
                                                                  throws RuntimeFault,
VimFault,
RemoteException

Delete VSAN objects. This API is internal and intended for troubleshooting/debugging only WARNING: This API can be slow because we do IOs to all the objects. This API can be used to delete VSAN objects. DOM won't allow access to objects which have lost quorum. Such objects can be deleted with the optional "force" flag. These objects may however re-appear with quorum if the absent components come back (network partition gets resolved, etc.)

Parameters:

uuids - List of object UUIDs to be deleted.

force - Optional force delete.

Returns:

List of DeleteVsanObjectsResult.

Throws:

RuntimeFault

VimFault

RemoteException

Since:

6.0

deleteVsanObjects

public HostVsanInternalSystemDeleteVsanObjectsResult[] deleteVsanObjects(String[] uuids)
                                                                  throws RuntimeFault,
VimFault,
RemoteException

Throws:

RuntimeFault

VimFault

RemoteException

getVsanObjExtAttrs

public String getVsanObjExtAttrs(String[] uuids)
                          throws RuntimeFault,
RemoteException,
VimFault

Get VSAN object extended attributes. This API is internal and intended for troubleshooting/debugging situations in the field. WARNING: This API can be slow because we do IOs (reads) to all the objects. This API can be used to get extended attributes of any object in the VSAN cluster from any host provided the object is accessible from that host. In case of an error, we return a dict with key "Error" for that object.

Parameters:

uuids - List of object UUIDs.

Returns:

JSON string with the extended attributes.

Throws:

RuntimeFault

RemoteException

VimFault

Since:

6.0

QueryCmmds

@Deprecated
public String QueryCmmds(HostVsanInternalSystemCmmdsQuery[] queries)
                  throws RuntimeFault,
RemoteException

Deprecated.

use queryCmmds(HostVsanInternalSystemCmmdsQuery[])

Parameters:

queries -

Returns:

Throws:

RuntimeFault

RemoteException

queryCmmds

public String queryCmmds(HostVsanInternalSystemCmmdsQuery[] queries)
                  throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

queryObjectsOnPhysicalVsanDisk

public String queryObjectsOnPhysicalVsanDisk(String[] disks)
                                      throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

queryPhysicalVsanDisks

public String queryPhysicalVsanDisks(String[] props)
                              throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

querySyncingVsanObjects

public String querySyncingVsanObjects(String[] uuids)
                               throws RuntimeFault,
RemoteException

Query information about VSAN DOM objects that are currently syncing data. Instead of returning all objects, only such objects are returned that are currently resyncing any stale components or syncing fresh replicas. The API returns the same output format as queryVsanObjects(). It retrieves information about syncing all objects, or retricts the search for syncing objects to the UUID list provided. In order to make this API efficient, the output of this API contains the found DOM_OBJECT, and referenced LSOM_OBJECT and DISK entries.

Parameters:

uuids - List of VSAN/DOM object UUIDs to restrict search to.

Returns:

JSON string with the results

Throws:

RuntimeFault

RemoteException

Since:

6.0

queryVsanObjectUuidsByFilter

public String[] queryVsanObjectUuidsByFilter(String[] uuids,
 int limit,
 int version)
                                      throws VsanFault,
RemoteException,
RuntimeFault

Query VSAN object UUIDs by filtering conditions. The API queries CMMDS by given filtering conditions (initially only for object version) and return object UUID in an array with limited elements count. If caller specified the inputs objects UUID, then only these objects will be checked for the filtering conditions, and return ones which satisfy the filtering condition. In this case, the 'limit' parameter will be ignored.

Parameters:

uuids - Objects UUID will be checked against the filtering conditions.

limit - To limit the size of the result set.

version - Filtering condition 1: object version.

Returns:

String array of object uuids which satisfy the filtering conditions.

Throws:

VsanFault

RemoteException

RuntimeFault

Since:

6.0

queryVsanStatistics

public String queryVsanStatistics(String[] labels)
                           throws RuntimeFault,
RemoteException

Query VSAN system statistics. This is a low level API that gathers low level statistic counters from the system. The details of the counters remain undocumented and unsupported at this point, and this API remains internal. The data for this API call mostly comes from VSI, but also other tools like memstats. The caller can control which counters are being retrieved by providing a list of labels. The following labels are current supported: - TBD

Parameters:

labels - List of labels of counters to retrieve.

Returns:

JSON string with the results

Throws:

RuntimeFault

RemoteException

Since:

6.0

reconfigurationSatisfiable

public VsanPolicySatisfiability[] reconfigurationSatisfiable(VsanPolicyChangeBatch[] pcbs,
 Boolean ignoreSatisfiability)
                                                      throws RemoteException,
RuntimeFault,
VimFault

Determine if the given objects can be reconfigured with the given policies. The what-if determination only takes into account the total number of hosts and total number of disks per host. The API is intended to answer the question: is this reconfiguration possible using the current cluster topology (#hosts and #disks) and does NOT take into account free space on the disk, size of disks, etc. If policy is not satisfiable, the API returns the reason for not being able to satisfy the policy. If the policy is satisfiable, the API returns the cost of provisioning objects with the new policy. This cost can be combined with current available free disk space to compute if a particular operation is expected to succeed or fail. Please note: This API ignores forceProvisioning.

Parameters:

pcbs - List of PolicyChangeBatch structure with uuids and policies.

ignoreSatisfiability - Optionally populate PolicyCost even though object cannot be reconfigured in the current cluster topology.

Returns:

List of PolicySatisfiability objects, one for each specified UUID.

Throws:

RemoteException

RuntimeFault

VimFault

Since:

6.0

reconfigurationSatisfiable

public VsanPolicySatisfiability[] reconfigurationSatisfiable(VsanPolicyChangeBatch[] pcbs)
                                                      throws RemoteException,
RuntimeFault,
VimFault

Throws:

RemoteException

RuntimeFault

VimFault

runVsanPhysicalDiskDiagnostics

public HostVsanInternalSystemVsanPhysicalDiskDiagnosticsResult[] runVsanPhysicalDiskDiagnostics(String[] disks)
                                                                                         throws RuntimeFault,
RemoteException

Runs diagnostics on VSAN physical disks. This method takes an active approach and creates a minimal and temporary object on each physical MD disk consumed by VSAN across the entire VSAN cluster. The temporary objects are deleted right away upon completion of creation. The result returns a list of all checked MDs, indicating wheather or not there was a problem creating an object on that MD at the given point in time.

Parameters:

disks - List of VSAN disk UUIDs. If specified restricts the diagnostics run to VSAN disks present in the provided list.

Returns:

A list of result structures. One per checked disk.

Throws:

RuntimeFault

RemoteException

Since:

6.0

upgradeVsanObjects

public HostVsanInternalSystemVsanObjectOperationResult[] upgradeVsanObjects(String[] uuids,
 int newVersion)
                                                                     throws RuntimeFault,
VsanFault,
RemoteException

Upgrade VSAN objects version. Upgrade a set of objects' version to new one in batch mode. API caller should limit the size of the inputs array, and suggested array size is 500 ~ 1000 initially. (The API will give more realistic suggestion after more experiments, then will apply hard limits in future)

Parameters:

uuids - The array of objects' UUID which will be upgraded.

newVersion - The new version will be applied to objects.

Returns:

Throws:

RuntimeFault

VsanFault

RemoteException

queryVsanObjects

public String queryVsanObjects(String[] uuids)
                        throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException