Host V Flash Manager Host Get V Flash Module Default Config

Host V Flash Manager Host Get V Flash Module Default Config

Retrieve the default supported configuration for a given vFlash module

Required privileges: Host.Config.AdvancedConfig

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostVFlashManager/{moId}/HostGetVFlashModuleDefaultConfig
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 HostVFlashManager/{moId}.

string
release
Required

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

Request Body
HostGetVFlashModuleDefaultConfigRequestType of type(s) application/json
Required 
{
    "vFlashModule": "string"
}
string
vFlashModule
Required

Name of the vFlash module

Authentication
This operation uses the following authentication methods.
Responses
200

The supported default vFlash cache configuration

Returns VirtualDiskVFlashCacheConfigInfo of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "vFlashModule": "string",
    "reservationInMB": 0,
    "cacheConsistencyType": "string",
    "cacheMode": "string",
    "blockSizeInKB": 0
}
string
vFlashModule
Optional

Deprecated since vSphere 7.0 because vFlash Read Cache end of availability.

Name of vFlash module which manages the cache.

If not specified, default setting HostVFlashManagerVFlashCacheConfigSpec.defaultVFlashModule will be used.

integer As int64 As int64
reservationInMB
Optional

Deprecated since vSphere 7.0 because vFlash Read Cache end of availability.

Amount of vFlash resource that is guaranteed available to the cache.

If not specified, default reservation will be used.

string
cacheConsistencyType
Optional

Deprecated since vSphere 7.0 because vFlash Read Cache end of availability.

Cache data consistency types after a crash.

See VirtualDiskVFlashCacheConfigInfoCacheConsistencyTypeEnum for supported types. If not specified, the default value used is strong

string
cacheMode
Optional

Deprecated since vSphere 7.0 because vFlash Read Cache end of availability.

Cache modes.

See VirtualDiskVFlashCacheConfigInfoCacheModeEnum for supported modes. If not specified, the default value used is write_thru.

integer As int64 As int64
blockSizeInKB
Optional

Deprecated since vSphere 7.0 because vFlash Read Cache end of availability.

Cache block size.

This parameter allows the user to control how much data gets cached on a single access to the VMDK. Max block size is 1MB. Default is 4KB.


500

NotFound: If vFlash resource is not configured or the contained VFFS volume cannot be found on the host.

HostConfigFault: If the default vFlash module configuration option cannot be retrieved.

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
Host Vflash Manager Operations
POST
Host V Flash Manager Configure V Flash Resource Ex Task
GET
Host V Flash Manager Get V Flash Config Info
POST
Host V Flash Manager Host Configure V Flash Resource
POST
Host V Flash Manager Host Config V Flash Cache
POST
Host V Flash Manager Host Get V Flash Module Default Config
POST
Host V Flash Manager Host Remove V Flash Resource