Skip to main content
REST API reference

Update an FPolicy persistent store configuration for an SVM

PDFs

PATCH /protocols/fpolicy/{svm.uuid}/persistent-stores/{name}

Introduced In: 9.14

Updates a specific FPolicy Persistent Store configuration for an SVM.

Important notes:

  • If the volume exists, it is set to the size specified and the snapshot policy is set to "none". Otherwise, a new volume is created.

  • The autosize parameter is not available in PATCH operations for this endpoint, use the the "autosize" parameter in PATCH for the "/storage/volumes/{uuid}" endpoint instead.

  • When the Persistent Store is updated with a new volume, the previous volume is not automatically deleted. An option is provided to delete the previous volume.

  • fpolicy persistent-store modify

Learn more

Parameters

Name Type In Required Description

name

string

path

True

delete_volume

boolean

query

False

Delete the previous volume of a Persistent Store if a new volume is provided.

  • Introduced in: 9.15

  • Default value:

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

size

integer

The size of the Persistent Store volume, in bytes.

svm

svm

volume

string

The specified volume to store the events for the FPolicy Persistent Store.
Example request 
{
  "size": "100M",
  "svm": {
    "uuid": "string"
  },
  "volume": "psvol"
}

Response

Status: 200, Ok

Error

Status: Default
Error Code Description

9765053

Volume mentioned does not exist in the SVM

9765056

Specified Persistent Store name does not exist in the SVM

9765069

Volume is not a FlexVol volume. Only FlexVol volumes are supported for this operation.

9765070

Cannot update a Persistent Store volume when it is part of an enabled policy

9765072

Volume is not of type RW. Only volumes of type RW are supported.

9765074

Size is a required parameter for the creation of the Persistent Store.

9765077

The SVM is not associated with any aggregates.

524849

Attribute cannot be modified for the target volume because of the specified reason.

917533

The target volume is not eligible for modification due to certain constraints, such as the volume being offline or currently engaged in a volume move operation.

917826

Volume minimum autosize must be greater than zero.

918647

The designated size exceeds the maximum available capacity of the intended volume.

917534

The value specified for the field \"-size\" is too small. Update the field \"-size\" with the minimum size allowed and retry the operation.

Definitions

See Definitions

svm

Name Type Description

uuid

string

SVM UUID

fpolicy_persistent_store

The information that an FPolicy process needs in order to configure a Persistent Store.

Name Type Description

size

integer

The size of the Persistent Store volume, in bytes.

svm

svm

volume

string

The specified volume to store the events for the FPolicy Persistent Store.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.