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

Create an EBR policy

PDFs

POST /storage/snaplock/event-retention/operations

Introduced In: 9.7

Creates an EBR policy.

Required properties

  • path - Path of the file.

  • policy.name - Name of the EBR policy.

  • snaplock event-retention apply

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

id

integer

Operation ID

num_files_failed

integer

Specifies the number of files on which the application of EBR policy failed.

num_files_processed

integer

Specifies the number of files on which EBR policy was applied successfully.

num_files_skipped

integer

Specifies the number of files on which the application of EBR policy was skipped.

num_inodes_ignored

integer

Specifies the number of inodes on which the application of EBR policy was not attempted because they were not regular files.

path

string

The path for the EBR operation. Specifies the path relative to the output volume root, of the form "/path". The path can be path to a file or a directory.

policy

policy

state

string

Specifies the operation status of an EBR operation.

svm

svm

volume

volume
Example request 
{
  "id": "16842759",
  "num_files_failed": "0",
  "num_files_processed": "50",
  "num_files_skipped": "2",
  "num_inodes_ignored": "2",
  "path": "/dir1/file",
  "policy": {
    "name": "string",
    "retention_period": "P30M",
    "svm": {
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  },
  "state": "completed",
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "volume": {
    "name": "volume1",
    "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 201, Created
Name Type Description

id

integer

Operation ID

num_files_failed

integer

Specifies the number of files on which the application of EBR policy failed.

num_files_processed

integer

Specifies the number of files on which EBR policy was applied successfully.

num_files_skipped

integer

Specifies the number of files on which the application of EBR policy was skipped.

num_inodes_ignored

integer

Specifies the number of inodes on which the application of EBR policy was not attempted because they were not regular files.

path

string

The path for the EBR operation. Specifies the path relative to the output volume root, of the form "/path". The path can be path to a file or a directory.

policy

policy

state

string

Specifies the operation status of an EBR operation.

svm

svm

volume

volume
Example response 
{
  "id": "16842759",
  "num_files_failed": "0",
  "num_files_processed": "50",
  "num_files_skipped": "2",
  "num_inodes_ignored": "2",
  "path": "/dir1/file",
  "policy": {
    "name": "string",
    "retention_period": "P30M",
    "svm": {
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  },
  "state": "completed",
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "volume": {
    "name": "volume1",
    "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default, Error

Definitions

See Definitions

href

Name Type Description

href

string

_links

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

policy

Name Type Description

name

string

Specifies the EBR policy name

retention_period

string

Specifies the retention period of an event based retention policy. The retention period value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours or minutes. A period specified for years, months and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively. For example "P10Y" represents a duration of 10 years. Similarly, a duration in hours, minutes is represented by "PTH", "PTM" respectively. The period string must contain only a single time element i.e. either years, months, days, hours or minutes. A duration which combines different periods is not supported, example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the retention period field also accepts the strings "infinite" and "unspecified".

svm

svm

SVM, applies only to SVM-scoped objects.

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

ebr_operation

Name Type Description

id

integer

Operation ID

num_files_failed

integer

Specifies the number of files on which the application of EBR policy failed.

num_files_processed

integer

Specifies the number of files on which EBR policy was applied successfully.

num_files_skipped

integer

Specifies the number of files on which the application of EBR policy was skipped.

num_inodes_ignored

integer

Specifies the number of inodes on which the application of EBR policy was not attempted because they were not regular files.

path

string

The path for the EBR operation. Specifies the path relative to the output volume root, of the form "/path". The path can be path to a file or a directory.

policy

policy

state

string

Specifies the operation status of an EBR operation.

svm

svm

volume

volume

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.