Skip to main content

Retrieve an FPolicy configuration

Contributors
PDFs

GET /protocols/fpolicy

Introduced In: 9.6

Retrieves an FPolicy configuration.

  • fpolicy show

  • fpolicy policy show

  • fpolicy policy scope show

  • fpolicy policy event show

  • fpolicy policy external-engine show

  • fpolicy persistent-store show

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

events.filters.close_with_modification

boolean

query

False

Filter by events.filters.close_with_modification

events.filters.setattr_with_group_change

boolean

query

False

Filter by events.filters.setattr_with_group_change

events.filters.exclude_directory

boolean

query

False

Filter by events.filters.exclude_directory

events.filters.setattr_with_mode_change

boolean

query

False

Filter by events.filters.setattr_with_mode_change

events.filters.setattr_with_dacl_change

boolean

query

False

Filter by events.filters.setattr_with_dacl_change

events.filters.setattr_with_sacl_change

boolean

query

False

Filter by events.filters.setattr_with_sacl_change

events.filters.setattr_with_creation_time_change

boolean

query

False

Filter by events.filters.setattr_with_creation_time_change

events.filters.first_read

boolean

query

False

Filter by events.filters.first_read

events.filters.setattr_with_size_change

boolean

query

False

Filter by events.filters.setattr_with_size_change

events.filters.monitor_ads

boolean

query

False

Filter by events.filters.monitor_ads

events.filters.setattr_with_access_time_change

boolean

query

False

Filter by events.filters.setattr_with_access_time_change

events.filters.setattr_with_owner_change

boolean

query

False

Filter by events.filters.setattr_with_owner_change

events.filters.close_without_modification

boolean

query

False

Filter by events.filters.close_without_modification

events.filters.setattr_with_allocation_size_change

boolean

query

False

Filter by events.filters.setattr_with_allocation_size_change

events.filters.setattr_with_modify_time_change

boolean

query

False

Filter by events.filters.setattr_with_modify_time_change

events.filters.offline_bit

boolean

query

False

Filter by events.filters.offline_bit

events.filters.first_write

boolean

query

False

Filter by events.filters.first_write

events.filters.open_with_write_intent

boolean

query

False

Filter by events.filters.open_with_write_intent

events.filters.open_with_delete_intent

boolean

query

False

Filter by events.filters.open_with_delete_intent

events.filters.write_with_size_change

boolean

query

False

Filter by events.filters.write_with_size_change

events.filters.close_with_read

boolean

query

False

Filter by events.filters.close_with_read

events.monitor_fileop_failure

boolean

query

False

Filter by events.monitor_fileop_failure

  • Introduced in: 9.13

events.protocol

string

query

False

Filter by events.protocol

events.file_operations.delete_dir

boolean

query

False

Filter by events.file_operations.delete_dir

events.file_operations.create

boolean

query

False

Filter by events.file_operations.create

events.file_operations.rename_dir

boolean

query

False

Filter by events.file_operations.rename_dir

events.file_operations.rename

boolean

query

False

Filter by events.file_operations.rename

events.file_operations.close

boolean

query

False

Filter by events.file_operations.close

events.file_operations.open

boolean

query

False

Filter by events.file_operations.open

events.file_operations.setattr

boolean

query

False

Filter by events.file_operations.setattr

events.file_operations.symlink

boolean

query

False

Filter by events.file_operations.symlink

events.file_operations.getattr

boolean

query

False

Filter by events.file_operations.getattr

events.file_operations.read

boolean

query

False

Filter by events.file_operations.read

events.file_operations.write

boolean

query

False

Filter by events.file_operations.write

events.file_operations.link

boolean

query

False

Filter by events.file_operations.link

events.file_operations.create_dir

boolean

query

False

Filter by events.file_operations.create_dir

events.file_operations.access

boolean

query

False

Filter by events.file_operations.access

  • Introduced in: 9.13

events.file_operations.lookup

boolean

query

False

Filter by events.file_operations.lookup

events.file_operations.delete

boolean

query

False

Filter by events.file_operations.delete

events.name

string

query

False

Filter by events.name

events.volume_monitoring

boolean

query

False

Filter by events.volume_monitoring

policies.mandatory

boolean

query

False

Filter by policies.mandatory

policies.enabled

boolean

query

False

Filter by policies.enabled

policies.events.name

string

query

False

Filter by policies.events.name

policies.scope.exclude_extension

string

query

False

