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

Retrieve CIFS open files

PDFs

GET /protocols/cifs/session/files

Introduced In: 9.11

Retrieves CIFS Open Files

Parameters

Name Type In Required Description

session.identifier

integer

query

False

Filter by session.identifier

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

volume.uuid

string

query

False

Filter by volume.uuid

volume.name

string

query

False

Filter by volume.name

range_locks_count

integer

query

False

Filter by range_locks_count

path

string

query

False

Filter by path

continuously_available

string

query

False

Filter by continuously_available

open_mode

string

query

False

Filter by open_mode

connection.count

integer

query

False

Filter by connection.count

connection.identifier

integer

query

False

Filter by connection.identifier

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

share.name

string

query

False

Filter by share.name

share.mode

string

query

False

Filter by share.mode

type

string

query

False

Filter by type

identifier

integer

query

False

Filter by identifier

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.

  • Default value: 15

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

collection_links

num_records

integer

Number of records

records

array[cifs_open_file]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "connection": {
        "count": 3,
        "identifier": 356756
      },
      "continuously_available": "no",
      "identifier": 17,
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "open_mode": "r",
      "path": "sub1\\sub2\\f4",
      "range_locks_count": 4,
      "session": {
        "identifier": 8966666858094657537
      },
      "share": {
        "mode": "r",
        "name": "share1"
      },
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "type": "regular",
      "volume": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "volume1",
        "uuid": "028baa66-41bd-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
Name Type Description

next

href

self

href
Name Type Description

self

href

connection

Name Type Description

count

integer

The number of CIFS connections associated with the CIFS session.

identifier

integer

The connection that is used to open the file.

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

session

Name Type Description

identifier

integer

Session under which file is opened.

share

Name Type Description

mode

string

The share mode used to open the file. The share mode can be a combination of:

  • r: read mode

  • w: write mode

  • d: delete

name

string

CIFS share name where the file resides.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

volume

Name Type Description

_links

_links

name

string

The name of the volume.

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

  • x-nullable: true

cifs_open_file

Manage opened files over CIFS.

Name Type Description

_links

self_link

connection

connection

continuously_available

string

The type of continuous availability protection provided to the file. Opened files are continuously available if there are opened through a SMB3 client through a share with "continuously_available" set to yes. These open files are capable of non-disruptively recovering from take over and giveback as well as general aggregate relocation.

  • no: the open file is not continuously available.

  • yes: the open file is continuously available.

identifier

integer

The unique identifier for the opened file.

node

node

open_mode

string

Open mode corresponding to the opened file

  • r: Opened for read

  • w: Opened for write

  • d: Opened for Delete

path

string

Path from CIFS share.

range_locks_count

integer

The number of range locks granted on the file.

session

session

share

share

svm

svm

type

string

The type of opened file. The file can be a regular file, directory, a symbolic link to an existing file/directory, or an alternate data stream.

volume

volume

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.