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

cifs

Contributors
Suggest changes

cifs-branchcache-create

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

cifs-branchcache-flush

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

cifs-branchcache-get

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

cifs-branchcache-get-iter

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

cifs-branchcache-hash

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

cifs-branchcache-modify

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

cifs-branchcache-remove

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

cifs-cache-settings-get

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

cifs-cache-settings-modify

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

cifs-character-mapping-create

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

cifs-character-mapping-destroy

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

cifs-character-mapping-get-iter

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

cifs-character-mapping-modify

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

cifs-check-server-get-iter

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

cifs-connection-get-iter

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

cifs-domain-discovered-servers-get-iter

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

cifs-domain-discovered-servers-reset

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

cifs-domain-name-mapping-search-add

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

cifs-domain-name-mapping-search-get-iter

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

cifs-domain-name-mapping-search-modify

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

cifs-domain-name-mapping-search-remove

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

cifs-domain-password-schedule-get-iter

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

cifs-domain-password-schedule-modify

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

cifs-domain-preferred-dc-add

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

cifs-domain-preferred-dc-get-iter

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

cifs-domain-preferred-dc-remove

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

cifs-domain-server-discovery-mode-get

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

cifs-domain-server-discovery-mode-get-iter

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

cifs-domain-server-discovery-mode-modify

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

cifs-domain-trusts-get-iter

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

cifs-domain-trusts-rediscover

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

cifs-foo-get-iter

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

cifs-home-directory-get-iter

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

cifs-home-directory-modify

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

cifs-home-directory-search-path-add

POST /api/protocols/cifs/home-directory/search-paths

ONTAPI attribute REST attribute Comment

path

path

cifs-home-directory-search-path-delete

DELETE /api/protocols/cifs/home-directory/search-paths/{svm.uuid}/{index}

Note: index is needed to delete the search-path

ONTAPI attribute REST attribute Comment

path

No REST Equivalent

cifs-home-directory-search-path-get-iter

GET /api/protocols/cifs/home-directory/search-paths/{svm.uuid}/{index}

ONTAPI attribute REST attribute Comment

path

path

position

index

vserver

svm.name

max-records

max_records

The maximum number of records to return before paging

cifs-home-directory-search-path-remove

DELETE /api/protocols/cifs/home-directory/search-paths/{svm.uuid}/{index}

Note: index is needed to remove home directory search path

ONTAPI attribute REST attribute Comment

path

No REST Equivalent

cifs-home-directory-search-path-reorder

PATCH /api/protocols/cifs/home-directory/search-paths/{svm.uuid}/{index}

ONTAPI attribute REST attribute Comment

path

No REST Equivalent

to-position

new_index

cifs-local-group-create

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

cifs-local-group-delete

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

cifs-local-group-get-iter

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

cifs-local-group-members-add-members

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

cifs-local-group-members-get-iter

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

cifs-local-group-members-remove-members

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

cifs-local-group-modify

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

cifs-local-group-rename

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

cifs-local-user-create

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

cifs-local-user-delete

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

cifs-local-user-get-iter

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

cifs-local-user-membership-get-iter

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

cifs-local-user-modify

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

cifs-local-user-rename

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

cifs-local-user-set-password

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

cifs-nbtstat-get-iter

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

cifs-options-get-iter

GET /api/protocols/cifs/services

ONTAPI attribute REST attribute Comment

client-session-timeout

No REST Equivalent

default-unix-group

No REST Equivalent

default-unix-user

default_unix_user

file-system-sector-size

No REST Equivalent

grant-unix-group-perms-to-others

No REST Equivalent

guest-unix-user

No REST Equivalent

is-admin-users-mapped-to-root-enabled

No REST Equivalent

is-advanced-sparse-file-support-enabled

No REST Equivalent

is-advertise-dfs-enabled

No REST Equivalent

is-client-dup-detection-enabled

No REST Equivalent

is-client-version-reporting-enabled

No REST Equivalent

is-copy-offload-direct-copy-enabled

No REST Equivalent

is-copy-offload-enabled

No REST Equivalent

is-dac-enabled

No REST Equivalent

is-exportpolicy-enabled

No REST Equivalent

is-fake-open-enabled

No REST Equivalent

is-fsctl-file-level-trim-enabled

