W3cubDocs

/Ansible 2.7

na_ontap_lun_map - NetApp ONTAP LUN maps

New in version 2.6.

Synopsis

  • Map and unmap LUNs on NetApp ONTAP.

Requirements

The below requirements are needed on the host that executes this module.

  • A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 9.3
  • Ansible 2.6
  • netapp-lib (2017.10.30). Install using ‘pip install netapp-lib’
  • To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Parameter Choices/Defaults Comments
hostname
required
The hostname or IP address of the ONTAP instance.
http_port
int
Override the default port (80 or 443) with this port
https
bool
    Choices:
  • no ←
  • yes
Enable and disable https
initiator_group_name
required
Initiator group to map to the given LUN.
lun_id
LUN ID assigned for the map.
password
required
Password for the specified user.

aliases: pass
path
required
Path of the LUN..
state
    Choices:
  • present ←
  • absent
Whether the specified LUN should exist or not.
username
required
This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.

aliases: user
validate_certs
bool
    Choices:
  • no
  • yes ←
If set to False, the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.
vserver
required
The name of the vserver to use.

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

Examples

- name: Create LUN mapping
  na_ontap_lun_map:
    state: present
    initiator_group_name: ansibleIgroup3234
    path: /vol/iscsi_path/iscsi_lun
    vserver: ci_dev
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Unmap LUN
  na_ontap_lun_map:
    state: absent
    initiator_group_name: ansibleIgroup3234
    path: /vol/iscsi_path/iscsi_lun
    vserver: ci_dev
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Return Values

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

Key Returned Description
lun_naa_id
string
 success
The Network Address Authority (NAA) identifier for the LUN.

Sample:
600a0980383045372f5d4c5a70315474
lun_node
string
 success
NetApp controller that is hosting the LUN.

Sample:
node01
lun_ostype
string
 success
Specifies the OS of the host accessing the LUN.

Sample:
vmware
lun_serial
string
 success
A unique, 12-byte, ASCII string used to identify the LUN.

Sample:
80E7/]LZp1Tt
lun_size
int
 success
Size of the LUN in bytes.

Sample:
2199023255552
lun_state
string
 success
Online or offline status of the LUN.

Sample:
online


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

Hint

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

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