Filter by policies.scope.exclude_extension

policies.scope.include_shares

string

query

False

Filter by policies.scope.include_shares

policies.scope.exclude_shares

string

query

False

Filter by policies.scope.exclude_shares

policies.scope.check_extensions_on_directories

boolean

query

False

Filter by policies.scope.check_extensions_on_directories

  • Introduced in: 9.11

policies.scope.include_volumes

string

query

False

Filter by policies.scope.include_volumes

policies.scope.include_export_policies

string

query

False

Filter by policies.scope.include_export_policies

policies.scope.exclude_volumes

string

query

False

Filter by policies.scope.exclude_volumes

policies.scope.include_extension

string

query

False

Filter by policies.scope.include_extension

policies.scope.object_monitoring_with_no_extension

boolean

query

False

Filter by policies.scope.object_monitoring_with_no_extension

  • Introduced in: 9.11

policies.scope.exclude_export_policies

string

query

False

Filter by policies.scope.exclude_export_policies

policies.name

string

query

False

Filter by policies.name

policies.passthrough_read

boolean

query

False

Filter by policies.passthrough_read

  • Introduced in: 9.11

policies.engine.name

string

query

False

Filter by policies.engine.name

policies.priority

integer

query

False

Filter by policies.priority

  • Max value: 10

  • Min value: 1

policies.allow_privileged_access

boolean

query

False

Filter by policies.allow_privileged_access

  • Introduced in: 9.13

policies.privileged_user

string

query

False

Filter by policies.privileged_user

  • Introduced in: 9.11

policies.persistent_store

string

query

False

Filter by policies.persistent_store

  • Introduced in: 9.14

engines.certificate.name

string

query

False

Filter by engines.certificate.name

  • Introduced in: 9.11

engines.certificate.ca

string

query

False

Filter by engines.certificate.ca

  • Introduced in: 9.11

engines.certificate.serial_number

string

query

False

Filter by engines.certificate.serial_number

  • Introduced in: 9.11

engines.request_abort_timeout

string

query

False

Filter by engines.request_abort_timeout

  • Introduced in: 9.11

engines.request_cancel_timeout

string

query

False

Filter by engines.request_cancel_timeout

  • Introduced in: 9.11

engines.server_progress_timeout

string

query

False

Filter by engines.server_progress_timeout

  • Introduced in: 9.11

engines.max_server_requests

integer

query

False

Filter by engines.max_server_requests

  • Introduced in: 9.11

  • Max value: 10000

  • Min value: 1

engines.primary_servers

string

query

False

Filter by engines.primary_servers

engines.buffer_size.recv_buffer

integer

query

False

Filter by engines.buffer_size.recv_buffer

  • Introduced in: 9.11

  • Max value: 7895160

  • Min value: 0

engines.buffer_size.send_buffer

integer

query

False

Filter by engines.buffer_size.send_buffer

  • Introduced in: 9.11

  • Max value: 7895160

  • Min value: 0

engines.keep_alive_interval

string

query

False

Filter by engines.keep_alive_interval

  • Introduced in: 9.13

engines.status_request_interval

string

query

False

Filter by engines.status_request_interval

  • Introduced in: 9.11

engines.name

string

query

False

Filter by engines.name

engines.type

string

query

False

Filter by engines.type

engines.resiliency.directory_path

string

query

False

Filter by engines.resiliency.directory_path

  • Introduced in: 9.11

engines.resiliency.enabled

boolean

query

False

Filter by engines.resiliency.enabled

  • Introduced in: 9.11

engines.resiliency.retention_duration

string

query

False

Filter by engines.resiliency.retention_duration

  • Introduced in: 9.11

engines.secondary_servers

string

query

False

Filter by engines.secondary_servers

engines.format

string

query

False

Filter by engines.format

  • Introduced in: 9.11

engines.ssl_option

string

query

False

Filter by engines.ssl_option

  • Introduced in: 9.11

engines.port

integer

query

False

Filter by engines.port

persistent_stores.size

integer

query

False

Filter by persistent_stores.size

  • Introduced in: 9.15

persistent_stores.autosize_mode

string

query

False

Filter by persistent_stores.autosize_mode

  • Introduced in: 9.15

persistent_stores.name

string

query

False

Filter by persistent_stores.name

  • Introduced in: 9.14

persistent_stores.volume

string

query

False

Filter by persistent_stores.volume

  • Introduced in: 9.14

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<