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

Protocols CIFS sessions endpoint overview

PDFs

Overview

ONTAP CIFS sessions show functionality is used to provide a list of currently established CIFS sessions.

The following lists the fields retrieved using the CIFS sessions GET API:

node.name: Node name hosting this record; basically the node hosting the "server_ip". node.uuid: Node UUID hosting this record; basically the node hosting the "server_ip". svm.name: Svm name to which the "server_ip" belongs to. svm.uuid: Svm uuid to which the "server_ip" belongs to. server_ip: All clients connected to this interface are displayed in rows. client_ip: IP address of the client connected to the interface. identifier: Unique identifier used to represent each SMB session. connection_id: Unique identifier used to represent each SMB Connection. authentication: Type of authentication supported by the server when a client accesses a SMB share. user: Username for the Windows client. mapped_unix_user: Mapped UNIX user name. open_shares: Number of shares opened by the client on a specific SVM. open_files: Number of files opened by the client on a specific SVM. open_others: Number of other files opened by the client on a specific SVM. connected_duration: Time elapsed since the first request was sent by the client for this SMB session. idle_duration: Time elapsed since the last request was sent by the client for this SMB session. protocol: SMB protocol dialects over which the client accesses the SMB share. availability: Level of continuous availabilty of protection provided to the files from the SMB share smb_signing: Specifies whether SMB signing is enabled. smb_encryption: Specifies the SMB session encryption status. large_mtu: Specifies whether the SMB session's large MTU is enabled. connection_count: Counter used to track requests that are sent to the volumes to the node. volumes.name: Name of the active volumes the client is accessing. volumes.uuid: UUID of the active volumes the client is accessing.

Example

Retrieves established sessions information

# The API:
GET /protocols/cifs/sessions

# The call:
curl -X GET "https://<cluster-mgmt-ip>/api/protocols/cifs/sessions?return_timeout=15&return_records=true" -H "accept: application/json"

# The response:
{
"records": [
  {
    "node": {
      "uuid": "85d46998-4e5d-11ea-afb1-0050568ec4e4",
      "name": "bkalyan-vsim1"
    },
    "svm": {
      "uuid": "fc824aa8-4e60-11ea-afb1-0050568ec4e4",
      "name": "vs1"
    },
    "identifier": 625718873227788300,
    "connection_id": 91842,
    "lif_address": "10.140.70.197",
    "address": "10.74.7.182",
    "auth_mechanism": "ntlmv2",
    "windows_user": "NBCIFSQA2\\administrator",
    "unix_user": "root",
    "shares": 1,
    "files": 2,
    "other": 0,
    "connected_time": "PT16H54M47S",
    "idle_time": "PT3S",
    "protocol_version": "smb3_1",
    "continuously_available": "no",
    "is_session_signed": false,
    "smb_encryption_status": "unencrypted",
    "connection_count": 1,
    "is_large_mtu_enabled": true,
    "vol_names": [
      "vol12",
      "origin",
      "fg",
      "vol1"
    ],
    "vol_uuids": [
      "954d697f-4e62-11ea-afb1-0050568ec4e4",
      "0f909e06-4e6e-11ea-afb1-0050568ec4e4",
      "08c27b7d-4e61-11ea-afb1-0050568ec4e4",
      "02f0a240-4e61-11ea-afb1-0050568ec4e4"
    ]
  },
  {
    "node": {
      "uuid": "85d46998-4e5d-11ea-afb1-0050568ec4e4",
      "name": "bkalyan-vsim1"
    },
    "svm": {
      "uuid": "fc824aa8-4e60-11ea-afb1-0050568ec4e4",
       "name": "vs1"
    },
    "identifier": 625718873227788500,
    "connection_id": 92080,
    "lif_address": "10.140.70.197",
    "address": "10.140.133.97",
    "auth_mechanism": "ntlmv2",
    "windows_user": "NBCIFSQA2\\administrator",
    "unix_user": "root",
    "shares": 1,
    "files": 1,
    "other": 0,
    "connected_time": "PT1M19S",
    "idle_time": "PT1M1S",
    "protocol_version": "smb3",
    "continuously_available": "no",
    "is_session_signed": false,
    "smb_encryption_status": "unencrypted",
    "connection_count": 1,
    "is_large_mtu_enabled": true,
    "vol_names": [
      "origin",
      "fg",
      "vol1"
    ],
    "vol_uuids": [
      "0f909e06-4e6e-11ea-afb1-0050568ec4e4",
      "08c27b7d-4e61-11ea-afb1-0050568ec4e4",
      "02f0a240-4e61-11ea-afb1-0050568ec4e4"
    ]
  }
],
"num_records": 2
}