fpolicy

Contributors

fpolicy-disable-policy

PATCH /api/protocols/fpolicy/{svm.uuid}/policies/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

policy-name

name

fpolicy-enable-policy

PATCH /api/protocols/fpolicy/{svm.uuid}/policies/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

policy-name

name

sequence-number

priority

fpolicy-passthrough-read-connection-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/connections?passthrough_read=true

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

connected-since

update_time

Specifies the time at which FPolicy passthrough-read is connected or disconnected.

control-session-id

session_uuid

Unique session ID associated with each FPolicy passthrough-read connection and it can be used to identify the established connection.

disconnect-reason

disconnected_reason.message

Indicates the reason for FPolicy passthrough-read disconnection.

disconnected-since

update_time

Specifies the time at which FPolicy passthrough-read is connected or disconnected.

fpolicy-server

server

IP address of the FPolicy server.

node

node.name

policy-name

policy.name

Policy name attached to the FPolicy passthrough-read connection.

server-status

state

Specifies the FPolicy passthrough-read connection state, indicating whether it is in a connected or disconnected state.

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-policy-create

POST /api/protocols/fpolicy/{svm.uuid}/policies

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

allow-privileged-access

No REST Equivalent

engine-name

engine.name

events

events.name

is-mandatory

mandatory

is-passthrough-read-enabled

passthrough_read

policy-name

name

privileged-user-name

privileged_user

return-record

return_records

fpolicy-policy-delete

DELETE /api/protocols/fpolicy/{svm.uuid}/policies/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

policy-name

name

fpolicy-policy-event-create

POST /api/protocols/fpolicy/{svm.uuid}/events

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

event-name

name

file-operations

file_operations

filter-string

filters

protocol

protocol

return-record

return_records

volume-operation

volume_monitoring

fpolicy-policy-event-delete

DELETE /api/protocols/fpolicy/{svm.uuid}/events/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

event-name

name

fpolicy-policy-event-get-iter

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

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

event-name

name

file-operations

file_operations

filter-string

filters

protocol

protocol

volume-operation

volume_monitoring

vserver

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-policy-event-modify

PATCH /api/protocols/fpolicy/{svm.uuid}/events/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

event-name

name

file-operations

file_operations

filter-string

filters

protocol

protocol

volume-operation

volume_monitoring

fpolicy-policy-external-engine-create

POST /api/protocols/fpolicy/{svm.uuid}/engines

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

certificate-ca

certificate.ca

certificate-common-name

certificate.name

certificate-serial

certificate.serial_number

engine-name

name

extern-engine-type

type

is-resiliency-enabled

resiliency.enabled

keep-alive-interval

No REST Equivalent

max-connection-retries

No REST Equivalent

max-server-requests

max_server_requests

port-number

port

primary-servers

primary_servers

recv-buffer-size

buffer_size.recv_buffer

request-abort-timeout

request_abort_timeout

request-cancel-timeout

request_cancel_timeout

resiliency-directory-path

resiliency.directory_path

resiliency-max-retention-duration

resiliency.retention_duration

return-record

return_records

secondary-servers

secondary_servers

send-buffer-size

buffer_size.send_buffer

server-progress-timeout

server_progress_timeout

session-timeout

No REST Equivalent

ssl-option

ssl_option

status-request-interval

status_request_interval

fpolicy-policy-external-engine-delete

DELETE /api/protocols/fpolicy/{svm.uuid}/engines/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

engine-name

name

fpolicy-policy-external-engine-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/engines

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

certificate-ca

certificate.ca

certificate-common-name

certificate.name

certificate-serial

certificate.serial_number

engine-name

name

extern-engine-type

type

is-resiliency-enabled

resiliency.enabled

keep-alive-interval

No REST Equivalent

max-connection-retries

No REST Equivalent

max-server-requests

max_server_requests

port-number

port

primary-servers

primary_servers

recv-buffer-size

buffer_size.recv_buffer

request-abort-timeout

request_abort_timeout

request-cancel-timeout

request_cancel_timeout

resiliency-directory-path

resiliency.directory_path

resiliency-max-retention-duration

resiliency.retention_duration

secondary-servers

secondary_servers

send-buffer-size

buffer_size.send_buffer

server-progress-timeout

server_progress_timeout

session-timeout

No REST Equivalent

ssl-option

ssl_option

status-request-interval

status_request_interval

vserver

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-policy-external-engine-modify

PATCH /api/protocols/fpolicy/{svm.uuid}/engines/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

certificate-ca

certificate.ca

certificate-common-name

certificate.name

certificate-serial

certificate.serial_number

