# Module `netapp_ontap.resources.lun_map`

Copyright © 2020 NetApp Inc. All rights reserved.

## Overview

A LUN map is an association between a LUN and an initiator group. When a LUN is mapped to an initiator group, the initiator group's initiators are granted access to the LUN. The relationship between an initiator group and a LUN is many initiator groups to many LUNs.
The LUN map REST API allows you to create, delete, and discover LUN maps.

## Examples

### Creating a LUN map

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import LunMap

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = LunMap()
        resource.svm.name = "svm1"
        resource.igroup.name = "igroup1"
        resource.lun.name = "/vol/vol1/lun1"
        resource.post(hydrate=True)
        print(resource)

### Retrieving all of the LUN maps

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import LunMap

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

Try it out

    [
        LunMap(
            {
                "igroup": {
                    "_links": {
                        "self": {
                            "href": "/api/protocols/san/igroups/40d98b2c-24c5-11e9-9ec1-005056bba643"
                        }
                    },
                    "uuid": "40d98b2c-24c5-11e9-9ec1-005056bba643",
                    "name": "ig1",
                },
                "lun": {
                    "uuid": "a60d9862-9bee-49a6-8162-20d2421bb1a6",
                    "name": "/vol/vol1/lun1",
                    "_links": {
                        "self": {
                            "href": "/api/storage/luns/a60d9862-9bee-49a6-8162-20d2421bb1a6"
                        }
                    },
                },
                "_links": {
                    "self": {
                        "href": "/api/protocols/san/lun-maps/a60d9862-9bee-49a6-8162-20d2421bb1a6/40d98b2c-24c5-11e9-9ec1-005056bba643"
                    }
                },
                "svm": {
                    "_links": {
                        "self": {
                            "href": "/api/svm/svms/03157e81-24c5-11e9-9ec1-005056bba643"
                        }
                    },
                    "uuid": "03157e81-24c5-11e9-9ec1-005056bba643",
                    "name": "svm1",
                },
            }
        )
    ]

### Retrieving a specific LUN map

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import LunMap

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = LunMap(
            **{
                "igroup.uuid": "40d98b2c-24c5-11e9-9ec1-005056bba643",
                "lun.uuid": "a60d9862-9bee-49a6-8162-20d2421bb1a6",
            }
        )
        resource.get()
        print(resource)

Try it out

    LunMap(
        {
            "igroup": {
                "_links": {
                    "self": {
                        "href": "/api/protocols/san/igroups/40d98b2c-24c5-11e9-9ec1-005056bba643"
                    }
                },
                "uuid": "40d98b2c-24c5-11e9-9ec1-005056bba643",
                "os_type": "linux",
                "name": "ig1",
                "protocol": "mixed",
            },
            "lun": {
                "uuid": "a60d9862-9bee-49a6-8162-20d2421bb1a6",
                "name": "/vol/vol1/lun1",
                "_links": {
                    "self": {
                        "href": "/api/storage/luns/a60d9862-9bee-49a6-8162-20d2421bb1a6"
                    }
                },
                "node": {
                    "name": "node1",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/7d8607ea-24c1-11e9-9ec1-005056bba643"
                        }
                    },
                    "uuid": "7d8607ea-24c1-11e9-9ec1-005056bba643",
                },
            },
            "_links": {
                "self": {
                    "href": "/api/protocols/san/lun-maps/a60d9862-9bee-49a6-8162-20d2421bb1a6/40d98b2c-24c5-11e9-9ec1-005056bba643"
                }
            },
            "logical_unit_number": 0,
            "svm": {
                "_links": {
                    "self": {"href": "/api/svm/svms/03157e81-24c5-11e9-9ec1-005056bba643"}
                },
                "uuid": "03157e81-24c5-11e9-9ec1-005056bba643",
                "name": "svm1",
            },
        }
    )

### Deleting a LUN map

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import LunMap

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = LunMap(
            **{
                "igroup.uuid": "40d98b2c-24c5-11e9-9ec1-005056bba643",
                "lun.uuid": "a60d9862-9bee-49a6-8162-20d2421bb1a6",
            }
        )
        resource.delete()

