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

Retrieve a CIFS open file

Contributors
PDFs

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

Introduced In: 9.11

Retrieves specific CIFS Open File

Parameters

Name Type In Required Description

node.uuid

string

path

True

Node UUID.

identifier

integer

path

True

File ID

  • format: int64

connection.identifier

integer

path

True

Connection ID

session.identifier

integer

path

True

Session ID

  • format: int64

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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

SVM, applies only to SVM-scoped objects.

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
Example response 
{
  "_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

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

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.

volume

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

  • x-nullable: true

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.