No REST Equivalent

is-hide-dotfiles-enabled

No REST Equivalent

is-inherit-modebits-with-nfsv4acl-enabled

No REST Equivalent

is-large-mtu-enabled

No REST Equivalent

is-local-auth-enabled

No REST Equivalent

is-local-users-and-groups-enabled

No REST Equivalent

is-multichannel-enabled

No REST Equivalent

is-nbns-enabled

No REST Equivalent

is-netbios-over-tcp-enabled

No REST Equivalent

is-path-component-cache-enabled

No REST Equivalent

is-path-component-cache-symlink-enabled

No REST Equivalent

is-read-only-delete-enabled

No REST Equivalent

is-referral-enabled

No REST Equivalent

is-search-short-names-enabled

No REST Equivalent

is-shadowcopy-enabled

No REST Equivalent

is-smb1-enabled

No REST Equivalent

is-smb2-enabled

No REST Equivalent

is-smb3-enabled

No REST Equivalent

is-smb31-enabled

No REST Equivalent

is-trusted-domain-enum-search-enabled

No REST Equivalent

is-unix-extensions-enabled

No REST Equivalent

is-unix-nt-acl-enabled

No REST Equivalent

is-use-junctions-as-reparse-points-enabled

No REST Equivalent

map-sid-to-uid-on-set-owner

No REST Equivalent

max-connections-per-session

No REST Equivalent

max-credits

No REST Equivalent

max-file-write-zero-length

No REST Equivalent

max-lifs-per-session

No REST Equivalent

max-mpx

No REST Equivalent

max-opens-same-file-per-tree

No REST Equivalent

max-same-tree-connect-per-session

No REST Equivalent

max-same-user-sessions-per-connection

No REST Equivalent

max-watches-set-per-tree

No REST Equivalent

path-component-cache-entry-exp-time

No REST Equivalent

path-component-cache-max-entries

No REST Equivalent

path-component-cache-max-session-token-size

No REST Equivalent

path-component-cache-symlink-exp-time

No REST Equivalent

read-grants-execute

No REST Equivalent

restrict-anonymous

security.restrict_anonymous

shadowcopy-dir-depth

No REST Equivalent

smb1-max-buffer-size

No REST Equivalent

vserver

svm.name

widelink-as-reparse-point-versions

No REST Equivalent

win-name-for-null-user

No REST Equivalent

wins-servers

netbios.wins_servers

max-records

max_records

The maximum number of records to return before paging

cifs-options-modify

PATCH /api/protocols/cifs/services/{svm.uuid}

ONTAPI attribute REST attribute Comment

client-session-timeout

No REST Equivalent

default-unix-group

No REST Equivalent

default-unix-user

default_unix_user

file-system-sector-size

No REST Equivalent

grant-unix-group-perms-to-others

No REST Equivalent

guest-unix-user

No REST Equivalent

is-admin-users-mapped-to-root-enabled

No REST Equivalent

is-advanced-sparse-file-support-enabled

No REST Equivalent

is-advertise-dfs-enabled

No REST Equivalent

is-client-dup-detection-enabled

No REST Equivalent

is-client-version-reporting-enabled

No REST Equivalent

is-copy-offload-direct-copy-enabled

No REST Equivalent

is-copy-offload-enabled

No REST Equivalent

is-dac-enabled

No REST Equivalent

is-exportpolicy-enabled

No REST Equivalent

is-fake-open-enabled

No REST Equivalent

is-fsctl-file-level-trim-enabled

No REST Equivalent

is-hide-dotfiles-enabled

No REST Equivalent

is-inherit-modebits-with-nfsv4acl-enabled

No REST Equivalent

is-large-mtu-enabled

No REST Equivalent

is-local-auth-enabled

No REST Equivalent

is-local-users-and-groups-enabled

No REST Equivalent

is-multichannel-enabled

No REST Equivalent

is-nbns-enabled

No REST Equivalent

is-netbios-over-tcp-enabled

No REST Equivalent

is-path-component-cache-enabled

No REST Equivalent

is-path-component-cache-symlink-enabled

No REST Equivalent

is-read-only-delete-enabled

No REST Equivalent

is-referral-enabled

No REST Equivalent

is-search-short-names-enabled

No REST Equivalent

is-shadowcopy-enabled