engine-name

name

extern-engine-type

type

is-resiliency-enabled

resiliency.enabled

keep-alive-interval

No REST Equivalent

max-connection-retries

No REST Equivalent

max-server-requests

max_server_requests

port-number

port

primary-servers

primary_servers

recv-buffer-size

buffer_size.recv_buffer

request-abort-timeout

request_abort_timeout

request-cancel-timeout

request_cancel_timeout

resiliency-directory-path

resiliency.directory_path

resiliency-max-retention-duration

resiliency.retention_duration

secondary-servers

secondary_servers

send-buffer-size

buffer_size.send_buffer

server-progress-timeout

server_progress_timeout

session-timeout

No REST Equivalent

ssl-option

ssl_option

status-request-interval

status_request_interval

fpolicy-policy-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/policies/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

allow-privileged-access

No REST Equivalent

engine-name

engine.name

events

events

is-mandatory

mandatory

is-passthrough-read-enabled

passthrough_read

policy-name

name

privileged-user-name

privileged_user

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-policy-modify

PATCH /api/protocols/fpolicy/{svm.uuid}/policies/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

allow-privileged-access

No REST Equivalent

engine-name

engine.name

events

events

is-mandatory

mandatory

is-passthrough-read-enabled

passthrough_read

policy-name

name

privileged-user-name

privileged_user

fpolicy-policy-scope-create

POST /api/protocols/fpolicy/{svm.uuid}/policies

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

check-extensions-on-directories

scope.check-extensions-on-directories

export-policies-to-exclude

scope.exclude_export_policies

export-policies-to-include

scope.include_export_policies

file-extensions-to-exclude

scope.exclude_extension

file-extensions-to-include

scope.include_extension

is-monitoring-of-objects-with-no-extension-enabled

scope.object_monitoring_with_no_extension

policy-name

name

return-record

return_records

shares-to-exclude

scope.exclude_shares

shares-to-include

scope.include_shares

volumes-to-exclude

scope.exclude_volumes

volumes-to-include

scope.include_volumes

fpolicy-policy-scope-delete

Note: As per the design, "scope" is an attribute under the "fpolicy/{svm.uuid}/policies" REST end point. After a policy is created, use a PATCH operation on "fpolicy/{svm.uuid}/policies" to modify the scope. As a policy cannot function without a scope, the REST design does not allow for the deletion of the scope only. A DELETE operation on "fpolicy/{svm.uuid}/policies" deletes the policy along with the scope.

This ONTAPI call does not have an equivalent REST API call.

fpolicy-policy-scope-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/policies/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

check-extensions-on-directories

scope.check-extensions-on-directories

export-policies-to-exclude

scope.exclude_export_policies

export-policies-to-include

scope.include_export_policies

file-extensions-to-exclude

scope.exclude_extension

file-extensions-to-include

scope.include_extension

is-monitoring-of-objects-with-no-extension-enabled

scope.object_monitoring_with_no_extension

policy-name

name

shares-to-exclude

scope.exclude_shares

shares-to-include

scope.include_shares

volumes-to-exclude

scope.exclude_volumes

volumes-to-include

scope.include_volumes

vserver

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-policy-scope-modify

PATCH /api/protocols/fpolicy/{svm.uuid}/policies/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

check-extensions-on-directories

scope.check-extensions-on-directories

export-policies-to-exclude

scope.exclude_export_policies

export-policies-to-include

scope.include_export_policies

file-extensions-to-exclude

scope.exclude_extension

file-extensions-to-include

scope.include_extension

is-monitoring-of-objects-with-no-extension-enabled

scope.object_monitoring_with_no_extension

policy-name

name

shares-to-exclude

scope.exclude_shares

shares-to-include

scope.include_shares

volumes-to-exclude

scope.exclude_volumes

volumes-to-include

scope.include_volumes

fpolicy-policy-status-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/policies/{name}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

policy-name

name

sequence-number

priority

status

enabled

vserver

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-server-connect

PATCH /api/protocols/fpolicy/{svm.uuid}/connections/{node.uuid}/{policy.name}/{server}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

node

node.uuid

policy-name

policy.name

server

server

fpolicy-server-disconnect

PATCH /api/protocols/fpolicy/{svm.uuid}/connections/{node.uuid}/{policy.name}/{server}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

node

node.uuid

policy-name

policy.name

server

server

fpolicy-server-status-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/connections

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

connected-since

update_time

disconnect-reason

disconnected_reason.message

disconnected-since

update_time

fpolicy-server

server

node

node.name

policy-name

policy

server-status

state

server-type

type

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.