Skip to main content
REST API reference
A newer release of this product is available.

Pre-populate a FlexCache volume in the cluster

PDFs

PATCH /storage/flexcache/flexcaches/{uuid}

Introduced In: 9.8

Prepopulates a FlexCache volume in the cluster.

Required properties

  • uuid - FlexCache volume UUID.

  • prepopulate.dir_paths - List of directory-paths to be prepopulated for the FlexCache volume.

  • prepopulate.exclude_dir_paths - List of directory-paths to be excluded from prepopulation for the FlexCache volume.

Default property values

If not specified in PATCH, the following default property value is assigned:

  • prepopulate.recurse - Default value is "true".

  • volume flexcache prepopulate start

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

Unique identifier of the FlexCache volume.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 0

  • Max value: 120

  • Min value: 0

Request Body

Name Type Description

name

string

FlexCache name

prepopulate

prepopulate

FlexCache prepopulate

uuid

string

FlexCache UUID. Unique identifier for the FlexCache.
Example request 
{
  "dr_cache": null,
  "global_file_locking_enabled": null,
  "name": "vol1",
  "prepopulate": {
    "dir_paths": [
      "/dir1"
    ],
    "exclude_dir_paths": [
      "/dir1/dir2"
    ]
  },
  "use_tiered_aggregate": null,
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "uuid": "string"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

66846922

FlexCache volume does not exist in the SVM

66846923

Failed to prepopulate FlexCache volume because the origin volume is not reachable

66846924

FlexCache volume is offline

66846925

FlexCache volume is not mounted or the junction-path is not active

66846926

The junction-path of FlexCache volume is not active

66846927

FlexCache volume does not have an origin volume

66846928

FlexCache volume does not exist

66846929

Using FlexCache prepopulate requires an effective cluster version of 9.8.0 or later

66846930

Using FlexCache prepopulate in a MetroCluster configuration requires an effective cluster version of 9.8.0 or later on both the local and remote clusters

66846931

Internal Error. FlexCache prepopulate job queue failed. Wait a few minutes, and then try the operation again

66846936

Failed to lookup root file handle for origin of FlexCache volume. Wait a few minutes, and then try the operation again

66846937

Internal error. Failed to initialize thread

66846939

Internal error. Failed to get the MSID of the origin volume for FlexCache volume

66846943

Failed to prepopulate because dir_path does not exist

66846944

Failed to get root constituent for FlexCache volume

66846945

Origin of FlexCache volume is not mounted or the junction-path is not active

66846946

The junction-path of origin of FlexCache volume is not active

66846947

FlexCache prepopulate job for FlexCache volume already exists

66846948

FlexCache prepopulate job for FlexCache volume could not be queued because the node is offline

Definitions

See Definitions

href

Name Type Description

href

string

_links

aggregates

Aggregate

Name Type Description

name

string

uuid

string

guarantee

Name Type Description

type

string

The type of space guarantee of this volume in the aggregate.

cluster

Name Type Description

name

string

uuid

string

svm

Name Type Description

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

volume

Name Type Description

name

string

The name of the volume.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • Introduced in: 9.6

flexcache_relationship

Name Type Description

cluster

cluster

create_time

string

Creation time of the relationship.

ip_address

string

Cluster managerment IP of the remote cluster.

size

integer

Size of the remote volume.

state

string

Volume state

volume

volume

prepopulate

FlexCache prepopulate

Name Type Description

dir_paths

array[string]

exclude_dir_paths

array[string]

recurse

boolean

Specifies whether or not the prepopulate action should search through the directory-path recursively. If not set, the default value "true" is used.

svm

FlexCache SVM

Name Type Description

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

flexcache

Defines the cache endpoint of FlexCache.

Name Type Description

name

string

FlexCache name

prepopulate

prepopulate

FlexCache prepopulate

uuid

string

FlexCache UUID. Unique identifier for the FlexCache.
Name Type Description

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.