Scripting Object - VcStorageResourceManager

Attribute of
VcSdkConnection, VcServiceContent

Scripting Object Description

This managed object type provides a way to configure resource usage for storage resources.

Attributes

Name Type Description
idstring

returns the id of this ManagedObject
referenceVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject
sdkConnectionVcSdkConnection

returns the parent SdkConnection
vimHostVcSdkConnection

returns the parent SdkConnection (deprecated)
vimTypestring

returns the type of this ManagedObject

Methods

Methods defined in this Scripting Object
applyStorageDrsRecommendation_Task, applyStorageDrsRecommendationToPod_Task, cancelStorageDrsRecommendation, configureDatastoreIORM_Task, configureStorageDrsForPod_Task, createTrigger, queryDatastorePerformanceSummary, queryIORMConfigOption, recommendDatastores, refreshStorageDrsRecommendation

configureDatastoreIORM_Task

Changes configuration of storage I/O resource management for a given datastore. The changes are applied to all the backing storage devices for the datastore. Currently we only support storage I/O resource management on VMFS volumes. In order to enable storage I/O resource management on a datstore, we require that all the hosts that are attached to the datastore support this feature.

This method is only supported by vCenter server.

Parameters

NameTypeDescription
datastoreVcDatastore

The datastore to be configured.
specVcStorageIORMConfigSpec

The configuration spec.


Return Value

Type Description
VcTask

queryIORMConfigOption

Query configuration options for storage I/O resource management.

Parameters

NameTypeDescription
hostVcHostSystem

[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
VcStorageIORMConfigOption

queryDatastorePerformanceSummary

Returns datastore summary performance statistics.

This is an experimental interface that is not intended for use in production code.

Parameters

NameTypeDescription
datastoreVcDatastore

Datastore for which summary statistics is requested.


Return Value

Type Description
VcStoragePerformanceSummary []

applyStorageDrsRecommendationToPod_Task

Applies a recommendation from the recommendation list. Each recommendation can be applied only once.

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

NameTypeDescription
podVcStoragePod

The storage pod.
keystring

The key field of the Recommendation.


Return Value

Type Description
VcTask

applyStorageDrsRecommendation_Task

Applies a recommendation from the recommendation list. Each recommendation can be applied only once. In the case of CreateVm and CloneVm a VirtualMachine is returned. Other workflows don't have a return value.

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

NameTypeDescription
keystring []

The key fields of the Recommendations that are applied.


Return Value

Type Description
VcTask

cancelStorageDrsRecommendation

Cancels a recommendation. Currently only initial placement recommendations can be cancelled. Migration recommendations cannot.

Parameters

NameTypeDescription
keystring []

The key field of the Recommendation.


Return Value

Type Description
None

refreshStorageDrsRecommendation

Make Storage DRS invoke again on the specified pod VcStoragePod and return a new list of recommendations. Concurrent "refresh" requests may be combined together and trigger only one Storage DRS invocation.

Parameters

NameTypeDescription
podVcStoragePod

The storage pod. The recommendations generated is stored at PodStorageDrsEntry#recommendation.


Return Value

Type Description
None

configureStorageDrsForPod_Task

Change the storage DRS configuration for a pod VcStoragePod.

Parameters

NameTypeDescription
podVcStoragePod

The storage pod.
specVcStorageDrsConfigSpec

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.
modifyboolean

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
VcTask

recommendDatastores

This method returns a VcStoragePlacementResult object. This API is intended to replace the following existing APIs for SDRS-enabled pods: CreateVm: StoragePlacementSpec::type == create = VcFolder AddDisk: StoragePlacementSpec::type == reconfigure = VcVirtualMachine RelocateVm: StoragePlacementSpec::type == relocate = VcVirtualMachine CloneVm: StoragePlacementSpec::type == clone = VcVirtualMachine 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 and 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.

SDRS takes into account constraints such as space usages, (anti-) affinity rules, datastore maintenance mode, etc. when making placement recommendations. Given that the constraints are satisfied, SDRS tries to balance space usages and I/O loads in the placement.

Parameters

NameTypeDescription
storageSpecVcStoragePlacementSpec


Return Value

Type Description
VcStoragePlacementResult

createTrigger

Create a trigger from this ManagedObject

Parameters

NameTypeDescription
timeoutnumber

Waiting timout in seconds
filterstring

The monitored vCenter API filter
conditionstring

The condition in OGNL language
filterToSync*string

The vCenter API filter used to synchronize the content of the session
*Need not be set

Return Value

Type Description
Trigger