Scripting Object - VcStorageResourceManager

Scripting-object corresponding to
StorageResourceManager
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

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, applyStorageDrsRecommendation_Task, applyStorageDrsRecommendationToPod_Task, cancelStorageDrsRecommendation, configureDatastoreIORM_Task, configureDatastoreIORMOnHost, configureStorageDrsForPod_Task, createTrigger, getStorageIORMDeviceModel, queryDatastorePerformanceSummary, queryIORMConfigOption, queryStorageStatisticsByProfile, rankForPlacement, recommendDatastores, refreshStorageDrsRecommendation, refreshStorageDrsRecommendationsForPod_Task

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.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcStoragePod

arg1String


Return Value

Type Description
VcTask

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

configureStorageDrsForPod_Task

Change the storage DRS configuration for a pod {@link vim.StoragePod}.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcStoragePod

arg1VcStorageDrsConfigSpec

arg2Boolean


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:

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcTask

refreshStorageDrsRecommendationsForPod_Task

Invoke Storage DRS on a specific pod {@link vim.StoragePod} and return a new list of recommendations.

@since vim unstable version

Parameters

NameTypeDescription
arg0VcStoragePod


Return Value

Type Description
VcTask

queryIORMConfigOption

Query configuration options for storage I/O resource management.

@since vSphere API 4.1

Parameters

NameTypeDescription
arg0VcHostSystem


Return Value

Type Description
VcStorageIORMConfigOption

recommendDatastores

This method returns a {@link vim.storageDrs.StoragePlacementResult} object. This API is intended to replace the following existing APIs for SDRS-enabled pods: CreateVm: StoragePlacementSpec::type == create = {@link vim.Folder#createVm} AddDisk: StoragePlacementSpec::type == reconfigure = {@link vim.VirtualMachine#reconfigure} ExpandDisk: StoragePlacementSpec::type == expandDisk = {@link vim.VirtualMachine#reconfigure} RelocateVm: StoragePlacementSpec::type == relocate = {@link vim.VirtualMachine#relocate} CloneVm: StoragePlacementSpec::type == clone = {@link vim.VirtualMachine#clone} 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, and ExpandDisk, 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.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcStoragePlacementSpec


Return Value

Type Description
VcStoragePlacementResult

cancelStorageDrsRecommendation

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

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
None

rankForPlacement

Provide an ordering for a set of clusters (@link vm.ClusterComputeResource} for VM provisioning operations including create, clone, relocate, and reconfigure.

This method returns a {@link PlacementRankResult} object that contains information about the datastore resource usage after the placement operation for each cluster. If there are affinity rules present, the placement fails if all of the VMs in the affinity rule cannot be placed together. Anti-affinity rules are currently not supported. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcPlacementRankSpec


Return Value

Type Description
VcPlacementRankResult []

queryStorageStatisticsByProfile

Compute the aggregate storage statistics for all the storage profiles that are available in a list of clusters.

This method returns a {@link StorageProfileStatistics} object for each profile included in the query. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcClusterComputeResource []


Return Value

Type Description
VcStorageResourceManagerStorageProfileStatistics []

configureDatastoreIORMOnHost

Internal version of {@link StorageResourceManager#ConfigureDatastoreIORM} method. This method changes configuration of storage I/O resource management for a given datastore through a host. This is an internal method that should be used exclusively between vCenter server and host agent.

@since vSphere API 4.1

Parameters

NameTypeDescription
arg0VcDatastore

arg1VcStorageIORMConfigSpec


Return Value

Type Description
None

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.

@since vSphere API 4.1

Parameters

NameTypeDescription
arg0VcDatastore

arg1VcStorageIORMConfigSpec


Return Value

Type Description
VcTask

getStorageIORMDeviceModel

Returns the device model computed for a given datastore by the storage DRS

@since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcDatastore


Return Value

Type Description
VcStorageIORMDeviceModel

refreshStorageDrsRecommendation

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

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcStoragePod


Return Value

Type Description
None

queryDatastorePerformanceSummary

Returns datastore summary performance statistics.

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

@since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcDatastore


Return Value

Type Description
VcStoragePerformanceSummary []