netapp.ontap.na_ontap_lun module – NetApp ONTAP manage LUNs
Note
This module is part of the netapp.ontap collection (version 22.13.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install netapp.ontap.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.ontap.na_ontap_lun.
New in netapp.ontap 2.6.0
Synopsis
Create, destroy, resize LUNs on NetApp ONTAP.
Requirements
The below requirements are needed on the host that executes this module.
Ansible 2.9 or later - 2.12 or later is recommended.
Python3 - 3.9 or later is recommended.
When using ZAPI, netapp-lib 2018.11.13 or later (install using ‘pip install netapp-lib’), netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
A physical or virtual clustered Data ONTAP system, the modules support Data ONTAP 9.1 and onward, REST support requires ONTAP 9.6 or later.
Parameters
Parameter |
Comments |
|---|---|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
Optional descriptive comment for the LUN. |
|
Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. |
|
The name of the FlexVol the LUN should exist on. Required if san_application_template is not present. Not allowed if san_application_template is present. |
|
Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number. When Ignored with ZAPI. |
|
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. Choices:
|
|
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. Choices:
|
|
Forcibly reduce the size. This is required for reducing the size of the LUN to avoid accidentally reducing the LUN size. Choices:
|
|
The name of the LUN to be renamed. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
path to SSL client key file. |
|
The name of the LUN to manage. Or LUN group name (volume name) when san_application_template is used. |
|
The ontap api version to use |
|
The os type for the LUN. |
|
Password for the specified user. |
|
The adaptive QoS policy group to be set on the LUN. Defines measurable service level objectives (SLOs) and service level agreements (SLAs) that adjust based on the LUN’s allocated space or used space. Requires ONTAP 9.4 or later. With REST, qos_policy_group and qos_adaptive_policy_group are handled as QOS policy. |
|
The QoS policy group to be set on the LUN. With REST, qos_policy_group and qos_adaptive_policy_group are handled as QOS policy. |
|
Specifies the name of the Qtree that contains the new LUN. Not allowed if san_application_template is present. Only supported with REST. |
|
additional options when using the application/applications REST API to create LUNs. the module is using ZAPI by default, and switches to REST if san_application_template is present. create one or more LUNs (and the associated volume as needed). operations at the LUN level are supported, they require to know the LUN short name. this requires ONTAP 9.8 or higher. The module partially supports ONTAP 9.7 for create and delete operations, but not for modify (API limitations). |
|
The list of aggregate names to exclude when creating a volume. Requires ONTAP 9.9.1 GA or better. |
|
name of the initiator group through which the contents of this application will be accessed. |
|
number of LUNs in the application component (1 to 32). |
|
name of the SAN application. |
|
The snasphot policy for the volume supporting the LUNs. |
|
The snapshot copy policy for the volume. |
|
whether the top level name identifies a single LUN or a LUN group (application). By default, the module will try to make the right choice, but can report extra warnings. Setting scope to ‘application’ is required to convert an existing volume to a smart container. The module reports an error when ‘lun’ or ‘application’ is used and the desired action cannot be completed. The module issues warnings when the default ‘auto’ is used, and there is ambiguity regarding the desired actions. Choices:
|
|
The performance service level (PSL) for this volume Choices:
|
|
Cloud tiering policy. |
|
Storage tiering placement rules for the container. Choices:
|
|
list of object store names for tiering. |
|
Cloud tiering policy. Choices:
|
|
The total size of the application component, split across the member LUNs in Recommended when Required when Note - if lun_count is equal to 1, and total_size is not present, size is used to maintain backward compatibility. |
|
The unit used to interpret the total_size parameter. Defaults to size_unit if not present. Choices:
|
|
Whether to use the application/applications REST/API to create LUNs. This will default to true if any other suboption is present. Choices:
|
|
The size of the LUN in Required when creating a single LUN if application template is not used. |
|
The unit used to interpret the size parameter. Choices:
|
|
This enables support for the SCSI Thin Provisioning features. If the Host and file system do not support this do not enable it. Choices:
|
|
This can be set to “false” which will create a LUN without any space being reserved. Choices:
|
|
Whether the specified LUN should exist or not. Choices:
|
|
This can be set to “false” which will round the LUN >= 450g. Choices:
|
|
Whether to use REST or ZAPI. always – will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST. never – will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI. auto – will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise. Default: |
|
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/. Two authentication methods are supported
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
|
The name of the vserver to use. |
Notes
Note
The modules prefixed with na_ontap are built to support the ONTAP storage platform.
https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Examples
- name: Create LUN
netapp.ontap.na_ontap_lun:
state: present
name: ansibleLUN
flexvol_name: ansibleVolume
vserver: ansibleVServer
size: 5
size_unit: mb
os_type: linux
space_reserve: true
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Resize LUN
netapp.ontap.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 }}"
- name: Create LUNs using SAN application
tags: create
netapp.ontap.na_ontap_lun:
state: present
name: ansibleLUN
size: 15
size_unit: mb
os_type: linux
space_reserve: false
san_application_template:
name: san-ansibleLUN
igroup_name: testme_igroup
lun_count: 3
protection_type:
local_policy: default
exclude_aggregates: aggr0
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Convert existing volume to SAN application
tags: create
netapp.ontap.na_ontap_lun:
state: present
name: someVolume
size: 22
size_unit: mb
os_type: linux
space_reserve: false
san_application_template:
name: san-ansibleLUN
igroup_name: testme_igroup
lun_count: 3
protection_type:
local_policy: default
scope: application
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"