# Module `netapp_ontap.resources.cifs_open_file`

Copyright © 2023 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

## Overview

## ONTAP `cifs sessions file show` functionality is used to provide a list of currently opened files.

##

### Information on the open files * Lists all files opened in current session. ## Example ### Retrieving established open file information To retrieve the list of open files, use the following API. Note that return_records=true.
---

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import CifsOpenFile

    with HostConnection(
        "<cluster-mgmt-ip>", username="admin", password="password", verify=False
    ):
        print(list(CifsOpenFile.get_collection(fields="*", return_timeout=15)))

Try it out

    [
        CifsOpenFile(
            {
                "svm": {"uuid": "80e795f4-3553-11ee-9f97-005056ae78de", "name": "vs0"},
                "session": {"identifier": 10878444899913433090},
                "connection": {"count": 1, "identifier": 103985},
                "share": {"name": "sh1", "mode": "r"},
                "volume": {
                    "uuid": "8384f6ae-3553-11ee-a3c3-005056ae0dd5",
                    "name": "root_vs0",
                },
                "continuously_available": "no",
                "type": "regular",
                "range_locks_count": 0,
                "path": "first_file.txt",
                "open_mode": "r",
                "node": {
                    "uuid": "a5f65ec0-3550-11ee-93c5-005056ae78de",
                    "name": "sti220-vsim-sr050u",
                },
                "identifier": 109,
            }
        ),
        CifsOpenFile(
            {
                "svm": {"uuid": "80e795f4-3553-11ee-9f97-005056ae78de", "name": "vs0"},
                "session": {"identifier": 10878444899913433090},
                "connection": {"count": 1, "identifier": 103985},
                "share": {"name": "sh1", "mode": "r"},
                "volume": {
                    "uuid": "8384f6ae-3553-11ee-a3c3-005056ae0dd5",
                    "name": "root_vs0",
                },
                "continuously_available": "no",
                "type": "regular",
                "range_locks_count": 0,
                "path": "second_file.txt",
                "open_mode": "r",
                "node": {
                    "uuid": "a5f65ec0-3550-11ee-93c5-005056ae78de",
                    "name": "sti220-vsim-sr050u",
                },
                "identifier": 110,
            }
        ),
    ]

--- ### Retrieving specific open file Information ---

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import CifsOpenFile

    with HostConnection(
        "<cluster-mgmt-ip>", username="admin", password="password", verify=False
    ):
        resource = CifsOpenFile(
            identifier=109,
            **{
                "session.identifier": "10878444899913433090",
                "connection.identifier": "103985",
                "svm.uuid": "80e795f4-3553-11ee-9f97-005056ae78de",
                "node.uuid": "a5f65ec0-3550-11ee-93c5-005056ae78de",
            }
        )
        resource.get()
        print(resource)

Try it out

    CifsOpenFile(
        {
            "svm": {"uuid": "80e795f4-3553-11ee-9f97-005056ae78de", "name": "vs0"},
            "session": {"identifier": 10878444899913433000},
            "connection": {"count": 1, "identifier": 103985},
            "share": {"name": "sh1", "mode": "r"},
            "volume": {"uuid": "8384f6ae-3553-11ee-a3c3-005056ae0dd5", "name": "root_vs0"},
            "continuously_available": "no",
            "type": "regular",
            "range_locks_count": 0,
            "path": "first_file.txt",
            "open_mode": "r",
            "node": {
                "uuid": "a5f65ec0-3550-11ee-93c5-005056ae78de",
                "name": "sti220-vsim-sr050u",
            },
            "identifier": 109,
        }
    )

--- ### Closing a specific file based on `file.identifier`, `connection.identifier` and `session\_id` The file being closed is identified by the UUID of its SVM, the corresponding file.identifier, connection.identifier and session_id. ---

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import CifsOpenFile

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = CifsOpenFile(
            identifier=109,
            **{
                "session.identifier": "10878444899913433090",
                "connection.identifier": "103985",
                "svm.uuid": "80e795f4-3553-11ee-9f97-005056ae78de",
                "node.uuid": "a5f65ec0-3550-11ee-93c5-005056ae78de",
            }
        )
        resource.delete()

---

## Classes

