Retrieve an FPolicy configuration for an SVM
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /protocols/fpolicy/{svm.uuid}/policies
Introduced In: 9.6
Retrieves the FPolicy policy configuration of an SVM. ONTAP allows the creation of a cluster level FPolicy policy that acts as a template for all the data SVMs belonging to the cluster. This cluster level FPolicy policy is also retrieved for the specified SVM.
Related ONTAP commands
-
fpolicy policy show
-
fpolicy policy scope show
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
name |
string |
query |
False |
Filter by name |
scope.object_monitoring_with_no_extension |
boolean |
query |
False |
Filter by scope.object_monitoring_with_no_extension
|
scope.include_extension |
string |
query |
False |
Filter by scope.include_extension |
scope.exclude_export_policies |
string |
query |
False |
Filter by scope.exclude_export_policies |
scope.exclude_volumes |
string |
query |
False |
Filter by scope.exclude_volumes |
scope.check_extensions_on_directories |
boolean |
query |
False |
Filter by scope.check_extensions_on_directories
|
scope.include_shares |
string |
query |
False |
Filter by scope.include_shares |
scope.exclude_shares |
string |
query |
False |
Filter by scope.exclude_shares |
scope.include_export_policies |
string |
query |
False |
Filter by scope.include_export_policies |
scope.include_volumes |
string |
query |
False |
Filter by scope.include_volumes |
scope.exclude_extension |
string |
query |
False |
Filter by scope.exclude_extension |
mandatory |
boolean |
query |
False |
Filter by mandatory |
events.name |
string |
query |
False |
Filter by events.name |
enabled |
boolean |
query |
False |
Filter by enabled |
persistent_store |
string |
query |
False |
Filter by persistent_store
|
passthrough_read |
boolean |
query |
False |
Filter by passthrough_read
|
privileged_user |
string |
query |
False |
Filter by privileged_user
|
engine.name |
string |
query |
False |
Filter by engine.name |
priority |
integer |
query |
False |
Filter by priority
|
allow_privileged_access |
boolean |
query |
False |
Filter by allow_privileged_access
|
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.
|
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.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
Number of Records |
records |
array[fpolicy_policy] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"engine": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "string"
},
"events": [
"event_cifs",
"event_open"
],
"name": "fp_policy_1",
"persistent_store": "ps1",
"priority": 1,
"privileged_user": "mydomain\\testuser",
"scope": {
"exclude_export_policies": [
"string"
],
"exclude_extension": [
"string"
],
"exclude_shares": [
"string"
],
"exclude_volumes": [
"vol1",
"vol_svm1",
"*"
],
"include_export_policies": [
"string"
],
"include_extension": [
"string"
],
"include_shares": [
"sh1",
"share_cifs"
],
"include_volumes": [
"vol1",
"vol_svm1"
]
},
"svm": {
"uuid": "string"
}
}
]
}
Error
Status: Default, Error
Name | Type | Description |
---|---|---|
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 |
||
self |
_links
Name | Type | Description |
---|---|---|
self |
fpolicy_engine_reference
FPolicy external engine
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the FPolicy external engine. |
fpolicy_event_reference
FPolicy events
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
scope
Name | Type | Description |
---|---|---|
check_extensions_on_directories |
boolean |
Specifies whether the file name extension checks also apply to directory objects. If this parameter is set to true, the directory objects are subjected to the same extension checks as regular files. If this parameter is set to false, the directory names are not matched for extensions and notifications are sent for directories even if their name extensions do not match. Default is false. |
exclude_export_policies |
array[string] |
|
exclude_extension |
array[string] |
|
exclude_shares |
array[string] |
|
exclude_volumes |
array[string] |
|
include_export_policies |
array[string] |
|
include_extension |
array[string] |
|
include_shares |
array[string] |
|
include_volumes |
array[string] |
|
object_monitoring_with_no_extension |
boolean |
Specifies whether the extension checks also apply to objects with no extension. If this parameter is set to true, all objects with or without extensions are monitored. Default is false. |
svm
Name | Type | Description |
---|---|---|
uuid |
string |
SVM UUID |
fpolicy_policy
Name | Type | Description |
---|---|---|
allow_privileged_access |
boolean |
Specifies whether privileged access is required for FPolicy servers. Privileged access is used when the FPolicy server requires direct access to the cluster nodes. When this parameter is set to true, FPolicy servers can access files on the cluster using a separate data channel with privileged access. |
enabled |
boolean |
Specifies if the policy is enabled on the SVM or not. If no value is mentioned for this field but priority is set, then this policy will be enabled. |
engine |
FPolicy external engine |
|
events |
array[fpolicy_event_reference] |
|
mandatory |
boolean |
Specifies what action to take on a file access event in a case when all primary and secondary servers are down or no response is received from the FPolicy servers within a given timeout period. When this parameter is set to true, file access events will be denied under these circumstances. |
name |
string |
Specifies the name of the policy. |
passthrough_read |
boolean |
Specifies whether passthrough-read should be allowed for FPolicy servers registered for the policy. Passthrough-read is a way to read data for offline files without restoring the files to primary storage. Offline files are files that have been moved to secondary storage. |
persistent_store |
string |
Specifies the persistent storage name. This can then be used to enable persistent mode for FPolicy events. |
priority |
integer |
Specifies the priority that is assigned to this policy. |
privileged_user |
string |
Specifies the privileged user name for accessing files on the cluster using a separate data channel with privileged access. The input for this field should be in "domain\username" format. |
scope |
||
svm |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_error
Name | Type | Description |
---|---|---|
arguments |
array[error_arguments] |
Message arguments |