file-directory-security

Contributors

file-directory-effective-permissions-get

GET /api/protocols/file-security/effective-permissions/{svm.uuid}/{path}

Note: This API is private as it is only supported by System Manager.

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

ONTAPI attribute REST attribute Comment

client-ip-address

No REST Equivalent

expand-mask

No REST Equivalent

path

path

share-name

share.name

unix-user-name

user

In the REST API, specify the "type" field as UNIX.

win-user-name

user

In the REST API, specify the "type" field as Windows.

file-directory-security-get

GET /api/protocols/file-security/permissions/{svm.uuid}/{path}

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

ONTAPI attribute REST attribute Comment

cifs-share-name

No REST Equivalent

expand-mask

No REST Equivalent

inode

inode

lookup-names

No REST Equivalent

path

path

sddl

No REST Equivalent

textual-mask

advanced-rights

volume-name

No REST Equivalent

file-directory-security-ntfs-create

POST /api/protocols/file-security/permissions/{svm.uuid}/{path}

Note: This ONTAPI is deprecated in REST with simplified REST interface. NTFS-SD is created automatically based on the values provided for the NTFS-SD specific attributes. Hence this ONTAPI does not have a separate REST API.

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

ONTAPI attribute REST attribute Comment

control-flags-raw

control-flags

group

group

ntfs-sd

No REST Equivalent

owner

owner

return-record

No REST Equivalent

file-directory-security-ntfs-dacl-add

POST /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl

Note: Give "access" field as access_allow or access_deny to indicate DACL addition

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

ONTAPI attribute REST attribute Comment

access-type

access

account

user

advanced-rights

advanced-rights

apply-to

apply-to

ntfs-sd

No REST Equivalent

rights

rights

rights-raw

No REST Equivalent

file-directory-security-ntfs-dacl-get-iter

GET /api/protocols/file-security/permissions/{svm.uuid}/{path}

Note: REST API "/protocols/file-security/permissions/{svm.uuid}/{path}" can be used to display all DACL ACEs. Hence this ONTAPI will not have separate REST API.

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

ONTAPI attribute REST attribute Comment

access-type

access

account

user

advanced-rights

advanced-rights

apply-to

apply-to

ntfs-sd

No REST Equivalent

readable-access-rights

No REST Equivalent

rights

No REST Equivalent

rights-raw

No REST Equivalent

vserver

No REST Equivalent

max-records

No REST Equivalent

Specifies the maximum number of records to return before paging.

file-directory-security-ntfs-dacl-modify

PATCH /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl/{user}

Note: Give "access" field as access_allow or access_deny to indicate DACL modification

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

ONTAPI attribute REST attribute Comment

access-type

access

account

user

advanced-rights

advanced-rights

apply-to

apply-to

ntfs-sd

No REST Equivalent

rights

rights

rights-raw

No REST Equivalent

file-directory-security-ntfs-dacl-remove

DELETE /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl/{user}

Note: Give "access" field as access_allow or access_deny to indicate DACL removal

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

ONTAPI attribute REST attribute Comment

access-type

access

account

user

ntfs-sd

No REST Equivalent

file-directory-security-ntfs-delete

Note: Since there is no requirement to create NTFS-SDs explicitly while configuring ACEs through REST, internally created NTFS-SDs are removed automatically during the cleanup process when a job finishes. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-ntfs-get-iter

Note: NTFS-SDs are created automatically for configuring ACEs through REST. These internally created NTFS-SDs are not visible to users. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-ntfs-modify

PATCH /api/protocols/file-security/permissions/{svm.uuid}/{path}

Note: This ONTAPI is deprecated in REST with simplified REST interface. SD specific information is modified automatically based on the values provided for the NTFS-SD specific attributes. Hence this ONTAPI does not have a separate REST API.

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

ONTAPI attribute REST attribute Comment

control-flags-raw

control-flags

group

group

ntfs-sd

No REST Equivalent

owner

owner

file-directory-security-ntfs-sacl-add

POST /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl

Note: Give "access" field as audit_success or audit_falure to indicate SACL addition

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

ONTAPI attribute REST attribute Comment

account

user

advanced-rights

advanced-rights

apply-to

apply-to

audit-access-type

access

ntfs-sd

No REST Equivalent

rights

rights

rights-raw

No REST Equivalent

file-directory-security-ntfs-sacl-get-iter

GET /api/protocols/file-security/permissions/{svm.uuid}/{path}

Note: REST API "/protocols/file-security/permissions/{svm.uuid}/{path}" can be used to display all SACL ACEs. Hence this ONTAPI does not have a separate REST API.

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

ONTAPI attribute REST attribute Comment

account

user

advanced-rights

advanced-rights

apply-to

apply-to

audit-access-type

access

ntfs-sd

No REST Equivalent

readable-access-rights

No REST Equivalent

rights

No REST Equivalent

rights-raw

No REST Equivalent

vserver

No REST Equivalent

max-records

No REST Equivalent

Specifies the maximum number of records to return before paging.

file-directory-security-ntfs-sacl-modify

PATCH /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl/{user}

Note: Give "access" field as audit_success or audit_falure to indicate SACL Modification

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

ONTAPI attribute REST attribute Comment

account

user

advanced-rights

advanced-rights

apply-to

apply-to

audit-access-type

access

ntfs-sd

No REST Equivalent

rights

rights

rights-raw

No REST Equivalent

file-directory-security-ntfs-sacl-remove

DELETE /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl/{user}

Note: Give "access" field as audit_success or audit_falure to indicate SACL removal

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

ONTAPI attribute REST attribute Comment

account

user

audit-access-type

access

ntfs-sd

No REST Equivalent

file-directory-security-policy-create

Note: A policy is created automatically for configuring ACEs through REST. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-policy-delete

Note: Since there is no requirement to create a policy explicitly while configuring ACEs through REST, an internally created policy is removed automatically during the cleanup process when a job finishes. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-policy-get-iter

Note: A policy is created automatically for configuring ACEs through REST. These internally created policies are not visible to users. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-policy-task-add

POST /api/protocols/file-security/permissions/{svm.uuid}/{path}

Note: This ONTAPI is deprecated in REST with simplified REST interface. Policy-task creation happens automatically based on the values provided for the task specific attributes. Hence this ONTAPI does not have a separate REST API.

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

ONTAPI attribute REST attribute Comment

access-control

access_control

ntfs-mode

propagation_mode

ntfs-sd

No REST Equivalent

This field is automatically populated.

path

path

policy-name

No REST Equivalent

This field is automatically populated.

security-type

No REST Equivalent

Only the "ntfs" security type is supported in ONTAP CLI.

task-index-number

No REST Equivalent

Since tasks are created automatically, this field is not required.

file-directory-security-policy-task-get-iter

Note: Policy-tasks are created automatically for configuring ACEs through REST. These internally created tasks are not visible to users. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-policy-task-modify

Note: Since there is no requirement to create policy-tasks explicitly while configuring ACEs through REST, modification of internally created tasks is not required. Hence this ONTAPI dos not have a corresponding REST API.

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

file-directory-security-policy-task-remove

Note: Since there is no requirement to create policy-tasks explicitly while configuring ACEs through REST, internally created tasks are removed automatically during the cleanup process when a job finishes. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-remove-slag

DELETE /api/protocols/file-security/permissions/{svm.uuid}/{path}

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

ONTAPI attribute REST attribute Comment

path

path

file-directory-security-set

Note: An internally created policy is applied automatically during the execution of a REST call, which sets all the ACEs for the specified path. Hence this ONTAPI does not have a corresponding REST API.

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