# Module `netapp_ontap.resources.nvme_interface`

Copyright © 2023 NetApp Inc. All rights reserved.

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

## Overview

NVMe interfaces are network interfaces configured to support an NVMe over Fabrics (NVMe-oF) protocol. The NVMe interfaces are Fibre Channel (FC) interfaces supporting an NVMe-oF data protocol. Regardless of the underlying physical and data protocol, NVMe interfaces are treated equally for host-side application configuration. This endpoint provides a consolidated view of all NVMe interfaces for the purpose of configuring host-side applications.
The NVMe interfaces REST API provides NVMe-specific information about network interfaces configured to support an NVMe-oF protocol.
NVMe interfaces must be created using the protocol-specific endpoints for FC interfaces. See `POST /network/fc/interfaces`. After creation, the interfaces are available via this interface.

## Examples

### Retrieving summary information for all NVMe interfaces

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import NvmeInterface

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

Try it out

    [
        NvmeInterface(
            {
                "_links": {
                    "self": {
                        "href": "/api/protocols/nvme/interfaces/74d69872-0d30-11e9-a684-005056bbdb14"
                    }
                },
                "name": "nvme1",
                "svm": {
                    "_links": {
                        "self": {
                            "href": "/api/svm/svms/013e2c44-0d30-11e9-a684-005056bbdb14"
                        }
                    },
                    "name": "svm1",
                    "uuid": "013e2c44-0d30-11e9-a684-005056bbdb14",
                },
                "uuid": "74d69872-0d30-11e9-a684-005056bbdb14",
            }
        ),
        NvmeInterface(
            {
                "_links": {
                    "self": {
                        "href": "/api/protocols/nvme/interfaces/77ded991-0d30-11e9-a684-005056bbdb14"
                    }
                },
                "name": "nvme2",
                "svm": {
                    "_links": {
                        "self": {
                            "href": "/api/svm/svms/013e2c44-0d30-11e9-a684-005056bbdb14"
                        }
                    },
                    "name": "svm1",
                    "uuid": "013e2c44-0d30-11e9-a684-005056bbdb14",
                },
                "uuid": "77ded991-0d30-11e9-a684-005056bbdb14",
            }
        ),
    ]

### Retrieving detailed information for a specific NVMe interface

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import NvmeInterface

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = NvmeInterface(uuid="77ded991-0d30-11e9-a684-005056bbdb14")
        resource.get()
        print(resource)

Try it out

    NvmeInterface(
        {
            "_links": {
                "self": {
                    "href": "/api/protocols/nvme/interfaces/77ded991-0d30-11e9-a684-005056bbdb14"
                }
            },
            "name": "nvme2",
            "node": {
                "_links": {
                    "self": {
                        "href": "/api/cluster/nodes/cd4d47fd-0d2e-11e9-a684-005056bbdb14"
                    }
                },
                "name": "node1",
                "uuid": "cd4d47fd-0d2e-11e9-a684-005056bbdb14",
            },
            "fc_interface": {
                "_links": {
                    "self": {
                        "href": "/api/network/fc/interfaces/77ded991-0d30-11e9-a684-005056bbdb14"
                    }
                },
                "wwnn": "20:03:00:50:56:bb:db:14",
                "port": {
                    "_links": {
                        "self": {
                            "href": "/api/network/fc/ports/081ec491-0d2f-11e9-a684-005056bbdb14"
                        }
                    },
                    "name": "1a",
                    "node": {"name": "node1"},
                    "uuid": "081ec491-0d2f-11e9-a684-005056bbdb14",
                },
                "wwpn": "20:05:00:50:56:bb:db:14",
            },
            "svm": {
                "_links": {
                    "self": {"href": "/api/svm/svms/013e2c44-0d30-11e9-a684-005056bbdb14"}
                },
                "name": "svm1",
                "uuid": "013e2c44-0d30-11e9-a684-005056bbdb14",
            },
            "enabled": True,
            "uuid": "77ded991-0d30-11e9-a684-005056bbdb14",
            "transport_address": "nn-0x2003005056bbdb14:pn-0x2005005056bbdb14",
        }
    )

## Classes

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

  NVMe interfaces are network interfaces configured to support an NVMe over Fabrics (NVMe-oF) protocol. The NVMe interfaces are Fibre Channel interfaces supporting an NVMe-oF data protocol. Regardless of the underlying physical and data protocol, NVMe interfaces are treated equally for host-side application configuration. This endpoint provides a consolidated view of all NVMe interfaces for the purpose of configuring host-side applications.
  NVMe interfaces must be created using the protocol-specific endpoints for Fibre Channel interfaces. See `POST /network/fc/interfaces`. After creation, the interfaces are available via this interface.

  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 NvmeInterface 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 NVMe interfaces.

    ### Related ONTAP commands

    - `vserver nvme show-interface`

    ### Learn more

    - `DOC /protocols/nvme/interfaces`

    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 NVMe interfaces.

    ### Related ONTAP commands

    - `vserver nvme show-interface`

    ### Learn more

    - `DOC /protocols/nvme/interfaces`

    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 NVMe interface.

    ### Related ONTAP commands

    - `vserver nvme show-interface`

    ### Learn more

    - `DOC /protocols/nvme/interfaces`

    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 NvmeInterfaceSchema (*, 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 NvmeInterface object

  ### Ancestors

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

  ### Class variables

  `enabled: bool GET`

    The administrative state of the NVMe interface.

  `fc_interface: NvmeInterfaceFcInterface GET`

    The fc_interface field of the nvme_interface.

  `interface_type: str GET`

    The underlying interface type of the NVMe interface. This property identifies which of fc_interface and ip_interface will be further populated.

    Valid choices:

    - fc_interface
    - ip_interface
  `ip_interface: NvmeInterfaceIpInterface GET`

    The ip_interface field of the nvme_interface.

  `links: SelfLink GET`

    The links field of the nvme_interface.

  `name: str GET`

    The name of the NVMe interface.

    Example: lif1

  `node: Node GET`

    The node field of the nvme_interface.

  `svm: Svm GET`

    The svm field of the nvme_interface.

  `transport_address: str GET`

    The transport address of the NVMe interface.

    Example: nn-0x200a00a0989062da:pn-0x200100a0989062da

  `transport_protocols: List[str] GET`

    The transport protocols supported by the NVMe interface.

  `uuid: str GET`

    The unique identifier of the NVMe interface.

    Example: 1cd8a442-86d1-11e0-ae1c-123478563412