Docs4dev
Docs
ansible / 2.6 / modules / netapp_e_lun_mapping_module.html

netapp_e_lun_mapping - Create or Remove LUN Mappings

New in version 2.2.

Synopsis

  • Allows for the creation and removal of volume to host mappings for NetApp E-series storage arrays.

Parameters

Parameter Choices/Defaults Comments
api_password
required
The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
api_url
required
The url to the SANtricity WebServices Proxy or embedded REST API.
api_username
required
The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
lun Default:
0
The LUN number you wish to give the mapping
If the supplied volume_name is associated with a different LUN, it will be updated to what is supplied here.
ssid
required
The ID of the array to manage. This value must be unique for each array.
state
required
    Choices:
  • present
  • absent
Present will ensure the mapping exists, absent will remove the mapping.
All parameters lun, target, target_type and volume_name must still be supplied.
target
The name of host or hostgroup you wish to assign to the mapping
If omitted, the default hostgroup is used.
If the supplied volume_name is associated with a different target, it will be updated to what is supplied here.
target_type
    Choices:
  • host
  • group
Whether the target is a host or group.
Required if supplying an explicit target.
validate_certs Default:
"yes"
Should https certificates be validated?
volume_name
required
The name of the volume you wish to include in the mapping.

Examples

---
    - name: Lun Mapping Example
      netapp_e_lun_mapping:
        state: present
        ssid: 1
        lun: 12
        target: Wilson
        volume_name: Colby1
        target_type: group
        api_url: "{{ netapp_api_url }}"
        api_username: "{{ netapp_api_username }}"
        api_password: "{{ netapp_api_password }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
msg
string
always
Status of mapping

Sample:
Mapping existing


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Kevin Hulquest (@hulquest)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/netapp_e_lun_mapping_module.html