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

Retrieve the FPolicy event configuration for all events for an SVM

PDFs

GET /protocols/fpolicy/{svm.uuid}/events

Introduced In: 9.6

Retrieves FPolicy event configurations for all events for a specified SVM. ONTAP allows the creation of cluster-level FPolicy events that act as a template for all the data SVMs belonging to the cluster. These cluster-level FPolicy events are also retrieved for the specified SVM.

  • fpolicy policy event show

Learn more

Parameters

Name Type In Required Description

file_operations.read

boolean

query

False

Filter by file_operations.read

file_operations.rename

boolean

query

False

Filter by file_operations.rename

file_operations.close

boolean

query

False

Filter by file_operations.close

file_operations.symlink

boolean

query

False

Filter by file_operations.symlink

file_operations.write

boolean

query

False

Filter by file_operations.write

file_operations.link

boolean

query

False

Filter by file_operations.link

file_operations.delete_dir

boolean

query

False

Filter by file_operations.delete_dir

file_operations.lookup

boolean

query

False

Filter by file_operations.lookup

file_operations.rename_dir

boolean

query

False

Filter by file_operations.rename_dir

file_operations.getattr

boolean

query

False

Filter by file_operations.getattr

file_operations.setattr

boolean

query

False

Filter by file_operations.setattr

file_operations.create_dir

boolean

query

False

Filter by file_operations.create_dir

file_operations.delete

boolean

query

False

Filter by file_operations.delete

file_operations.open

boolean

query

False

Filter by file_operations.open

file_operations.create

boolean

query

False

Filter by file_operations.create

protocol

string

query

False

Filter by protocol

volume_monitoring

boolean

query

False

Filter by volume_monitoring

filters.setattr_with_access_time_change

boolean

query

False

Filter by filters.setattr_with_access_time_change

filters.setattr_with_sacl_change

boolean

query

False

Filter by filters.setattr_with_sacl_change

filters.setattr_with_size_change

boolean

query

False

Filter by filters.setattr_with_size_change

filters.setattr_with_allocation_size_change

boolean

query

False

Filter by filters.setattr_with_allocation_size_change

filters.setattr_with_modify_time_change

boolean

query

False

Filter by filters.setattr_with_modify_time_change

filters.write_with_size_change

boolean

query

False

Filter by filters.write_with_size_change

filters.setattr_with_mode_change

boolean

query

False

Filter by filters.setattr_with_mode_change

filters.monitor_ads

boolean

query

False

Filter by filters.monitor_ads

filters.close_with_modification

boolean

query

False

Filter by filters.close_with_modification

filters.first_read

boolean

query

False

Filter by filters.first_read

filters.setattr_with_owner_change

boolean

query

False

Filter by filters.setattr_with_owner_change

filters.first_write

boolean

query

False

Filter by filters.first_write

filters.setattr_with_creation_time_change

boolean

query

False

Filter by filters.setattr_with_creation_time_change

filters.setattr_with_dacl_change

boolean

query

False

Filter by filters.setattr_with_dacl_change

filters.exclude_directory

boolean

query

False

Filter by filters.exclude_directory

filters.offline_bit

boolean

query

False

Filter by filters.offline_bit

filters.open_with_write_intent

boolean

query

False

Filter by filters.open_with_write_intent

filters.setattr_with_group_change

boolean

query

False

Filter by filters.setattr_with_group_change

filters.close_without_modification

boolean

query

False

Filter by filters.close_without_modification

filters.close_with_read

boolean

query

False

Filter by filters.close_with_read

filters.open_with_delete_intent

boolean

query

False

Filter by filters.open_with_delete_intent

name

string

query

False

Filter by name

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_event]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "name": "event_nfs_close",
      "protocol": "string"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

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

file_operations

Specifies the file operations for the FPolicy event. You must specify a valid protocol in the protocol parameter. The event will check the operations specified from all client requests using the protocol.

Name Type Description

close

boolean

File close operations

create

boolean

File create operations

create_dir

boolean

Directory create operations

delete

boolean

File delete operations

delete_dir

boolean

Directory delete operations

getattr

boolean

Get attribute operations

link

boolean

Link operations

lookup

boolean

Lookup operations

open

boolean

File open operations

read

boolean

File read operations

rename

boolean

File rename operations

rename_dir

boolean

Directory rename operations

setattr

boolean

Set attribute operations

symlink

boolean

Symbolic link operations

write

boolean

File write operations

filters

Specifies the list of filters for a given file operation for the specified protocol. When you specify the filters, you must specify the valid protocols and a valid file operations.

Name Type Description

close_with_modification

boolean

Filter the client request for close with modification.

close_with_read

boolean

Filter the client request for close with read.

close_without_modification

boolean

Filter the client request for close without modification.

exclude_directory

boolean

Filter the client requests for directory operations. When this filter is specified directory operations are not monitored.

first_read

boolean

Filter the client requests for the first-read.

first_write

boolean

Filter the client requests for the first-write.

monitor_ads

boolean

Filter the client request for alternate data stream.

offline_bit

boolean

Filter the client request for offline bit set. FPolicy server receives notification only when offline files are accessed.

open_with_delete_intent

boolean

Filter the client request for open with delete intent.

open_with_write_intent

boolean

Filter the client request for open with write intent.

setattr_with_access_time_change

boolean

Filter the client setattr requests for changing the access time of a file or directory.

setattr_with_allocation_size_change

boolean

Filter the client setattr requests for changing the allocation size of a file.

setattr_with_creation_time_change

boolean

Filter the client setattr requests for changing the creation time of a file or directory.

setattr_with_dacl_change

boolean

Filter the client setattr requests for changing dacl on a file or directory.

setattr_with_group_change

boolean

Filter the client setattr requests for changing group of a file or directory.

setattr_with_mode_change

boolean

Filter the client setattr requests for changing the mode bits on a file or directory.

setattr_with_modify_time_change

boolean

Filter the client setattr requests for changing the modification time of a file or directory.

setattr_with_owner_change

boolean

Filter the client setattr requests for changing owner of a file or directory.

setattr_with_sacl_change

boolean

Filter the client setattr requests for changing sacl on a file or directory.

setattr_with_size_change

boolean

Filter the client setattr requests for changing the size of a file.

write_with_size_change

boolean

Filter the client request for write with size change.

fpolicy_event

The information that a FPolicy process needs to determine what file access operations to monitor and for which of the monitored events notifications should be sent to the external FPolicy server.

Name Type Description

file_operations

file_operations

Specifies the file operations for the FPolicy event. You must specify a valid protocol in the protocol parameter. The event will check the operations specified from all client requests using the protocol.

filters

filters

Specifies the list of filters for a given file operation for the specified protocol. When you specify the filters, you must specify the valid protocols and a valid file operations.

name

string

Specifies the name of the FPolicy event.

protocol

string

Protocol for which event is created. If you specify protocol, then you must also specify a valid value for the file operation parameters. The value of this parameter must be one of the following:

  • cifs - for the CIFS protocol.

  • nfsv3 - for the NFSv3 protocol.

  • nfsv4 - for the NFSv4 protocol.

volume_monitoring

boolean

Specifies whether volume operation monitoring is required.

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.