# Module `netapp_ontap.resources.iscsi_session`

Copyright © 2023 NetApp Inc. All rights reserved.

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

## Overview

An iSCSI session is one or more TCP connections that link an iSCSI initiator with an iSCSI target. TCP connections can be added and removed from an iSCSI session by the iSCSI initiator. Across all TCP connections within an iSCSI session, an initiator sees one and the same target. After the connection is established, iSCSI control, data, and status messages are communicated over the session.
The iSCSI sessions REST API provides information about iSCSI initiators that have successfully logged in to ONTAP.

## Examples

### Retrieving all iSCSI sessions

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import IscsiSession

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        print(list(IscsiSession.get_collection()))

Try it out

    [
        IscsiSession(
            {
                "_links": {
                    "self": {
                        "href": "/api/protocols/san/iscsi/sessions/a009a9e7-4081-b576-7575-ada21efcaf16/iscsi_lif1/10"
                    }
                },
                "target_portal_group": "iscsi_lif1",
                "tsih": 10,
                "svm": {
                    "_links": {
                        "self": {
                            "href": "/api/svm/svms/a009a9e7-4081-b576-7575-ada21efcaf16"
                        }
                    },
                    "name": "svm1",
                    "uuid": "a009a9e7-4081-b576-7575-ada21efcaf16",
                },
            }
        ),
        IscsiSession(
            {
                "_links": {
                    "self": {
                        "href": "/api/protocols/san/iscsi/sessions/b009a9e7-4081-b576-7575-ada21efcaf16/iscsi_lif2/11"
                    }
                },
                "target_portal_group": "iscsi_lif2",
                "tsih": 11,
                "svm": {
                    "_links": {
                        "self": {
                            "href": "/api/svm/svms/b009a9e7-4081-b576-7575-ada21efcaf16"
                        }
                    },
                    "name": "svm2",
                    "uuid": "b009a9e7-4081-b576-7575-ada21efcaf16",
                },
            }
        ),
    ]

### Retrieving all of the iSCSI sessions under the target portal group iscsi_lif1

The `tpgroup` query parameter is used to perform the query.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import IscsiSession

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        print(list(IscsiSession.get_collection(tpgroup="iscsi_lif1")))

Try it out

    [
        IscsiSession(
            {
                "_links": {
                    "self": {
                        "href": "/api/protocols/san/iscsi/sessions/a009a9e7-4081-b576-7575-ada21efcaf16/iscsi_lif1/10"
                    }
                },
                "target_portal_group": "iscsi_lif1",
                "tsih": 10,
                "svm": {
                    "_links": {
                        "self": {
                            "href": "/api/svm/svms/a009a9e7-4081-b576-7575-ada21efcaf16"
                        }
                    },
                    "name": "svm1",
                    "uuid": "a009a9e7-4081-b576-7575-ada21efcaf16",
                },
            }
        )
    ]

### Retrieving an iSCSI session

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import IscsiSession

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = IscsiSession(
            tsih=10,
            tpgroup="iscsi_lif1",
            **{"svm.uuid": "a009a9e7-4081-b576-7575-ada21efcaf16"}
        )
        resource.get()
        print(resource)

Try it out

    IscsiSession(
        {
            "_links": {
                "self": {
                    "href": "/api/protocols/san/iscsi/sessions/a009a9e7-4081-b576-7575-ada21efcaf16/iscsi_lif1/10"
                }
            },
            "target_portal_group": "iscsi_lif1",
            "isid": "61:62:63:64:65:00",
            "tsih": 10,
            "connections": [
                {
                    "cid": 1,
                    "initiator_address": {"port": 43827, "address": "10.224.123.85"},
                    "interface": {
                        "_links": {
                            "self": {
                                "href": "/api/network/ip/interfaces/c15439b4-dbb4-11e8-90ac-005056bba882"
                            }
                        },
                        "uuid": "c15439b4-dbb4-11e8-90ac-005056bba882",
                        "ip": {"port": 3260, "address": "192.168.0.1"},
                        "name": "iscsi_lif1",
                    },
                    "authentication_type": "chap",
                }
            ],
            "igroups": [
                {
                    "_links": {
                        "self": {
                            "href": "/api/protocols/san/igroups/af7838cd-f993-4faf-90b7-5524787ae1e8"
                        }
                    },
                    "uuid": "af7838cd-f993-4faf-90b7-5524787ae1e8",
                    "name": "igroup1",
                },
                {
                    "_links": {
                        "self": {
                            "href": "/api/protocols/san/igroups/bf7838cd-f993-4faf-90b7-5524787ae1e8"
                        }
                    },
                    "uuid": "bf7838cd-f993-4faf-90b7-5524787ae1e8",
                    "name": "igroup2",
                },
            ],
            "svm": {
                "_links": {
                    "self": {"href": "/api/svm/svms/a009a9e7-4081-b576-7575-ada21efcaf16"}
                },
                "name": "svm1",
                "uuid": "a009a9e7-4081-b576-7575-ada21efcaf16",
            },
            "target_portal_group_tag": 1027,
            "initiator": {
                "comment": "Example information about this initiator",
                "name": "iqn.1994-05.com.example:string",
            },
        }
    )

## Classes

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

  An iSCSI session is one or more TCP connections that link an iSCSI initiator with an iSCSI target. TCP connections can be added and removed from an iSCSI session by the iSCSI initiator. Across all TCP connections within an iSCSI session, an initiator sees one and the same target. After the connection is established, iSCSI control, data, and status messages are communicated over the session.

  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 IscsiSession 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 find (*args, connection: HostConnection = None, **kwargs) -> Resource`

    Retrieves iSCSI sessions.

    ### Related ONTAP commands

    - `vserver iscsi connection show`
    - `vserver iscsi session parameter show`
    - `vserver iscsi session show`

    ### Learn more

    - `DOC /protocols/san/iscsi/sessions`

    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 iSCSI sessions.

    ### Related ONTAP commands

    - `vserver iscsi connection show`
    - `vserver iscsi session parameter show`
    - `vserver iscsi session show`

    ### Learn more

    - `DOC /protocols/san/iscsi/sessions`

    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
    `**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 get (self, **kwargs) -> NetAppResponse`

    Retrieves an iSCSI session.

    ### Related ONTAP commands

    - `vserver iscsi connection show`
    - `vserver iscsi session parameter show`
    - `vserver iscsi session show`

    ### Learn more

    - `DOC /protocols/san/iscsi/sessions`

    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 IscsiSessionSchema (*, 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 IscsiSession object

  ### Ancestors

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

  ### Class variables

  `connections: List[IscsiConnection] GET`

    The iSCSI connections that make up the iSCSI session.

  `igroups: List[IgroupNestedRecords] GET`

    The initiator groups in which the initiator is a member.

  `initiator: IscsiSessionInitiator GET`

    The initiator field of the iscsi_session.

  `isid: str GET`

    The initiator portion of the session identifier specified by the initiator during login.

    Example: 61:62:63:64:65:00

  `links: SelfLink GET`

    The links field of the iscsi_session.

  `svm: Svm GET`

    The svm field of the iscsi_session.

  `target_portal_group: str GET`

    The target portal group to which the session belongs.

    Example: tpgroup1

  `target_portal_group_tag: Size GET`

    The target portal group tag of the session.

  `tsih: Size GET`

    The target session identifier handle (TSIH) of the session.