No REST Equivalent

is-smb1-enabled

No REST Equivalent

is-smb2-enabled

No REST Equivalent

is-smb3-enabled

No REST Equivalent

is-smb31-enabled

No REST Equivalent

is-trusted-domain-enum-search-enabled

No REST Equivalent

is-unix-extensions-enabled

No REST Equivalent

is-unix-nt-acl-enabled

No REST Equivalent

is-use-junctions-as-reparse-points-enabled

No REST Equivalent

map-sid-to-uid-on-set-owner

No REST Equivalent

max-connections-per-session

No REST Equivalent

max-credits

No REST Equivalent

max-file-write-zero-length

No REST Equivalent

max-lifs-per-session

No REST Equivalent

max-mpx

No REST Equivalent

max-opens-same-file-per-tree

No REST Equivalent

max-same-tree-connect-per-session

No REST Equivalent

max-same-user-sessions-per-connection

No REST Equivalent

max-watches-set-per-tree

No REST Equivalent

path-component-cache-entry-exp-time

No REST Equivalent

path-component-cache-max-entries

No REST Equivalent

path-component-cache-max-session-token-size

No REST Equivalent

path-component-cache-symlink-exp-time

No REST Equivalent

read-grants-execute

No REST Equivalent

restrict-anonymous

security.restrict_anonymous

shadowcopy-dir-depth

No REST Equivalent

smb1-max-buffer-size

No REST Equivalent

widelink-as-reparse-point-versions

No REST Equivalent

win-name-for-null-user

No REST Equivalent

wins-servers

netbios.wins_servers

cifs-password-change

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

cifs-password-reset

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

cifs-preferred-dc-check-get-iter

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

cifs-privilege-add-privilege

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

cifs-privilege-get-iter

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

cifs-privilege-remove-privilege

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

cifs-privilege-reset-privilege

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

cifs-security-get-iter

GET /api/protocols/cifs/services

ONTAPI attribute REST attribute Comment

encryption-required-for-dc-connections

security.encrypt_dc_connection

is-aes-encryption-enabled

security.kdc_encryption

is-password-complexity-required

No REST Equivalent

is-signing-required

security.smb_signing

is-smb-encryption-required

security.smb_encryption

kerberos-clock-skew

No REST Equivalent

kerberos-kdc-timeout

No REST Equivalent

kerberos-renew-age

No REST Equivalent

kerberos-ticket-age

No REST Equivalent

lm-compatibility-level

security.lm_compatibility_level

referral-enabled-for-ad-ldap

No REST Equivalent

session-security-for-ad-ldap

No REST Equivalent

smb1-enabled-for-dc-connections

No REST Equivalent

smb2-enabled-for-dc-connections

No REST Equivalent

use-ldaps-for-ad-ldap

No REST Equivalent

use-start-tls-for-ad-ldap

No REST Equivalent

vserver

svm.name

max-records

max_records

The maximum number of records to return before paging

cifs-security-modify

PATCH /api/protocols/cifs/services/{svm.uuid}

ONTAPI attribute REST attribute Comment

admin-password

No REST Equivalent

admin-username

No REST Equivalent

encryption-required-for-dc-connections

security.encrypt_dc_connection

is-aes-encryption-enabled

security.kdc_encryption

is-password-complexity-required

No REST Equivalent

is-signing-required

security.smb_signing

is-smb-encryption-required

security.smb_encryption

kerberos-clock-skew

No REST Equivalent

kerberos-kdc-timeout

No REST Equivalent

kerberos-renew-age

No REST Equivalent

kerberos-ticket-age

No REST Equivalent

lm-compatibility-level

No REST Equivalent

referral-enabled-for-ad-ldap

No REST Equivalent

session-security-for-ad-ldap

No REST Equivalent

smb1-enabled-for-dc-connections

No REST Equivalent

smb2-enabled-for-dc-connections

No REST Equivalent

use-ldaps-for-ad-ldap

No REST Equivalent

use-start-tls-for-ad-ldap

No REST Equivalent

cifs-server-add-netbios-aliases

PATCH /api/protocols/cifs/services/{svm.uuid}

ONTAPI attribute REST attribute Comment

netbios-aliases

netbios.aliases

cifs-server-create

POST /api/protocols/cifs/services

