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

Retrieve CIFS servers

Contributors
PDFs

GET /protocols/cifs/services

Introduced In: 9.6

Retrieves CIFS servers.

Expensive properties

There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

  • statistics.*

  • metric.*

  • vserver cifs server show

  • vserver cifs server options show

  • vserver cifs server security show

Learn more

Parameters

Name Type In Required Description

group_policy_object_enabled

boolean

query

False

Filter by group_policy_object_enabled

  • Introduced in: 9.12

name

string

query

False

Filter by name

  • maxLength: 15

  • minLength: 1

enabled

boolean

query

False

Filter by enabled

metric.latency.total

integer

query

False

Filter by metric.latency.total

  • Introduced in: 9.7

metric.latency.read

integer

query

False

Filter by metric.latency.read

  • Introduced in: 9.7

metric.latency.write

integer

query

False

Filter by metric.latency.write

  • Introduced in: 9.7

metric.latency.other

integer

query

False

Filter by metric.latency.other

  • Introduced in: 9.7

metric.duration

string

query

False

Filter by metric.duration

  • Introduced in: 9.7

metric.throughput.read

integer

query

False

Filter by metric.throughput.read

  • Introduced in: 9.7

metric.throughput.total

integer

query

False

Filter by metric.throughput.total

  • Introduced in: 9.7

metric.throughput.write

integer

query

False

Filter by metric.throughput.write

  • Introduced in: 9.7

metric.status

string

query

False

Filter by metric.status

  • Introduced in: 9.7

metric.iops.total

integer

query

False

Filter by metric.iops.total

  • Introduced in: 9.7

metric.iops.read

integer

query

False

Filter by metric.iops.read

  • Introduced in: 9.7

metric.iops.write

integer

query

False

Filter by metric.iops.write

  • Introduced in: 9.7

metric.iops.other

integer

query

False

Filter by metric.iops.other

  • Introduced in: 9.7

metric.timestamp

string

query

False

Filter by metric.timestamp

  • Introduced in: 9.7

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

options.fake_open

boolean

query

False

Filter by options.fake_open

  • Introduced in: 9.10

options.path_component_cache

boolean

query

False

Filter by options.path_component_cache

  • Introduced in: 9.10

options.null_user_windows_name

string

query

False

Filter by options.null_user_windows_name

  • Introduced in: 9.10

options.large_mtu

boolean

query

False

Filter by options.large_mtu

  • Introduced in: 9.10

options.admin_to_root_mapping

boolean

query

False

Filter by options.admin_to_root_mapping

  • Introduced in: 9.10

options.advanced_sparse_file

boolean

query

False

Filter by options.advanced_sparse_file

  • Introduced in: 9.10

options.shadowcopy

boolean

query

False

Filter by options.shadowcopy

  • Introduced in: 9.11

options.junction_reparse

boolean

query

False

Filter by options.junction_reparse

  • Introduced in: 9.10

options.referral

boolean

query

False

Filter by options.referral

  • Introduced in: 9.10

options.shadowcopy_dir_depth

integer

query

False

Filter by options.shadowcopy_dir_depth

  • Introduced in: 9.11

options.widelink_reparse_versions

string

query

False

Filter by options.widelink_reparse_versions

  • Introduced in: 9.10

options.smb_credits

integer

query

False

Filter by options.smb_credits

  • Introduced in: 9.10

  • Max value: 8192

  • Min value: 2

options.copy_offload

boolean

query

False

Filter by options.copy_offload

  • Introduced in: 9.10

options.multichannel

boolean

query

False

Filter by options.multichannel

  • Introduced in: 9.10

options.fsctl_trim

boolean

query

False

Filter by options.fsctl_trim

  • Introduced in: 9.10

comment

string

query

False

Filter by comment

  • maxLength: 48

  • minLength: 0

netbios.aliases

string

query

False

Filter by netbios.aliases

  • maxLength: 15

  • minLength: 1

netbios.wins_servers

