Create an FPolicy persistent store configuration for an SVM
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
POST /protocols/fpolicy/{svm.uuid}/persistent-stores
Introduced In: 9.14
Creates an FPolicy Persistent Store configuration for a specified SVM.
Important notes:
-
FPolicy Persistent Store creation is allowed only on data SVMs.
-
In persistent mode, when the Persistent Store is full, event notifications are dropped.
-
There is flexibility to provide an existing volume or create a new volume for the persitent storage. The creation of new volume is handled internally.
-
For existing volumes, the Snapshot policy is set to 'none' and the size is adjusted to the specified value.
Required properties
-
svm.uuid
- Existing SVM in which to create the FPolicy Persistent Store. -
name
- Name of the FPolicy Persistent Store. -
volume
- Volume specified for Persistent Store (only FlexVol volumes of type RW are supported).
Optional properties
-
size
- Size of the Persistent Store volume. -
autosize-mode
- Autosize mode for the Persistent Store volume.
Related ONTAP commands
-
fpolicy persistent-store create
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned.
|
svm.uuid |
string |
path |
True |
UUID of the SVM to which this object belongs. |
Request Body
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 |
||
volume |
string |
The specified volume to store the events for the FPolicy Persistent Store. |
Example request
{
"autosize_mode": "string",
"name": "ps1",
"size": "100M",
"svm": {
"uuid": "string"
},
"volume": "psvol"
}
Response
Status: 201, Created
Name | Type | Description |
---|---|---|
_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"
}
]
}
Headers
Name | Description | Type |
---|---|---|
Location |
Useful for tracking the resource location |
string |
Error
Status: Default
Error Code | Description |
---|---|
9765052 |
Cannot create more than one Persistent Store per SVM |
9765053 |
Volume mentioned does not exist in the SVM |
9765068 |
The Persistent Store name is too long. It must not exceed 500 characters |
2621516 |
This operation is only supported on a data SVM |
9765069 |
Volume is not a FlexVol volume. Only FlexVol volumes are supported for this operation. |
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. |
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
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 |
---|---|---|
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 |
||
volume |
string |
The specified volume to store the events for the FPolicy Persistent Store. |
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
next |
||
self |
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. |