ONTAPI attribute REST attribute Comment

admin-password

ad_domain.password

admin-username

ad_domain.user

administrative-status

enabled

cifs-server

name

comment

comment

default-site

No REST Equivalent

domain

ad_domain.fqdn

force-account-overwrite

No REST Equivalent

keytab-uri

No REST Equivalent

netbios-aliases

netbios.aliases

organizational-unit

ad_domain.organizational_unit

realm

No REST Equivalent

workgroup

No REST Equivalent

cifs-server-delete

DELETE /api/protocols/cifs/services/{svm.uuid}

ONTAPI attribute REST attribute Comment

admin-password

ad_domain.password

admin-username

ad_domain.user

force-account-delete

No REST Equivalent

keytab-uri

No REST Equivalent

cifs-server-get-iter

GET /api/protocols/cifs/services/{svm.uuid}

ONTAPI attribute REST attribute Comment

administrative-status

enabled

auth-style

No REST Equivalent

cifs-server

name

comment

comment

default-site

No REST Equivalent

domain

ad_domain.fqdn

domain-workgroup

No REST Equivalent

netbios-aliases

netbios.aliases

organizational-unit

ad_domain.organizational_unit

realm

No REST Equivalent

vserver

svm.name

workgroup

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

cifs-server-modify

PATCH /api/protocols/cifs/services/{svm.uuid}

ONTAPI attribute REST attribute Comment

admin-password

ad_domain.password

admin-username

ad_domain.user

administrative-status

No REST Equivalent

cifs-server

name

comment

comment

default-site

No REST Equivalent

domain

ad_domain.fqdn

force-account-overwrite

No REST Equivalent

keytab-uri

No REST Equivalent

ou

ad_domain.organizational_unit

workgroup

No REST Equivalent

cifs-server-remove-netbios-aliases

PATCH /api/protocols/cifs/services/{svm.uuid}

ONTAPI attribute REST attribute Comment

netbios-aliases

netbios.aliases

cifs-server-repair-modify

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

cifs-server-start

PATCH /api/protocols/cifs/services/{svm.uuid}

Note: "enabled" field should be set to perform the operation

There are no attributes defined for this ONTAPI call.

cifs-server-stop

PATCH /api/protocols/cifs/services/{svm.uuid}

Note: "enabled" field should be set to perform the operation

There are no attributes defined for this ONTAPI call.

cifs-session-close

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

cifs-session-file-close

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

cifs-session-file-get-iter

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

cifs-session-get-iter

GET /api/protocols/cifs/sessions

ONTAPI attribute REST attribute Comment

address

client_ip

auth-mechanism

authentication

connected-time

connected_duration

connection-count

connection_count

connection-id

connection_id

continuously-available

continuous_availability

files

open_files

idle-time

idle_duration

is-large-mtu-enabled

large_mtu

is-session-signed

smb_signing

lif-address

server_ip

netbios-name

No REST Equivalent

node

node.name

other

open_other

protocol-version

protocol

session-id

identifier

shares

open_shares

smb-encryption-status

smb_encryption

unix-user

mapped_unix_user

user-type

No REST Equivalent

vserver

svm.name

win-unix-creds

No REST Equivalent

windows-user

user

max-records

max_records

The maximum number of records to return before paging

cifs-shadowcopy-add-files

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

cifs-shadowcopy-ems-get-iter

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

cifs-shadowcopy-keep-snapshot

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

cifs-shadowcopy-restore-dir

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

cifs-share-access-control-create

POST /api/protocols/cifs/shares/{svm.uuid}/{share}/acls

ONTAPI attribute REST attribute Comment

permission

permission

return-record

return_records

share

share

user-group-type

type

user-or-group

user_or_group

winsid

No REST Equivalent

cifs-share-access-control-delete

DELETE /api/protocols/cifs/shares/{svm.uuid}/{share}/acls/{user_or_group}/{type}

ONTAPI attribute REST attribute Comment

share

share

user-group-type

type

user-or-group

user_or_group

cifs-share-access-control-get-iter

GET /api/protocols/cifs/shares/{svm.uuid}/{share}/acls

ONTAPI attribute REST attribute Comment

permission

permission

share

share

user-group-type

type

user-or-group

user_or_group

vserver

No REST Equivalent

winsid

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

cifs-share-access-control-modify

PATCH /api/protocols/cifs/shares/{svm.uuid}/{share}/acls/{user_or_group}/{type}

ONTAPI attribute REST attribute Comment

permission

permission

share

share

user-group-type

type

user-or-group

user_or_group

winsid

No REST Equivalent

cifs-share-create

POST /api/protocols/cifs/shares

ONTAPI attribute REST attribute Comment

attribute-cache-ttl

No REST Equivalent

comment

comment

dir-umask

No REST Equivalent

file-umask

No REST Equivalent

force-group-for-create

No REST Equivalent

is-path-validation-enabled

No REST Equivalent

max-connections-per-share

No REST Equivalent

offline-files-mode

No REST Equivalent

path

path

return-record

No REST Equivalent

share-name

name

share-properties

No REST Equivalent

Share-proerties are separate fields in REST. This functionality can be achieved by setting the fields "access_based_enumeration", "change_notify", "encryption", "home_directory", "oplocks"

symlink-properties

unix_symlink

vscan-fileop-profile

No REST Equivalent

cifs-share-delete

DELETE /api/protocols/cifs/shares/{svm.uuid}/{name}

ONTAPI attribute REST attribute Comment

share-name

name

cifs-share-get-iter

GET /api/protocols/cifs/shares

ONTAPI attribute REST attribute Comment

acl

acls

attribute-cache-ttl

No REST Equivalent

cifs-server

No REST Equivalent

comment

comment

dir-umask

No REST Equivalent

file-umask

No REST Equivalent

force-group-for-create

No REST Equivalent

max-connections-per-share

No REST Equivalent

offline-files-mode

No REST Equivalent

path

path

share-name

name

share-properties

No REST Equivalent

symlink-properties

unix_symlink

volume

volume.name

vscan-fileop-profile

No REST Equivalent

vserver

svm.name

max-records

max_records

The maximum number of records to return before paging

cifs-share-modify

PATCH /api/protocols/cifs/shares/{svm.uuid}/{name}

ONTAPI attribute REST attribute Comment

attribute-cache-ttl

No REST Equivalent

comment

comment

dir-umask

No REST Equivalent

file-umask

No REST Equivalent

force-group-for-create

No REST Equivalent

is-path-validation-enabled

No REST Equivalent

max-connections-per-share

No REST Equivalent

offline-files-mode

No REST Equivalent

path

path

share-name

name

share-properties

No REST Equivalent

Share-proerties are separate fields in REST. This functionality can be achieved by setting the fields "access_based_enumeration", "change_notify", "encryption", "home_directory", "oplocks"

symlink-properties

unix_symlink

vscan-fileop-profile

No REST Equivalent

POST /api/protocols/cifs/unix-symlink-mapping

ONTAPI attribute REST attribute Comment

cifs-path

target.path

cifs-server

target.server

home-directory

target.home_directory

locality

target.locality

return-record

No REST Equivalent

share-name

target.share

unix-path

target.path

DELETE /api/protocols/cifs/unix-symlink-mapping/{svm.uuid}/{unix_path}

ONTAPI attribute REST attribute Comment

unix-path

unix_path

GET /api/protocols/cifs/unix-symlink-mapping

ONTAPI attribute REST attribute Comment

cifs-path

target.path

cifs-server

target.server

home-directory

target.home_directory

locality

target.locality

share-name

target.share

unix-path

unix_path

vserver

svm.name

max-records

max_records

The maximum number of records to return before paging

PATCH /api/protocols/cifs/unix-symlink-mapping/{svm.uuid}/{unix_path}

ONTAPI attribute REST attribute Comment

cifs-path

target.path

cifs-server

target.server

home-directory

target.home_directory

locality

target.locality

share-name

target.share

unix-path

unix_path

cifs-user-home-directory-path-get

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

cifs-user-home-directory-path-get-iter

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

cifs-users-and-group-local-group-members-get-iter

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

cifs-users-and-group-local-user-membership-get-iter

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

cifs-users-and-groups-delete-cifs-lug

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

cifs-users-and-groups-get-import-status

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

cifs-users-and-groups-load-from-uri

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

volume-charmap-get

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

volume-charmap-set

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

cifs-stop-on-target

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

cifs-start-on-target

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