string

query

False

Filter by netbios.wins_servers

netbios.enabled

boolean

query

False

Filter by netbios.enabled

default_unix_user

string

query

False

Filter by default_unix_user

ad_domain.organizational_unit

string

query

False

Filter by ad_domain.organizational_unit

ad_domain.fqdn

string

query

False

Filter by ad_domain.fqdn

statistics.throughput_raw.read

integer

query

False

Filter by statistics.throughput_raw.read

  • Introduced in: 9.7

statistics.throughput_raw.total

integer

query

False

Filter by statistics.throughput_raw.total

  • Introduced in: 9.7

statistics.throughput_raw.write

integer

query

False

Filter by statistics.throughput_raw.write

  • Introduced in: 9.7

statistics.latency_raw.total

integer

query

False

Filter by statistics.latency_raw.total

  • Introduced in: 9.7

statistics.latency_raw.read

integer

query

False

Filter by statistics.latency_raw.read

  • Introduced in: 9.7

statistics.latency_raw.write

integer

query

False

Filter by statistics.latency_raw.write

  • Introduced in: 9.7

statistics.latency_raw.other

integer

query

False

Filter by statistics.latency_raw.other

  • Introduced in: 9.7

statistics.iops_raw.total

integer

query

False

Filter by statistics.iops_raw.total

  • Introduced in: 9.7

statistics.iops_raw.read

integer

query

False

Filter by statistics.iops_raw.read

  • Introduced in: 9.7

statistics.iops_raw.write

integer

query

False

Filter by statistics.iops_raw.write

  • Introduced in: 9.7

statistics.iops_raw.other

integer

query

False

Filter by statistics.iops_raw.other

  • Introduced in: 9.7

statistics.timestamp

string

query

False

Filter by statistics.timestamp

  • Introduced in: 9.7

statistics.status

string

query

False

Filter by statistics.status

  • Introduced in: 9.7

security.aes_netlogon_enabled

boolean

query

False

Filter by security.aes_netlogon_enabled

  • Introduced in: 9.10

security.session_security

string

query

False

Filter by security.session_security

  • Introduced in: 9.10

security.use_ldaps

boolean

query

False

Filter by security.use_ldaps

  • Introduced in: 9.10

security.smb_encryption

boolean

query

False

Filter by security.smb_encryption

security.advertised_kdc_encryptions

string

query

False

Filter by security.advertised_kdc_encryptions

  • Introduced in: 9.12

security.ldap_referral_enabled

boolean

query

False

Filter by security.ldap_referral_enabled

  • Introduced in: 9.10

security.try_ldap_channel_binding

boolean

query

False

Filter by security.try_ldap_channel_binding

  • Introduced in: 9.10

security.smb_signing

boolean

query

False

Filter by security.smb_signing

security.encrypt_dc_connection

boolean

query

False

Filter by security.encrypt_dc_connection

  • Introduced in: 9.8

security.use_start_tls

boolean

query

False

Filter by security.use_start_tls

  • Introduced in: 9.10

security.restrict_anonymous

string

query

False

Filter by security.restrict_anonymous

security.kdc_encryption

boolean

query

False

Filter by security.kdc_encryption

security.lm_compatibility_level

string

query

False

Filter by security.lm_compatibility_level

  • Introduced in: 9.8

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

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Max value: 120

  • Min value: 0

  • Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[cifs_service]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "ad_domain": {
        "fqdn": "example.com",
        "organizational_unit": "string",
        "password": "string",
        "user": "string"
      },
      "comment": "This CIFS Server Belongs to CS Department",
      "default_unix_user": "string",
      "metric": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "duration": "PT15S",
        "iops": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "latency": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "status": "ok",
        "throughput": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "timestamp": "2017-01-25T11:20:13Z"
      },
      "name": "CIFS1",
      "netbios": {
        "aliases": [
          "ALIAS_1",
          "ALIAS_2",
          "ALIAS_3"
        ],
        "wins_servers": [
          "10.224.65.20",
          "10.224.65.21"
        ]
      },
      "options": {
        "null_user_windows_name": "string",
        "smb_credits": 128,
        "widelink_reparse_versions": [
          "smb1"
        ]
      },
      "security": {
        "advertised_kdc_encryptions": [
          "string"
        ],
        "lm_compatibility_level": "string",
        "restrict_anonymous": "string",
        "session_security": "string"
      },
      "statistics": {
        "iops_raw": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "latency_raw": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "status": "ok",
        "throughput_raw": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "timestamp": "2017-01-25T11:20:13Z"
      },
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      }
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

