# Managed Object - HostVStorageObjectManager

Extends
  VStorageObjectManagerBase
See also
  CryptoSpec, Datastore, ID, KeyValue, VirtualMachineProfileSpec, VslmCloneSpec, VslmCreateSpec, vslmInfrastructureObjectPolicy, VslmRelocateSpec, vslmVClockInfo, VStorageObject, VStorageObjectSnapshotInfo, VStorageObjectStateInfo
Since
  vSphere API 6.5

## Managed Object Description

Properties

Name | Type | Description
--- | --- | ---
None
Properties inherited from VStorageObjectManagerBase
None

Methods

Methods defined in this Managed Object
HostClearVStorageObjectControlFlags, HostCloneVStorageObject_Task, HostCreateDisk_Task, HostDeleteVStorageObject_Task, HostDeleteVStorageObjectEx_Task, HostExtendDisk_Task, HostInflateDisk_Task, HostListVStorageObject, HostReconcileDatastoreInventory_Task, HostRegisterDisk, HostRelocateVStorageObject_Task, HostRenameVStorageObject, HostRetrieveVStorageInfrastructureObjectPolicy, HostRetrieveVStorageObject, HostRetrieveVStorageObjectMetadata, HostRetrieveVStorageObjectMetadataValue, HostRetrieveVStorageObjectState, HostScheduleReconcileDatastoreInventory, HostSetVStorageObjectControlFlags, HostUpdateVStorageObjectMetadata_Task, HostUpdateVStorageObjectMetadataEx_Task, HostVStorageObjectCreateDiskFromSnapshot_Task, HostVStorageObjectCreateSnapshot_Task, HostVStorageObjectDeleteSnapshot_Task, HostVStorageObjectRetrieveSnapshotInfo, HostVStorageObjectRevert_Task
Methods inherited from VStorageObjectManagerBase
None

# HostClearVStorageObjectControlFlags

Required Privileges
  System.View
Since
  vSphere API 6.7

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.7
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.7
controlFlags* P | xsd:string[] | Since vSphere API 6.7

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

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidDatastore |
InvalidState |
NotFound |
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

# HostCloneVStorageObject_Task

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.5
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5
spec P | VslmCloneSpec | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

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

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
NotFound |
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

# HostCreateDisk_Task

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
spec P | VslmCreateSpec | Since vSphere API 6.5

P Required privilege: spec

Return Value

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

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
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

# HostDeleteVStorageObject_Task

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.5
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

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

Faults

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

Events

Type
None

# HostDeleteVStorageObjectEx_Task

Required Privileges
  System.View
Since
  vSphere API 7.0.2.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 7.0.2.0
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 7.0.2.0

P Required privilege - see tooltip for details

Return Value

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

Faults

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

Events

Type
None

# HostExtendDisk_Task

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.5
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5
newCapacityInMB P | xsd:long | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

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

Faults

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

Events

Type
None

# HostInflateDisk_Task

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.5
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

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

Faults

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

Events

Type
None

# HostListVStorageObject

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5

P Required privilege: datastore

Return Value

Type | Description
--- | ---
ID[] |

Faults

Type | Description
--- | ---
InvalidDatastore |
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

# HostReconcileDatastoreInventory_Task

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5

P Required privilege: datastore

Return Value

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

Faults

Type | Description
--- | ---
InvalidDatastore |
NotFound |
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

# HostRegisterDisk

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
path P | xsd:string | Since vSphere API 6.5
name* P | xsd:string | Since vSphere API 6.5

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

Return Value

Type | Description
--- | ---
VStorageObject |

Faults

Type | Description
--- | ---
AlreadyExists |
FileFault |
InvalidDatastore |
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

# HostRelocateVStorageObject_Task

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.5
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5
spec P | VslmRelocateSpec | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

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

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
InvalidState |
NotFound |
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

# HostRenameVStorageObject

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.5
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5
name P | xsd:string | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
NotFound |
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

# HostRetrieveVStorageInfrastructureObjectPolicy

Required Privileges
  System.View
Since
  vSphere API 6.7

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.7

P Required privilege: datastore

Return Value

Type | Description
--- | ---
vslmInfrastructureObjectPolicy[] |

Faults

Type | Description
--- | ---
InvalidDatastore |
InvalidState |
NotFound |
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