## Classes

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

  A LUN map is an association between a LUN and an initiator group. When a LUN is mapped to an initiator group, the initiator group's initiators are granted access to the LUN. The relationship between a LUN and an initiator group is many LUNs to many initiator groups.

  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`

    Retrieves LUN maps.

    ### Related ONTAP commands

    - `lun mapping show`
    - `DOC /protocols/san/lun-maps`

    ### Learn more

    - `DOC /protocols/san/lun-maps`

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

    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, body: typing.Union = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Deletes a LUN map.

    ### Related ONTAP commands

    - `lun mapping delete`

    ### Learn more

    - `DOC /protocols/san/lun-maps`

    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.
    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `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 patched.

    ## Returns

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

    ## Raises

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

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

    Retrieves LUN maps.

    ### Related ONTAP commands

    - `lun mapping show`
    - `DOC /protocols/san/lun-maps`

    ### Learn more

    - `DOC /protocols/san/lun-maps`

    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) -> typing.Iterable`

    Retrieves LUN maps.

    ### Related ONTAP commands

    - `lun mapping show`
    - `DOC /protocols/san/lun-maps`

    ### Learn more

    - `DOC /protocols/san/lun-maps`

    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 delete(self, body: typing.Union = None, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse`

    Deletes a LUN map.

    ### Related ONTAP commands

    - `lun mapping delete`

    ### Learn more

    - `DOC /protocols/san/lun-maps`

    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.
    `**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 a LUN map.

    ### Related ONTAP commands

    - `lun mapping show`

    ### Learn more

    - `DOC /protocols/san/lun-maps`

    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

  `async def lun_map_create(links: dict = None, igroup: dict = None, logical_unit_number: netapp_ontap.resource.Size = None, lun: dict = None, svm: dict = None) -> netapp_ontap.resource_table.ResourceTable`

    Create an instance of a LunMap resource

    ## Args

    `links`
    `igroup`
    `logical_unit_number`
      The logical unit number assigned to the LUN when mapped to the specified initiator group. The number is used to identify the LUN to initiators in the initiator group when communicating through Fibre Channel Protocol or iSCSI. Optional in POST; if no value is provided, ONTAP assigns the lowest available value.
    `lun`

    svm:

  `async def lun_map_delete(logical_unit_number: netapp_ontap.resource.Size = None)`

    Delete an instance of a LunMap resource

    ## Args

    `logical_unit_number`
      The logical unit number assigned to the LUN when mapped to the specified initiator group. The number is used to identify the LUN to initiators in the initiator group when communicating through Fibre Channel Protocol or iSCSI. Optional in POST; if no value is provided, ONTAP assigns the lowest available value.
  `def lun_map_show(logical_unit_number: cliche.arg_types.choices.Choices.define.._Choices = None, fields: typing.List = None) -> netapp_ontap.resource_table.ResourceTable`

    Fetch a list of LunMap resources

    ## Args

    `logical_unit_number`
      The logical unit number assigned to the LUN when mapped to the specified initiator group. The number is used to identify the LUN to initiators in the initiator group when communicating through Fibre Channel Protocol or iSCSI. Optional in POST; if no value is provided, ONTAP assigns the lowest available value.
  `def post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse`

    Creates a LUN map.

    ### Required properties

    - `svm.uuid` or `svm.name` - Existing SVM in which to create the LUN map.
    - `igroup.uuid` or `igroup.name` - Existing initiator group to map to the specified LUN.
    - `lun.uuid` or `lun.name` - Existing LUN to map to the specified initiator group.

    ### Default property values

    If not specified in POST, the following default property values are assigned. * `logical_unit_number` - If no value is provided, ONTAP assigns the lowest available value.

    ### Related ONTAP commands

    - `lun mapping create`

    ### Learn more

    - `DOC /protocols/san/lun-maps`

    Send this object to the host as a creation request.

    ## Args

    `hydrate`
      If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the 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.
    `**kwargs`
      Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

    ## 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 LunMapSchema (*, only: typing.Union = None, exclude: typing.Union = (), many: bool = False, context: typing.Dict = None, load_only: typing.Union = (), dump_only: typing.Union = (), partial: typing.Union = False, unknown: str = None)`

  The fields of the LunMap object

  ### Ancestors

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

  ### Class variables

  `igroup GET POST PATCH`

    The igroup field of the lun_map.

  `links GET`

    The links field of the lun_map.

  `logical_unit_number GET POST`

    The logical unit number assigned to the LUN when mapped to the specified initiator group. The number is used to identify the LUN to initiators in the initiator group when communicating through Fibre Channel Protocol or iSCSI. Optional in POST; if no value is provided, ONTAP assigns the lowest available value.

    Example: 1

  `lun GET POST PATCH`

    The lun field of the lun_map.

  `svm GET POST PATCH`

    The svm field of the lun_map.