ad_domain

Name Type Description

fqdn

string

The fully qualified domain name of the Windows Active Directory to which this CIFS server belongs. A CIFS server appears as a member of Windows server object in the Active Directory store. POST and PATCH only.

organizational_unit

string

Specifies the organizational unit within the Active Directory domain to associate with the CIFS server. POST and PATCH only.

password

string

The account password used to add this CIFS server to the Active Directory. This is not audited.

user

string

The user account used to add this CIFS server to the Active Directory.

iops

The rate of I/O operations observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency

The round trip latency in microseconds observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput

The rate of throughput bytes per second observed at the storage object.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

metric

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

cifs_netbios

Name Type Description

aliases

array[string]

enabled

boolean

Specifies whether NetBios name service (NBNS) is enabled for the CIFS. If this service is enabled, the CIFS server will start sending the broadcast for name registration.

wins_servers

array[string]

cifs_service_options

Name Type Description

admin_to_root_mapping

boolean

Specifies whether or not Administrator can be mapped to the UNIX user "root".

advanced_sparse_file

boolean

Specifies whether or not the CIFS server supports the advanced sparse file capabilities. This allows CIFS clients to query the allocated ranges of a file and to write zeroes or free data blocks for ranges of a file.

copy_offload

boolean

Specifies whether or not to enable the Copy Offload feature. This feature enables direct data transfers within or between compatible storage devices without transferring the data through the host computer.

Note that this will also enable/disable the direct copy feature accordingly.

fake_open

boolean

Specifies whether or not fake open support is enabled. This parameter allows you to optimize the open and close requests coming from SMB 2 clients.

fsctl_trim

boolean

Specifies whether or not the trim requests (FSCTL_FILE_LEVEL_TRIM) are supported on the CIFS server.

junction_reparse

boolean

Specifies whether or not the reparse point support is enabled. When enabled the CIFS server exposes junction points to Windows clients as reparse points. This parameter is only active if the client has negotiated use of the SMB 2 or SMB 3 protocol. This parameter is not supported for SVMs with Infinite Volume.

large_mtu

boolean

Specifies whether or not SMB clients can send reads up to 1 MB in size.

multichannel

boolean

Specifies whether or not the CIFS server supports Multichannel.

null_user_windows_name

string

Specifies a Windows User or Group name that should be mapped in case of a NULL user value.

path_component_cache

boolean

Specifies whether or not the path component cache is enabled on the CIFS server.

referral

boolean

Specifies whether or not to refer clients to more optimal LIFs. When enabled, it automatically refers clients to a data LIF local to the node which hosts the root of the requested share.

shadowcopy

boolean

Specifies whether or not to enable the Shadowcopy Feature. This feature enables to take share-based backup copies of data that is in a data-consistent state at a specific point in time where the data is accessed over SMB 3.0 shares.

shadowcopy_dir_depth

integer

Specifies the maximum level of subdirectories on which ONTAP should create shadow copies.

  • Default value: 1

  • Introduced in: 9.11

smb_credits

integer

Specifies the maximum number of outstanding requests on a CIFS connection.

widelink_reparse_versions

array[string]

Specifies the CIFS protocol versions for which the widelink is reported as reparse point.

cifs_service_security

Name Type Description

advertised_kdc_encryptions

array[string]

aes_netlogon_enabled

boolean

Specifies whether or not an AES session key is enabled for the Netlogon channel.

encrypt_dc_connection

boolean

Specifies whether encryption is required for domain controller connections.

kdc_encryption

boolean
Important This attribute has been deprecated. Use "security.advertised_kdc_encryptions" to specify the encryption type to use. Specifies whether AES-128 and AES-256 encryption is enabled for all Kerberos-based communication with the Active Directory KDC. To take advantage of the strongest security with Kerberos-based communication, AES-256 and AES-128 encryption can be enabled on the CIFS server. Kerberos-related communication for CIFS is used during CIFS server creation on the SVM, as well as during the SMB session setup phase. The CIFS server supports the following encryption types for Kerberos communication:

  • RC4-HMAC

  • DES

  • AES When the CIFS server is created, the domain controller creates a computer machine account in Active Directory. After a newly created machine account authenticates, the KDC and the CIFS server negotiates encryption types. At this time, the KDC becomes aware of the encryption capabilities of the particular machine account and uses those capabilities in subsequent communication with the CIFS server. In addition to negotiating encryption types during CIFS server creation, the encryption types are renegotiated when a machine account password is reset.

ldap_referral_enabled

boolean

Specifies whether or not LDAP referral chasing is enabled for AD LDAP connections.

lm_compatibility_level

string

It is CIFS server minimum security level, also known as the LMCompatibilityLevel. The minimum security level is the minimum level of the security tokens that the CIFS server accepts from SMB clients. The available values are:

  • lm_ntlm_ntlmv2_krb Accepts LM, NTLM, NTLMv2 and Kerberos

  • ntlm_ntlmv2_krb Accepts NTLM, NTLMv2 and Kerberos

  • ntlmv2_krb Accepts NTLMv2 and Kerberos

  • krb Accepts Kerberos only

restrict_anonymous

string

Specifies what level of access an anonymous user is granted. An anonymous user (also known as a "null user") can list or enumerate certain types of system information from Windows hosts on the network, including user names and details, account policies, and share names. Access for the anonymous user can be controlled by specifying one of three access restriction settings. The available values are:

  • no_restriction - No access restriction for an anonymous user.

  • no_enumeration - Enumeration is restricted for an anonymous user.

  • no_access - All access is restricted for an anonymous user.

session_security

string

Specifies client session security for AD LDAP connections. The available values are:

  • none - No Signing or Sealing.

  • sign - Sign LDAP traffic.

  • seal - Seal and Sign LDAP traffic

smb_encryption

boolean

Specifies whether encryption is required for incoming CIFS traffic.

smb_signing

boolean

Specifies whether signing is required for incoming CIFS traffic. SMB signing helps to ensure that network traffic between the CIFS server and the client is not compromised.

try_ldap_channel_binding

boolean

Specifies whether or not channel binding is attempted in the case of TLS/LDAPS.

use_ldaps

boolean

Specifies whether or not to use use LDAPS for secure Active Directory LDAP connections by using the TLS/SSL protocols.

use_start_tls

boolean

Specifies whether or not to use SSL/TLS for allowing secure LDAP communication with Active Directory LDAP servers.

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

statistics

Name Type Description

iops_raw

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

cifs_service

Name Type Description

_links

_links

ad_domain

ad_domain

comment

string

A descriptive text comment for the CIFS server. SMB clients can see the CIFS server comment when browsing servers on the network. If there is a space in the comment, you must enclose the entire string in quotation marks.

default_unix_user

string

Specifies the UNIX user to which any authenticated CIFS user is mapped to, if the normal user mapping rules fails.

enabled

boolean

Specifies if the CIFS service is administratively enabled.

group_policy_object_enabled

boolean

If set to true, group policies will be applied to the SVM.

metric

metric

name

string

The name of the CIFS server.

netbios

cifs_netbios

options

cifs_service_options

security

cifs_service_security

statistics

statistics

svm

svm

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.