# HostRetrieveVStorageObject

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.5
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5
diskInfoFlags* P | xsd:string[] | Since vSphere API 6.5

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

Return Value

Type | Description
--- | ---
VStorageObject |

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
NotFound |
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

# HostRetrieveVStorageObjectMetadata

Required Privileges
  System.View
Since
  vSphere API 6.7.2

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.7.2
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.7.2
snapshotId* P | ID | Since vSphere API 6.7.2
prefix* P | xsd:string | Since vSphere API 6.7.2

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

Return Value

Type | Description
--- | ---
KeyValue[] |

Faults

Type | Description
--- | ---
InvalidDatastore |
InvalidState |
NotFound |
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

# HostRetrieveVStorageObjectMetadataValue

Required Privileges
  System.View
Since
  vSphere API 6.7.2

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.7.2
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.7.2
snapshotId* P | ID | Since vSphere API 6.7.2
key P | xsd:string | Since vSphere API 6.7.2

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

Return Value

Type | Description
--- | ---
xsd:string |

Faults

Type | Description
--- | ---
InvalidDatastore |
InvalidState |
KeyNotFound |
NotFound |
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

# HostRetrieveVStorageObjectState

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.5
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VStorageObjectStateInfo |

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
NotFound |
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

# HostScheduleReconcileDatastoreInventory

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5

P Required privilege: datastore

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidDatastore |
NotFound |
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

# HostSetVStorageObjectControlFlags

Required Privileges
  System.View
Since
  vSphere API 6.7

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.7
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.7
controlFlags* P | xsd:string[] | Since vSphere API 6.7

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

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidDatastore |
InvalidState |
NotFound |
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

# HostUpdateVStorageObjectMetadata_Task

Required Privileges
  System.View
Since
  vSphere API 6.7.2

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.7.2
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.7.2
metadata* P | KeyValue[] | Since vSphere API 6.7.2
deleteKeys* P | xsd:string[] | Since vSphere API 6.7.2

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

Return Value

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

Faults

Type | Description
--- | ---
InvalidDatastore |
InvalidState |
NotFound |
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

# HostUpdateVStorageObjectMetadataEx_Task

Required Privileges
  System.View
Since
  vSphere API 7.0.2.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 7.0.2.0
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 7.0.2.0
metadata* P | KeyValue[] | Since vSphere API 7.0.2.0
deleteKeys* P | xsd:string[] | Since vSphere API 7.0.2.0

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

Return Value

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

Faults

Type | Description
--- | ---
InvalidDatastore |
InvalidState |
NotFound |
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

# HostVStorageObjectCreateDiskFromSnapshot_Task

Required Privileges
  System.View
Since
  vSphere API 6.7

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.7
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.7
snapshotId P | ID | Since vSphere API 6.7
name P | xsd:string | Since vSphere API 6.7
profile* P | VirtualMachineProfileSpec[] | Since vSphere API 6.7
crypto* P | CryptoSpec | Since vSphere API 6.7
path* P | xsd:string | Since vSphere API 6.7
provisioningType* P | xsd:string | Since vSphere API 6.7

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

Return Value

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

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
InvalidState |
NotFound |
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

# HostVStorageObjectCreateSnapshot_Task

Required Privileges
  System.View
Since
  vSphere API 6.7

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.7
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.7
description P | xsd:string | Since vSphere API 6.7

P Required privilege - see tooltip for details

Return Value

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

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
InvalidState |
NotFound |
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

# HostVStorageObjectDeleteSnapshot_Task

Required Privileges
  System.View
Since
  vSphere API 6.7

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.7
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.7
snapshotId P | ID | Since vSphere API 6.7

P Required privilege - see tooltip for details

Return Value

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

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
InvalidState |
NotFound |
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

# HostVStorageObjectRetrieveSnapshotInfo

Required Privileges
  System.View
Since
  vSphere API 6.7

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.7
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.7

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VStorageObjectSnapshotInfo |

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
InvalidState |
NotFound |
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

# HostVStorageObjectRevert_Task

Required Privileges
  System.View
Since
  vSphere API 6.7

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call.
id P | ID | Since vSphere API 6.7
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.7
snapshotId P | ID | Since vSphere API 6.7

P Required privilege - see tooltip for details

Return Value

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

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
InvalidState |
NotFound |
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