netapp.ontap.na_ontap_lun – NetApp ONTAP manage LUNs¶
Note
This plugin is part of the netapp.ontap collection (version 21.4.0).
To install it use: ansible-galaxy collection install netapp.ontap
.
To use it in a playbook, specify: netapp.ontap.na_ontap_lun
.
New in version 2.6.0: of netapp.ontap
Requirements¶
The below requirements are needed on the host that executes this module.
Ansible 2.9
Python3 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.
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 | ||
---|---|---|---|---|
cert_filepath
string
added in 20.6.0 of netapp.ontap
|
path to SSL client cert file (.pem).
not supported with python 2.6.
|
|||
comment
string
added in 21.2.0 of netapp.ontap
|
Optional descriptive comment for the LUN.
|
|||
feature_flags
dictionary
added in 20.5.0 of netapp.ontap
|
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.
|
|||
flexvol_name
string
|
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.
|
|||
force_remove
boolean
|
|
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
boolean
|
|
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
boolean
|
|
Forcibly reduce the size. This is required for reducing the size of the LUN to avoid accidentally reducing the LUN size.
|
||
from_name
string
added in 20.12.0 of netapp.ontap
|
The name of the LUN to be renamed.
|
|||
hostname
string
/ required
|
The hostname or IP address of the ONTAP instance.
|
|||
http_port
integer
|
Override the default port (80 or 443) with this port
|
|||
https
boolean
|
|
Enable and disable https.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
|
||
key_filepath
string
added in 20.6.0 of netapp.ontap
|
path to SSL client key file.
|
|||
name
string
/ required
|
The name of the LUN to manage.
Or LUN group name (volume name) when san_application_template is used.
|
|||
ontapi
integer
|
The ontap api version to use
|
|||
os_type
string
|
The os type for the LUN.
aliases: ostype |
|||
password
string
|
Password for the specified user.
aliases: pass |
|||
qos_adaptive_policy_group
string
added in 21.2.0 of netapp.ontap
|
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.
|
|||
qos_policy_group
string
added in 20.12.0 of netapp.ontap
|
The QoS policy group to be set on the LUN.
|
|||
san_application_template
dictionary
added in 20.12.0 of netapp.ontap
|
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).
|
|||
igroup_name
string
|
name of the initiator group through which the contents of this application will be accessed.
|
|||
lun_count
integer
|
number of LUNs in the application component (1 to 32).
|
|||
name
string
/ required
|
name of the SAN application.
|
|||
protection_type
dictionary
|
The snasphot policy for the volume supporting the LUNs.
|
|||
local_policy
string
|
The snapshot copy policy for the volume.
|
|||
scope
string
added in 21.2.0 of netapp.ontap
|
|
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.
|
||
storage_service
string
|
|
The performance service level (PSL) for this volume
|
||
tiering
dictionary
|
Cloud tiering policy.
|
|||
control
string
|
|
Storage tiering placement rules for the container.
|
||
object_stores
list
/ elements=string
|
list of object store names for tiering.
|
|||
policy
string
|
|
Cloud tiering policy.
|
||
total_size
integer
added in 21.1.0 of netapp.ontap
|
The total size of the application component, split across the member LUNs in
total_size_unit .Recommended when
lun_count is present.Required when
lun_count is present and greater than 1.Note - if lun_count is equal to 1, and total_size is not present, size is used to maintain backward compatibility.
|
|||
total_size_unit
string
added in 21.1.0 of netapp.ontap
|
|
The unit used to interpret the total_size parameter.
Defaults to size_unit if not present.
|
||
use_san_application
boolean
|
|
Whether to use the application/applications REST/API to create LUNs.
This will default to true if any other suboption is present.
|
||
size
integer
|
The size of the LUN in
size_unit .Required when creating a single LUN if application template is not used.
|
|||
size_unit
string
|
|
The unit used to interpret the size parameter.
|
||
space_allocation
boolean
added in 2.7.0 of netapp.ontap
|
|
This enables support for the SCSI Thin Provisioning features. If the Host and file system do not support this do not enable it.
|
||
space_reserve
boolean
|
|
This can be set to "false" which will create a LUN without any space being reserved.
|
||
state
string
|
|
Whether the specified LUN should exist or not.
|
||
use_exact_size
boolean
added in 20.11.0 of netapp.ontap
|
|
This can be set to "False" which will round the LUN >= 450g.
|
||
use_rest
string
|
Default: "auto"
|
REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI.
always -- will always use the REST API
never -- will always use the ZAPI
auto -- will try to use the REST Api
|
||
username
string
|
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
1. basic authentication, using username and password,
2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file.
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled.
aliases: user |
|||
validate_certs
boolean
|
|
If set to
no , the SSL certificates will not be validated.This should only set to
False used on personally controlled sites using self-signed certificates. |
||
vserver
string
/ required
|
The name of the vserver to use.
|
Examples¶
- name: Create LUN
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
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
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
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Convert existing volume to SAN application
tags: create
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 }}"
Authors¶
NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>