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

Retrieve the FPolicy persistent store configurations for an SVM

PDFs

GET /protocols/fpolicy/{svm.uuid}/persistent-stores

Introduced In: 9.14

Retrieves FPolicy Persistent Store configurations for a specified SVM.

  • fpolicy persistent-store show

Learn more

Parameters

Name Type In Required Description

size

integer

query

False

Filter by size

  • Introduced in: 9.15

name

string

query

False

Filter by name

autosize_mode

string

query

False

Filter by autosize_mode

  • Introduced in: 9.15

volume

string

query

False

Filter by volume

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 15

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[fpolicy_persistent_store]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "autosize_mode": "string",
      "name": "ps1",
      "size": "100M",
      "svm": {
        "uuid": "string"
      },
      "volume": "psvol"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

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

autosize_mode

string

Autosize mode for the volume. grow ‐ Volume automatically grows in response to the amount of space used. grow_shrink ‐ Volume grows or shrinks in response to the amount of space used. off ‐ Autosizing of the volume is disabled.

name

string

The name specified for the FPolicy Persistent Store.

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.