Documentation
  • Docs »
  • na_ontap_lun - Manage NetApp Ontap luns

na_ontap_lun - Manage NetApp Ontap luns

New in version 2.6.

Synopsis

  • Create, destroy, resize 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
flexvol_name
required
The name of the FlexVol the lun should exist on.
force_remove
bool
    Choices:
  • no ←
  • yes
If "true", override checks that prevent a LUN from being destroyed if it is online and mapped.
If "false", destroying an online and mapped LUN will fail.
force_remove_fenced
bool
    Choices:
  • no ←
  • yes
If "true", override checks that prevent a LUN from being destroyed while it is fenced.
If "false", attempting to destroy a fenced LUN will fail.
The default if not specified is "false". This field is available in Data ONTAP 8.2 and later.
force_resize
bool
    Choices:
  • no ←
  • yes
Forcibly reduce the size. This is required for reducing the size of the LUN to avoid accidentally reducing the LUN size.
hostname
required
The hostname or IP address of the ONTAP instance.
https
bool
    Choices:
  • no ←
  • yes
Enable and disabled https
name
required
The name of the lun to manage.
ostype Default:
"image"
The os type for the LUN.
password
required
Password for the specified user.

aliases: pass
size
The size of the lun in size_unit.
Required when state=present.
size_unit
    Choices:
  • bytes
  • b
  • kb
  • mb
  • gb ←
  • tb
  • pb
  • eb
  • zb
  • yb
The unit used to interpret the size parameter.
space_reserve
bool
    Choices:
  • no
  • yes ←
This can be set to "false" which will create a LUN without any space being reserved.
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://goo.gl/BRu78Z.

aliases: user
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
  na_ontap_lun:
    state: present
    name: ansibleLUN
    flexvol_name: ansibleVolume
    vserver: ansibleVServer
    size: 5
    size_unit: mb
    ostype: linux
    space_reserve: True
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Resize Lun
  na_ontap_lun:
    state: present
    name: ansibleLUN
    force_resize: True
    flexvol_name: ansibleVolume
    vserver: ansibleVServer
    size: 5
    size_unit: gb
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

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.