Skip to main content

Retrieve CIFS session information for all SVMs

Contributors
PDFs

GET /protocols/cifs/sessions

Introduced In: 9.8

Retrieves the CIFS sessions information for all SVMs.

  • vserver cifs session show -active-volumes

Learn more

Parameters

Name Type In Required Description

server_ip

string

query

False

Filter by server_ip

connection_count

integer

query

False

Filter by connection_count

open_shares

integer

query

False

Filter by open_shares

protocol

string

query

False

Filter by protocol

open_files

integer

query

False

Filter by open_files

smb_encryption

string

query

False

Filter by smb_encryption

idle_duration

string

query

False

Filter by idle_duration

smb_signing

boolean

query

False

Filter by smb_signing

continuous_availability

string

query

False

Filter by continuous_availability

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

large_mtu

boolean

query

False

Filter by large_mtu

user

string

query

False

Filter by user

connection_id

integer

query

False

Filter by connection_id

identifier

integer

query

False

Filter by identifier

client_ip

string

query

False

Filter by client_ip

authentication

string

query

False

Filter by authentication

volumes.uuid

string

query

False

Filter by volumes.uuid

volumes.name

string

query

False

Filter by volumes.name

open_other

integer

query

False

Filter by open_other

mapped_unix_user

string

query

False

Filter by mapped_unix_user

connected_duration

string

query

False

Filter by connected_duration

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

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.

  • Default value: 1

  • Max value: 120

  • Min value: 0

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

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_session]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "authentication": "ntlmv2",
      "client_ip": "10.74.7.182",
      "connected_duration": "P4DT84H30M5S",
      "connection_count": 0,
      "connection_id": 22802,
      "continuous_availability": "unavailable",
      "identifier": 4622663542519103507,
      "idle_duration": "P4DT84H30M5S",
      "large_mtu": true,
      "mapped_unix_user": "root",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "open_files": 0,
      "open_other": 0,
      "open_shares": 0,
      "protocol": "smb3_1",
      "server_ip": "10.140.78.248",
      "smb_encryption": "unencrypted",
      "smb_signing": "",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "user": "NBCIFSQA2\\administrator",
      "volumes": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "volume1",
          "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
        }
      ]
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_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

node

Name Type Description

_links

_links

name

string

uuid

string

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

volumes

Name Type Description

_links

_links

name

string

The name of the volume. This field cannot be specified in a POST or PATCH method.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • Introduced in: 9.8

  • x-nullable: true

cifs_session

Name Type Description

_links

_links

authentication

string

SMB authentication over which the client accesses the share. The following values are supported:

  • none - No authentication

  • ntlmv1 - Ntlm version 1 mechanism

  • ntlmv2 - Ntlm version 2 mechanism

  • kerberos - Kerberos authentication

  • anonymous - Anonymous mechanism

client_ip

string

Specifies IP address of the client.

connected_duration

string

Specifies an ISO-8601 format of date and time used to retrieve the connected time duration in hours, minutes, and seconds format.

connection_count

integer

A counter used to track requests that are sent to the volumes to the node.

connection_id

integer

A unique 32-bit unsigned number used to represent each SMB session's connection ID.

continuous_availability

string

The level of continuous availability protection provided to the SMB sessions and/or files.

  • unavailable - Open file is not continuously available. For sessions, it contains one or more open files but none of them are continuously available.

  • available - open file is continuously available. For sessions, it contains one or more open files and all of them are continuously available.

  • partial - Sessions only. Contains at least one continuously available open file with other files open but not continuously available.

identifier

integer

A unique 64-bit unsigned number used to represent each SMB session's identifier.

idle_duration

string

Specifies an ISO-8601 format of date and time used to retrieve the idle time duration in hours, minutes, and seconds format.

large_mtu

boolean

Specifies whether the large MTU is enabled or not for an SMB session.

mapped_unix_user

string

Indicated that a mapped UNIX user has logged in.

node

node

open_files

integer

Number of files the SMB session has opened.

open_other

integer

Number of other files the SMB session has opened.

open_shares

integer

Number of shares the SMB session has opened.

protocol

string

The SMB protocol version over which the client accesses the volumes. The following values are supported:

  • smb1 - SMB version 1

  • smb2 - SMB version 2

  • smb2_1 - SMB version 2 minor version 1

  • smb3 - SMB version 3

  • smb3_1 - SMB version 3 minor version 1

server_ip

string

Specifies the IP address of the SVM.

smb_encryption

string

Indicates an SMB encryption state. The following values are supported:

  • unencrypted - SMB session is not encrypted

  • encrypted - SMB session is fully encrypted. SVM level encryption is enabled and encryption occurs for the entire session.

  • partially_encrypted - SMB session is partially encrypted. Share level encryption is enabled and encryption is initiated when the tree-connect occurs.

smb_signing

boolean

Specifies whether or not SMB signing is enabled.

svm

svm

SVM, applies only to SVM-scoped objects.

user

string

Indicates that a Windows user has logged in.

volumes

array[volumes]

A group of volumes, the client is accessing.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.