`class CifsOpenFile (*args, **kwargs)`

  Manage opened files over CIFS.

  Initialize the instance of the resource.

  Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

      MyResource(name='foo').name == 'foo'

  ## Args

  `*args`
    Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
  `**kwargs`
    each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

  ### Ancestors

  - Resource

  ### Static methods

  `def count_collection (*args, connection: HostConnection = None, **kwargs) -> int`

    Returns a count of all CifsOpenFile resources that match the provided query

    This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

    ## Returns

    On success, returns an integer count of the objects of this type. On failure, returns -1.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

  `def delete_collection (*args, records: Iterable[_ForwardRef('CifsOpenFile')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Closes open files identified by svm.uuid, file.identifier, connection.identifier and session_id.

    ### Learn more

    - `DOC /protocols/cifs/session/files`

    Delete all objects in a collection which match the given query.

    All records on the host which match the query will be deleted.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
    `records`
      Can be provided in place of a query. If so, this list of objects will be deleted from the host.
    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be deleted.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def fast_get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[RawResource]`

    Returns a list of RawResources that represent CifsOpenFile resources that match the provided query

    Fetch a list of all objects of this type from the host.

        This is a lazy fetch, making API calls only as necessary when the result
        of this call is iterated over. For instance, if max_records is set to 5,
        then iterating over the collection causes an API call to be sent to the
        server once for every 5 records. If the client stops iterating before
        getting to the 6th record, then no additional API calls are made.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `max_records`
      The maximum number of records to return per call
    `raw`
      return a list of `netapp_ontap.resource.RawResource` objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A list of `Resource` objects

    ## Raises

    `NetAppRestError`: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

  `def find (*args, connection: HostConnection = None, **kwargs) -> Resource`

    Retrieves CIFS Open Files

    ### Learn more

    - `DOC /protocols/cifs/session/files`

    Find an instance of an object on the host given a query.

    The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A `Resource` object containing the details of the object or None if no matches were found.

    ## Raises

    `NetAppRestError`: If the API call returned more than 1 matching resource.

  `def get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]`

    Retrieves CIFS Open Files

    ### Learn more

    - `DOC /protocols/cifs/session/files`

    Fetch a list of all objects of this type from the host.

        This is a lazy fetch, making API calls only as necessary when the result
        of this call is iterated over. For instance, if max_records is set to 5,
        then iterating over the collection causes an API call to be sent to the
        server once for every 5 records. If the client stops iterating before
        getting to the 6th record, then no additional API calls are made.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `max_records`
      The maximum number of records to return per call
    `raw`
      return a list of `netapp_ontap.resource.RawResource` objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A list of `Resource` objects

    ## Raises

    `NetAppRestError`: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

  ### Methods

  `def delete (self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse`

    Closes open files identified by svm.uuid, file.identifier, connection.identifier and session_id.

    ### Learn more

    - `DOC /protocols/cifs/session/files`

    Send a deletion request to the host for this object.

    ## Args

    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def get (self, **kwargs) -> NetAppResponse`

    Retrieves specific CIFS Open File

    ### Learn more

    - `DOC /protocols/cifs/session/files`

    Fetch the details of the object from the host.

    Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  ### Inherited members

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class CifsOpenFileSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)`

  The fields of the CifsOpenFile object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `connection: CifsOpenFileConnection GET`

    The connection field of the cifs_open_file.

  `continuously_available: str GET`

    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.

    Valid choices:

    - no
    - yes
  `identifier: Size GET POST PATCH`

    The unique identifier for the opened file.

    Example: 17

  `links: SelfLink GET`

    The links field of the cifs_open_file.

  `node: Node GET POST PATCH`

    The node field of the cifs_open_file.

  `open_mode: str GET`

    Open mode corresponding to the opened file - r: Opened for read - w: Opened for write - d: Opened for Delete

    Valid choices:

    - r
    - w
    - d
  `path: str GET`

    Path from CIFS share.

    Example: sub1\sub2\f4

  `range_locks_count: Size GET`

    The number of range locks granted on the file.

    Example: 4

  `session: CifsOpenFileSession GET`

    The session field of the cifs_open_file.

  `share: CifsOpenFileShare GET`

    The share field of the cifs_open_file.

  `svm: Svm GET POST PATCH`

    The svm field of the cifs_open_file.

  `type: str GET`

    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.

    Valid choices:

    - directory
    - regular
    - stream
    - symlink
  `volume: Volume GET POST PATCH`

    The volume field of the cifs_open_file.