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

Protocols fpolicy svm.uuid persistent-stores endpoint overview

PDFs

Overview

  • The FPolicy persistent store feature enables the configuration of a persistent store. This includes:

  • setting up a store to retain event notifications

  • specifying the volume created for FPolicy persistent store

  • Each SVM can only have one persistent store. The same persistent store can be used by multiple policies within the same SVM. Once a persistent store is created, it can be utilized in the FPolicy policy configuration for the async and non-mandatory engine.

Examples

Creating an FPolicy persistent store with all required parameters

# The API:
POST /protocols/fpolicy/{svm.uuid}/persistent-stores

# The call:
curl -X POST "https://<mgmt-ip>/api/protocols/fpolicy/4f643fb4-fd21-11e8-ae49-0050568e2c1e/persistent-stores?return_records=true" -H "accept: application/json" -d "{\"name\": \"ps1\", \"volume\": \"psvol\" }"

# The response:
{
"num_records": 1,
"records": [
  {
    "name": "ps1",
    "volume": "psvol",
  }
]
}

Creating an FPolicy persistent store with the minimum required fields

# The API:
POST /protocols/fpolicy/{svm.uuid}/persistent-stores

# The call:
curl -X POST "https://<mgmt-ip>/api/protocols/fpolicy/4f643fb4-fd21-11e8-ae49-0050568e2c1e/persistent-stores?return_records=true" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"name\": \"ps1\", \"volume\": \"psvol\" }"

# The response:
{
"num_records": 1,
"records": [
  {
    "name": "ps1",
    "volume": "psvol",
  }
]
}

Retrieving an FPolicy persistent store configuration for a specific SVM

# The API:
GET /protocols/fpolicy/{svm.uuid}/persistent-stores

# The call:
curl -X GET "https://<mgmt-ip>/api/protocols/fpolicy/4f643fb4-fd21-11e8-ae49-0050568e2c1e/persistent-stores/?fields=*&return_records=true&return_timeout=15" -H "accept: application/json"

# The response:
{
"records": [
  {
    "name": "ps1"
  }
],
"num_records": 1
}

Retrieving a specific FPolicy persistent store configuration for a specific SVM

# The API:
GET /protocols/fpolicy/{svm.uuid}/persistent-stores/{name}

# The call:
curl -X GET "https://<mgmt-ip>/api/protocols/fpolicy/4f643fb4-fd21-11e8-ae49-0050568e2c1e/persistent-stores/persistent_fpolicy?fields=*&return_records=true&return_timeout=15" -H "accept: application/json"

# The response:
{
"svm": {
  "uuid": "4f643fb4-fd21-11e8-ae49-0050568e2c1e"
},
"name": "ps1",
"volume": "psvol",
}

Updating an FPolicy persistent store for an SVM

# The API:
PATCH /protocols/fpolicy/{svm.uuid}/persistent-stores/{name}

# The call:
curl -X PATCH "https://<mgmt-ip>/api/protocols/fpolicy/4f643fb4-fd21-11e8-ae49-0050568e2c1e/persistent-stores/persistent_fpolicy" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"volume\": \"psvol\" }"

Deleting a specific FPolicy persistent store configuration for a specific SVM

# The API:
DELETE /protocols/fpolicy/{svm.uuid}/persistent-stores/{name}

# The call:
curl -X DELETE "https://<mgmt-ip>/api/protocols/fpolicy/4f643fb4-fd21-11e8-ae49-0050568e2c1e/persistent-stores/persistent_fpolicy" -H "accept: application/json"