| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Requires Resource. ApplyRecommendation privilege on the storage pod. Additionally, depending on the workflow where this API is called from, it may require the privileges of invoking one of following APIs:
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the StorageResourceManager used to make the method call. |
key | xsd:string[] |
The key fields of the Recommendations that are applied.
|
Return Value
Type | Description |
---|---|
pbm.Task |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the specified key refers to a non-existent or an already executed recommendation. |
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 |
Requires Resource.ApplyRecommendation privilege on the storage pod. And requires Resource.ColdMigrate privilege on the virtual machine(s) that are relocated. Additionally requires Resource.HotMigrate privilege if the virtual machine is powered on (for Storage VMotion). Also requires Datastore.AllocateSpace on any datastore the virtual machine or its disks are relocated to.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the StorageResourceManager used to make the method call. |
pod | ManagedObjectReference
to a StoragePod |
The storage pod.
|
key | xsd:string |
The key field of the Recommendation.
|
Return Value
Type | Description |
---|---|
pbm.Task |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the specified key refers to a non-existent or an already executed recommendation. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the StorageResourceManager used to make the method call. |
key | xsd:string[] |
The key field of the Recommendation.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the specified key refers to a non-existent or an already executed recommendation. |
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 |
This method is only supported by vCenter server.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the StorageResourceManager used to make the method call. |
datastore P | ManagedObjectReference
to a Datastore |
The datastore to be configured.
|
spec | StorageIORMConfigSpec |
The configuration spec.
|
Return Value
Type | Description |
---|---|
pbm.Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
InaccessibleDatastore | Thrown if cannot access the datastore from any of the hosts. |
InvalidArgument | Thrown if 1. IORMConfigSpec.congestionThreshold is not within the desired range (5 to 100 milliseconds). 2. IORMConfigSpec.congestionThresholdMode is not specified and IORMConfigSpec.congestionThreshold is specified. To set congestionThreshold, congestionThresholdMode should be set to manual |
IORMNotSupportedHostOnDatastore | Thrown if called on a datastore that is connected to a host that does not support storage I/O resource management. |
NotSupported | Thrown if called directly on a host or if called on a datastore that does not have VMFS Volume. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the StorageResourceManager used to make the method call. |
pod P | ManagedObjectReference
to a StoragePod |
The storage pod.
|
spec | StorageDrsConfigSpec |
A set of storage Drs configuration changes to apply to the storage pod.
The specification can be a complete set of changes or a partial
set of changes, applied incrementally.
|
modify | xsd:boolean |
Flag to specify whether the specification ("spec") should
be applied incrementally. If "modify" is false and the
operation succeeds, then the configuration of the storage pod
matches the specification exactly; in this case any unset
portions of the specification will result in unset or
default portions of the configuration.
|
Return Value
Type | Description |
---|---|
pbm.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 |
This is an experimental interface that is not intended for use in production code.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the StorageResourceManager used to make the method call. |
datastore | ManagedObjectReference
to a Datastore |
Datastore for which summary statistics is requested.
|
Return Value
Type | Description |
---|---|
StoragePerformanceSummary[] | Summary performance statistics for the datastore. The summary contains latency, throughput, and SIOC activity. |
Faults
Type | Description |
---|---|
NotFound | Thrown if input datastore cannot be found |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the StorageResourceManager used to make the method call. |
host | ManagedObjectReference
to a HostSystem |
[in] - The host VC will forward the query
to. This parameter is ignored by host if this method is
called on a host directly.
|
Return Value
Type | Description |
---|---|
StorageIORMConfigOption | configuration option object. |
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 |
This method returns a StoragePlacementResult object. This API is intended to replace the following existing APIs for SDRS-enabled pods: CreateVm: StoragePlacementSpec::type == create = CreateVM_Task AddDisk: StoragePlacementSpec::type == reconfigure = ReconfigVM_Task RelocateVm: StoragePlacementSpec::type == relocate = RelocateVM_Task CloneVm: StoragePlacementSpec::type == clone = CloneVM_Task The PodSelectionSpec parameter in StoragePlacementSpec is required for all workflows. It specifies which SDRS-enabled pod the user has selected for the VM and/or for each disk. For CreateVm, RelocateVm and CloneVm, PodSelectionSpec.storagePod is the user selected SDRS pod for the VM, i.e., its system files. For all workflows, PodSelectionSpec.disk.storagePod is the user selected SDRS pod for the given disk. Note that a DiskLocator must be specified for each disk that the user requests to create, migrate or clone into an SDRS pod, even if it's the same pod as the VM or the user has manually selected a datastore within the pod. If the user has manually selected a datastore, the datastore must be specified in the workflow specific fields as described below. For CreateVm, AddDisk, the manually selected datastore must be specified in ConfigSpec.files or ConfigSpec.deviceChange.device.backing.datastore, the fields should will be unset if the user wants SDRS to recommend the datastore. For RelocateVm, the manually selected datastore must be specified in RelocateSpec.datastore or RelocateSpec.disk.datastore; the fields should be unset iff the user wants SDRS recommendations. For CloneVm, the manually selected datastore must be specified in CloneSpec.location.datastore or CloneSpec.location.disk[].datastore; the fields should be unset iff the user wants SDRS recommendations. The remaining expected input parameters in StoragePlacementSpec will be the same as those for the existing API as determined by StoragePlacementSpec::type. If a parameter is optional in the existing API, it will also be optional in the new API.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the StorageResourceManager used to make the method call. |
storageSpec | StoragePlacementSpec |
|
Return Value
Type | Description |
---|---|
StoragePlacementResult |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the StorageResourceManager used to make the method call. |
pod | ManagedObjectReference
to a StoragePod |
The storage pod.
The recommendations generated is stored at
PodStorageDrsEntry#recommendation.
|
Return Value
Type | Description |
---|---|
None |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the StorageResourceManager used to make the method call. |
pod | ManagedObjectReference
to a StoragePod |
The storage pod.
The recommendations generated is stored at
PodStorageDrsEntry#recommendation.
|
Return Value
Type | Description |
---|---|
pbm.Task |
Faults
Type | Description |
---|---|
InvalidArgument | |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the StorageResourceManager used to make the method call. |
pod | ManagedObjectReference
to a StoragePod |
The storage pod.
|
spec | StorageDrsConfigSpec |
A set of storage Drs configuration changes to apply to
the storage pod.
|
Return Value
Type | Description |
---|---|
MethodFault |
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 Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |