cifs

Contributors

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

GET /api/protocols/cifs/connections

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

ONTAPI attribute REST attribute Comment

connection-id

identifier

lif-ip

server_ip

network-context-id

network_context_id

node

node.name

session-id

sessions.identifier

vserver

svm.name

workstation-ip

client_ip

workstation-port

client_port

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-domain-discovered-servers-get-iter

GET /api/protocols/cifs/domains

Note: CIFS domains endpoint returns name mapping, trusted relationships, preferred domain controllers, discovered servers, and password schedule information. You can also retrieve the same information for a specific SVM based on its SVM UUID.

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

ONTAPI attribute REST attribute Comment

address

server_ip

dc-functional-level

No REST Equivalent

domain

domain

is-dc-read-only

No REST Equivalent

name

server_name

node

node

prefer-type

preference

server-type

server_type

status

state

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-domain-discovered-servers-reset

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

Note: Merged with CIFS domains GET endpoint. It triggers asynchronous rediscovery of servers and returns current CIFS domains information.

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

ONTAPI attribute REST attribute Comment

No REST Equivalent

reset_discovered_servers

"reset_discovered_servers" query parameter value needs to be passed as true for servers rediscovery. The default value is false.

cifs-domain-name-mapping-search-add

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

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

GET /api/protocols/cifs/domains

Note: CIFS domains endpoint returns name mapping, trusted relationships, preferred domain controllers, discovered servers, and password schedule information. You can also retrieve the same information for a specific SVM based on its SVM UUID.

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

ONTAPI attribute REST attribute Comment

trusted-domains

trusted_domains

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

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

GET /api/protocols/cifs/domains

Note: CIFS domains endpoint returns name mapping, trusted relationships, preferred domain controllers, discovered servers, and password schedule information. You can also retrieve the same information for a specific SVM based on its SVM UUID.

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

ONTAPI attribute REST attribute Comment

is-schedule-enabled

schedule_enabled

schedule-day-of-week

No REST Equivalent

schedule-randomized-minute

schedule_randomized_minute

schedule-time-of-day

No REST Equivalent

schedule-weekly-interval

schedule_weekly_interval

schedule-last-changed

schedule_last_changed_time

schedule-description

schedule_description

schedule-warn-msg

schedule_warn_message

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-domain-password-schedule-modify

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

cifs-domain-preferred-dc-add

POST /api/protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers

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

ONTAPI attribute REST attribute Comment

domain

fqdn

preferred-dc

server_ip

In ZAPI, preferred-dc is a list of IP addresses. In REST APIs, a single IP address input is taken, not a list of IP addresses. In case mulitiple IPs are to be added to a given vserver and domain bulk POST is also supported.

vserver

svm.uuid

skip-config-validation

skip_config_validation

cifs-domain-preferred-dc-get-iter

GET /api/protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers

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

ONTAPI attribute REST attribute Comment

domain

fqdn

preferred-dc

server_ip

In ZAPI, preferred-dc is a list of IP addresses. In REST APIs, a single IP address input is taken, not a list of IP addresses.

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-domain-preferred-dc-remove

DELETE /api/protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers/{fqdn}/{server_ip}

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

ONTAPI attribute REST attribute Comment

domain

fqdn

preferred-dc

server_ip

In ZAPI, preferred-dc is a list of IP addresses. In REST API, a single IP address input is taken, not a list of IP addresses. In case mulitiple IPs are to be removed from a given domain or vserver query based bulk DELETE is also supported.

vserver

svm.uuid

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

GET /api/protocols/cifs/domains

Note: CIFS domains endpoint returns name mapping, trusted relationships, preferred domain controllers, discovered servers, and password schedule information. You can also retrieve the same information for a specific SVM based on its SVM UUID.

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

ONTAPI attribute REST attribute Comment

home-domain

home_domain

node

node

trusted-domain

trusted_domains

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-domain-trusts-rediscover

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

Note: Merged with the CIFS domains GET endpoint. It triggers asynchronous trusted servers rediscovery and returns current CIFS domains information.

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

ONTAPI attribute REST attribute Comment

No REST Equivalent

rediscover_trusts

"rediscover_trusts" query parameter value needs to be passed as true for trusts rediscovery. The default value is false.

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

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

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: In the REST API, you need the index to delete the home directory search-path.

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

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}

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

ONTAPI attribute REST attribute Comment

path

path

position

index

vserver

svm.name

max-records

max_records

Specifies 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: In the REST API, you need the index to remove the home directory search-path.

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

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}

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

ONTAPI attribute REST attribute Comment

path

No REST Equivalent

to-position

new_index

cifs-local-group-create

POST /api/protocols/cifs/local-groups

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

ONTAPI attribute REST attribute Comment

description

description

group-name

name

return-record

return_records

cifs-local-group-delete

DELETE /api/protocols/cifs/local-groups/{svm.uuid}/{sid}

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

ONTAPI attribute REST attribute Comment

group-name

No REST Equivalent

The local group is identified using the SID attribute. This field is not required in REST API.

cifs-local-group-get-iter

GET /api/protocols/cifs/local-groups

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

ONTAPI attribute REST attribute Comment

description

description

group-name

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-local-group-members-add-members

POST /api/protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members

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

ONTAPI attribute REST attribute Comment

group-name

No REST Equivalent

The local group is identified using the SID attribute. This field is not required in REST API.

member-names

records

The name parameter is used to add a single member while records parameter is used to add multiple members.

cifs-local-group-members-get-iter

GET /api/protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members

Note: The local group members can also be retrieved using REST API: /api/protocols/cifs/local-groups.

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

ONTAPI attribute REST attribute Comment

group-name

No REST Equivalent

The local group is identified using the SID attribute. This field is not required in REST API.

member

records.name

This is an advanced privilege field in REST API: /api/protocols/cifs/local-groups.

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-local-group-members-remove-members

DELETE /api/protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members

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

ONTAPI attribute REST attribute Comment

group-name

No REST Equivalent

The local group is identified using the SID attribute. This field is not required in REST API.

member-names

records

The name parameter is used to delete a single member while records parameter is used to delete multiple members.

cifs-local-group-modify

PATCH /api/protocols/cifs/local-groups/{svm.uuid}/{sid}

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

ONTAPI attribute REST attribute Comment

description

description

group-name

No REST Equivalent

The local group is identified using the SID attribute. This field is not required in REST API.

cifs-local-group-rename

PATCH /api/protocols/cifs/local-groups/{svm.uuid}/{sid}

Note: This API is merged with cifs-local-group-modify in REST API.

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

ONTAPI attribute REST attribute Comment

group-name

No REST Equivalent

The local group is identified using the SID attribute. This field is not required in REST API.

new-group-name

name

cifs-local-user-create

POST /api/protocols/cifs/local-users

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

ONTAPI attribute REST attribute Comment

description

description

full-name

full_name

is-account-disabled

account_disabled

user-name

name

user-password

password

cifs-local-user-delete

DELETE /api/protocols/cifs/local-users/{svm.uuid}/{sid}

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

ONTAPI attribute REST attribute Comment

user-name

No REST Equivalent

The local user is identified using the SID attribute. This field is not required in REST API.

cifs-local-user-get-iter

GET /api/protocols/cifs/local-users

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

ONTAPI attribute REST attribute Comment

description

description

full-name

full_name

is-account-disabled

account_disabled

user-name

name

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-local-user-membership-get-iter

GET /api/protocols/cifs/local-users

Note: This API is merged with cifs-local-user-get-iter in REST API.

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

ONTAPI attribute REST attribute Comment

membership

membership

This is an advanced privilege field in the REST API.

user-name

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-local-user-modify

PATCH /api/protocols/cifs/local-users/{svm.uuid}/{sid}

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

ONTAPI attribute REST attribute Comment

description

description

full-name

full_name

is-account-disabled

account_disabled

user-name

name

cifs-local-user-rename

PATCH /api/protocols/cifs/local-users/{svm.uuid}/{sid}

Note: This API is merged with cifs-local-user-modify in REST API.

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

ONTAPI attribute REST attribute Comment

new-user-name

name

user-name

No REST Equivalent

The local user is identified using the SID attribute. This field is not required in REST API.

cifs-local-user-set-password

PATCH /api/protocols/cifs/local-users/{svm.uuid}/{sid}

Note: This API is merged with cifs-local-user-modify in REST API.

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

ONTAPI attribute REST attribute Comment

user-name

No REST Equivalent

The local user is identified using the SID attribute. This field is not required in REST API.

user-password

password

cifs-nbtstat-get-iter

GET /api/protocols/cifs/netbios

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

ONTAPI attribute REST attribute Comment

nbt-mode

mode

nbt-name-state

state

nbt-scope

scope

netbios-name

name

netbios-suffix

suffix

node

node.name

registered-addresses

interfaces

registered-type

name_registration_type

registration-time-left-minutes

time_left

vserver

svm.name

wins-entries

wins_servers

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-options-get-iter

GET /api/protocols/cifs/services

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

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

admin_to_root_mapping

is-advanced-sparse-file-support-enabled

advanced_sparse_file

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

copy_offload

is-dac-enabled

No REST Equivalent

is-exportpolicy-enabled

No REST Equivalent

is-fake-open-enabled

fake_open

is-fsctl-file-level-trim-enabled

fsctl_trim

is-hide-dotfiles-enabled

No REST Equivalent

is-inherit-modebits-with-nfsv4acl-enabled

No REST Equivalent

is-large-mtu-enabled

large_mtu

is-local-auth-enabled

No REST Equivalent

is-local-users-and-groups-enabled

No REST Equivalent

is-multichannel-enabled

multichannel

is-nbns-enabled

No REST Equivalent

is-netbios-over-tcp-enabled

No REST Equivalent

is-path-component-cache-enabled

path_component_cache

is-path-component-cache-symlink-enabled

No REST Equivalent

is-read-only-delete-enabled

No REST Equivalent

is-referral-enabled

referral

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

junction_reparse

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

No REST Equivalent

max-connections-per-session

No REST Equivalent

max-credits

smb_credits

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

widelink_reparse_versions

win-name-for-null-user

null_user_windows_name

wins-servers

netbios.wins_servers

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-options-modify

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

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

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

admin_to_root_mapping

is-advanced-sparse-file-support-enabled

advanced_sparse_file

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

copy_offload

is-dac-enabled

No REST Equivalent

is-exportpolicy-enabled

No REST Equivalent

is-fake-open-enabled

fake_open

is-fsctl-file-level-trim-enabled

fsctl_trim

is-hide-dotfiles-enabled

No REST Equivalent

is-inherit-modebits-with-nfsv4acl-enabled

No REST Equivalent

is-large-mtu-enabled

large_mtu

is-local-auth-enabled

No REST Equivalent

is-local-users-and-groups-enabled

No REST Equivalent

is-multichannel-enabled

multichannel

is-nbns-enabled

No REST Equivalent

is-netbios-over-tcp-enabled

No REST Equivalent

is-path-component-cache-enabled

path_component_cache

is-path-component-cache-symlink-enabled

No REST Equivalent

is-read-only-delete-enabled

No REST Equivalent

is-referral-enabled

referral

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

junction_reparse

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

No REST Equivalent

max-connections-per-session

No REST Equivalent

max-credits

smb_credits

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

widelink_reparse_versions

win-name-for-null-user

null_user_windows_name

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

POST /api/protocols/cifs/users-and-groups/privileges

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

ONTAPI attribute REST attribute Comment

privileges

privileges

user-or-group-name

name

cifs-privilege-get-iter

GET /api/protocols/cifs/users-and-groups/privileges

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

ONTAPI attribute REST attribute Comment

privileges

privileges

user-or-group-name

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-privilege-remove-privilege

PATCH /api/protocols/cifs/users-and-groups/privileges/{svm.uuid}/{name}

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

ONTAPI attribute REST attribute Comment

privileges

privileges

Specified privileges will replace all the existing privileges associated with the user or group.

user-or-group-name

name

cifs-privilege-reset-privilege

PATCH /api/protocols/cifs/users-and-groups/privileges/{svm.uuid}/{name}

Note: To reset privileges associated with the user or group, specify the privileges list as empty in REST.

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

ONTAPI attribute REST attribute Comment

user-or-group-name

name

cifs-security-get-iter

GET /api/protocols/cifs/services

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

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

security.ldap_referral_enabled

session-security-for-ad-ldap

session_security

smb1-enabled-for-dc-connections

No REST Equivalent

smb2-enabled-for-dc-connections

No REST Equivalent

use-ldaps-for-ad-ldap

use_ldaps

use-start-tls-for-ad-ldap

use_start_tls

aes_enabled_for_netlogon_channel

security.aes_netlogon_enabled

try_channel_binding_for_ad_ldap

security.try_ldap_channel_binding

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-security-modify

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

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

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

security.ldap_referral_enabled

session-security-for-ad-ldap

session_security

smb1-enabled-for-dc-connections

No REST Equivalent

smb2-enabled-for-dc-connections

No REST Equivalent

use-ldaps-for-ad-ldap

use_ldaps

use-start-tls-for-ad-ldap

use_start_tls

aes_enabled_for_netlogon_channel

security.aes_netlogon_enabled

try_channel_binding_for_ad_ldap

security.try_ldap_channel_binding

cifs-server-add-netbios-aliases

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

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

ONTAPI attribute REST attribute Comment

netbios-aliases

netbios.aliases

cifs-server-create

POST /api/protocols/cifs/services

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

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

force

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}

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

ONTAPI attribute REST attribute Comment

admin-password

ad_domain.password

admin-username

ad_domain.user

force-account-delete

force

keytab-uri

No REST Equivalent

cifs-server-get-iter

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

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

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

Specifies the maximum number of records to return before paging.

cifs-server-modify

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

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

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

force

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}

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

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: Set the "enabled" field to perform the operation.

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

There are no attributes defined for this ONTAPI call.

cifs-server-stop

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

Note: Set the "enabled" field to perform the operation.

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

There are no attributes defined for this ONTAPI call.

cifs-session-close

DELETE /api/protocols/cifs/sessions/{node.uuid}/{svm.uuid}/{identifier}/{connection_id}

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

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

Specifies the maximum number of records to return before paging.

cifs-session-file-close

DELETE /api/protocols/cifs/session/files/{node.uuid}/{svm.uuid}/{identifier}/{connection.identifier}/{session.identifier}

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

ONTAPI attribute REST attribute Comment

connection-id

connection.identifier

file-id

identifier

node

node.name

session-id

session.identifier

cifs-session-file-get-iter

GET /api/protocols/cifs/session/files

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

ONTAPI attribute REST attribute Comment

connection-count

connection.count

connection-id

connection.identifier

continuously-available

continuously_available

file-id

identifier

file-type

type

flexgroup-msid

No REST Equivalent

hosting-aggregate

No REST Equivalent

hosting-volume

volume.name

node

node.name

open-mode

open_mode

path

path

range-locks

range_lock_count

reconnected

No REST Equivalent

session-id

session.identifier

share

share.name

share-mode

share.mode

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-session-get-iter

GET /api/protocols/cifs/sessions

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

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

Specifies the maximum number of records to return before paging.

cifs-shadowcopy-add-files

PATCH /api/protocols/cifs/shadow-copies/{client_uuid}

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

ONTAPI attribute REST attribute Comment

client-shadow-copy-id

client_uuid

files

files

cifs-shadowcopy-ems-get-iter

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

cifs-shadowcopy-keep-snapshot

PATCH /api/protocols/cifs/shadowcopy-sets/{uuid}

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

ONTAPI attribute REST attribute Comment

storage-shadow-copy-set-id

uuid

cifs-shadowcopy-restore-dir

PATCH /api/protocols/cifs/shadow-copies

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

ONTAPI attribute REST attribute Comment

dst-dir

destination_dir

src-dir

source_dir

volume

volume

with-content

with_content

cifs-share-access-control-create

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

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

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}

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

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

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

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

Specifies 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}

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

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

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

ONTAPI attribute REST attribute Comment

attribute-cache-ttl

No REST Equivalent

comment

comment

dir-umask

dir_umask

file-umask

file_umask

force-group-for-create

force_group_for_create

is-path-validation-enabled

No REST Equivalent

max-connections-per-share

No REST Equivalent

offline-files-mode

offline_files

path

path

return-record

No REST Equivalent

share-name

name

share-properties

No REST Equivalent

Share-properties are separate fields in the REST API. You can achieve this functionality by setting the fields "access_based_enumeration", "change_notify", "encryption", "home_directory", "oplocks", "show_snapshot", "continuously_available" and "namespace_caching".

symlink-properties

unix_symlink

vscan-fileop-profile

vscan_profile

cifs-share-delete

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

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

ONTAPI attribute REST attribute Comment

share-name

name

cifs-share-get-iter

GET /api/protocols/cifs/shares

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

ONTAPI attribute REST attribute Comment

acl

acls

attribute-cache-ttl

No REST Equivalent

cifs-server

No REST Equivalent

comment

comment

dir-umask

dir_umask

file-umask

file_umask

force-group-for-create

force_group_for_create

max-connections-per-share

No REST Equivalent

offline-files-mode

offline_files

path

path

share-name

name

share-properties

No REST Equivalent

symlink-properties

unix_symlink

volume

volume.name

vscan-fileop-profile

vscan_profile

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-share-modify

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

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

ONTAPI attribute REST attribute Comment

attribute-cache-ttl

No REST Equivalent

comment

comment

dir-umask

dir_umask

file-umask

file_umask

force-group-for-create

force_group_for_create

is-path-validation-enabled

No REST Equivalent

max-connections-per-share

No REST Equivalent

offline-files-mode

offline_files

path

path

share-name

name

share-properties

No REST Equivalent

Share-properties are separate fields in the REST API. You can achieve this functionality by setting the fields "access_based_enumeration", "change_notify", "encryption", "home_directory", "oplocks", "show_snapshot", "continuously_available" and "namespace_caching".

symlink-properties

unix_symlink

vscan-fileop-profile

vscan_profile

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

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

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}

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

ONTAPI attribute REST attribute Comment

unix-path

unix_path

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

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

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

Specifies the maximum number of records to return before paging.

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

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

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

GET /api/protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members

Note: The local group members can also be retrieved using REST API: /api/protocols/cifs/local-groups.

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

ONTAPI attribute REST attribute Comment

group-name

No REST Equivalent

The local group is identified using the SID attribute. This field is not required in REST API.

member

records.name

This is an advanced privilege field in REST API: /api/protocols/cifs/local-groups.

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

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

GET /api/protocols/cifs/local-users

Note: This API is merged with cifs-local-user-get-iter in REST API.

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

ONTAPI attribute REST attribute Comment

membership

membership

This is an advanced privilege field in the REST API.

user-name

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

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

GET /api/protocols/cifs/users-and-groups/bulk-import/{svm.uuid}

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

ONTAPI attribute REST attribute Comment

uri

status_uri.path

uri-password

status_uri.password

uri-username

status_uri.username

operation-status

state

detailed-operation-status

detailed_status.message

num-elements-ignored

elements_ignored

num-elements-ok

elements_imported

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

POST /api/protocols/cifs/users-and-groups/bulk-import/{svm.uuid}

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

ONTAPI attribute REST attribute Comment

append

No REST Equivalent

file-password

decryption_password

uri

import_uri.path

uri-password

import_uri.password

uri-username

import_uri.username

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.