Storage Resource Manager Configure Datastore IORM 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. The privilege Datastore.ConfigIOManagement is required on the target datastore.

This method is only supported by vCenter server.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/StorageResourceManager/{moId}/ConfigureDatastoreIORM_Task

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case StorageResourceManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body

ConfigureDatastoreIORMRequestType of type(s) application/json

Required

{
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "spec": {
        "_typeName": "string",
        "enabled": false,
        "congestionThresholdMode": "string",
        "congestionThreshold": 0,
        "percentOfPeakThroughput": 0,
        "statsCollectionEnabled": false,
        "reservationEnabled": false,
        "statsAggregationDisabled": false,
        "reservableIopsThreshold": 0
    }
}

MoRefDatastore

datastore

Required

Reference to an instance of the Datastore managed object.

StorageIORMConfigSpec

spec

Required

Configuration settings used for creating or reconfiguring storage I/O resource management.

All fields are defined as optional. If a field is unset, the property is not changed.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

NotSupported: if called directly on a host or if called on a datastore that does not have VMFS Volume.

InvalidArgument: 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: if called on a datastore that is connected to a host that does not support storage I/O resource management.

InaccessibleDatastore: if cannot access the datastore from any of the hosts.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Storage Resource Manager Operations

POST

Storage Resource Manager Apply Storage Drs Recommendation Task