1-800-833-1132 : 1-303-449-6400

Modify Cache Filesystem

Description

Modify the auto reclaim initiate threshold, auto reclaim terminate threshold, burst threshold, or maximum capacity for the specified cache filesystem.

Note:

If an optional request parameter is not included, the previous setting is retained.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/cache_filesystem/{cache filesystem UUID}[?auto_reclaim_initiate_threshold={double}]​[&auto_reclaim_terminate_threshold={double}]​[&burst_threshold={double}]​[&max_capacity_in_bytes={64‑bit integer}]

To determine the UUID for a cache filesystem, see Get Cache Filesystems.

Request Parameters

Parameter	Description	Required
AutoReclaim InitiateThreshold	The percentage full at which cache reclamation begins, expressed as a double-precision floating point number. Note: AutoReClaimInitiateThreshold must be equal or larger than AutoReclaimTerminateThreshold.	no
AutoReclaim Terminate Threshold	The percentage full at which cache reclamation terminates, expressed as a double-precision floating point number. Note: AutoReClaimInitiateThreshold must be equal or larger than AutoReclaimTerminateThreshold.	no
BurstThreshold	The percent utilization the cache must exceed to disable bursting, which permits the allocation of all cache resources on one job regardless of the job’s priority. Having a bust threshold below 1.0 ensures that one job does not prevent resources from being available for other jobs.	no
MaxCapacityIn Bytes	The maximum capacity that can be used by the cache.	no

Responses

Response Elements

<Data>
   <AutoReclaimInitiateThreshold>
      {double}
   </AutoReclaimInitiateThreshold>
   <AutoReclaimTerminateThreshold>
      {double}
   </AutoReclaimTerminateThreshold>
   <BurstThreshold>{double}</BurstThreshold>
   <Id>{string}</Id>
   <MaxCapacityInBytes>{64‑bit integer}</MaxCapacityInBytes>
   <MaxPercentUtilizationOfFilesystem>
      {double}
   </MaxPercentUtilizationOfFilesystem>
   <NodeId>{string}</NodeId>
   <Path>{string}</Path>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
AutoReclaim InitiateThreshold	The percentage full at which cache reclamation begins, expressed as a double-precision floating point number.
AutoReclaim Terminate Threshold	The percentage full at which cache reclamation terminates, expressed as a double-precision floating point number.
BurstThreshold	The percent utilization the cache must exceed to disable bursting, which permits the allocation of all cache resources on one job regardless of the job’s priority. Having a bust threshold below 1.0 ensures that one job does not prevent resources from being available for other jobs.
Id	The UUID for the cache filesystem.
MaxCapacityIn Bytes	The maximum capacity that can be used by the cache. Note: If both MaxCapacityInBytes and MaxPercentUtilizationOfFilesystem are specified, the lesser of the two is used for the maximum cache capacity.
MaxPercent UtilizationOf Filesystem	The maximum capacity that can be used by the cache as a percentage of the total usable cache capacity. Note: If both MaxCapacityInBytes and MaxPercentUtilizationOfFilesystem are specified, the lesser of the two is used for the maximum cache capacity.
NodeId	The UUID for the for the node associated with the cache.
Path	The path to the cache filesystem on the BlackPearl system.

Example

Sample Request

This request changes the auto reclaim initiate threshold for the cache filesystem with UUID f2e97b09-75c0-47f6-8118-e96677f30869 to .90.

PUT http[s]://blackpearl-hostname/_rest_/cache_filesystem/f2e97b09-75c0-47f6-8118-e96677f30869​?auto_reclaim_initiate_threshold=.90 HTTP/1.1

Sample Response

HTTP/1.1 200 OK

<Data>
   <AutoReclaimInitiateThreshold>
      0.90
   </AutoReclaimInitiateThreshold>
   <AutoReclaimTerminateThreshold>
      0.72
   </AutoReclaimTerminateThreshold>
   <BurstThreshold>1.01</BurstThreshold>
   <Id>f2e97b09-75c0-47f6-8118-e96677f30869</Id>
   <MaxCapacityInBytes/>
   <MaxPercentUtilizationOfFilesystem/>
   <NodeId>9a50d885-00d0-468c-a7a6-bdc54060923a</NodeId>
   <Path>
      /usr/local/BlackPearl/frontend/cachedir/
   </Path>
</Data>