ansible.builtin.na_ontap_lun (v2.9.26) — module

Install Ansible via pip

Install with pip install ansible==2.9.26

Description

Create, destroy, resize LUNs on NetApp ONTAP.

Requirements

• 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.
• Ansible 2.6
• Ansible 2.9 or later is strongly recommended as it enables the new collection delivery system.
• Python2 netapp-lib (2017.10.30) or later. Install using 'pip install netapp-lib'
• 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.
• To enable http on the cluster you must run the following commands 'set -privilege advanced;' 'system services web modify -http-enabled true;'

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 }}"

Inputs

    
name:
    description:
    - The name of the LUN to manage.
    required: true

size:
    description:
    - The size of the LUN in C(size_unit).
    - Required when C(state=present).

https:
    default: false
    description:
    - Enable and disable https.
    - Ignored when using REST as only https is supported.
    - Ignored when using SSL certificate authentication as it requires SSL.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the specified LUN should exist or not.

ontapi:
    description:
    - The ontap api version to use
    type: int

ostype:
    default: image
    description:
    - The os type for the LUN.

vserver:
    description:
    - The name of the vserver to use.
    required: true

hostname:
    description:
    - The hostname or IP address of the ONTAP instance.
    required: true
    type: str

password:
    aliases:
    - pass
    description:
    - Password for the specified user.
    type: str

use_rest:
    choices:
    - Never
    - Always
    - Auto
    default: Auto
    description:
    - 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
    type: str

username:
    aliases:
    - user
    description:
    - 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 U(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.
    type: str

http_port:
    description:
    - Override the default port (80 or 443) with this port
    type: int

size_unit:
    choices:
    - bytes
    - b
    - kb
    - mb
    - gb
    - tb
    - pb
    - eb
    - zb
    - yb
    default: gb
    description:
    - The unit used to interpret the size parameter.

flexvol_name:
    description:
    - The name of the FlexVol the LUN should exist on.
    required: true

force_remove:
    default: false
    description:
    - 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.
    type: bool

force_resize:
    default: false
    description: Forcibly reduce the size. This is required for reducing the size of the
      LUN to avoid accidentally reducing the LUN size.
    type: bool

key_filepath:
    description:
    - path to SSL client key file.
    type: str
    version_added: 20.6.0
    version_added_collection: netapp.ontap

cert_filepath:
    description:
    - path to SSL client cert file (.pem).
    - not supported with python 2.6.
    type: str
    version_added: 20.6.0
    version_added_collection: netapp.ontap

feature_flags:
    description:
    - 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.
    type: dict
    version_added: 20.5.0
    version_added_collection: netapp.ontap

space_reserve:
    default: true
    description:
    - This can be set to "false" which will create a LUN without any space being reserved.
    type: bool

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(False) used on personally controlled sites using self-signed
      certificates.
    type: bool

space_allocation:
    default: false
    description:
    - This enables support for the SCSI Thin Provisioning features.  If the Host and file
      system do not support this do not enable it.
    type: bool
    version_added: '2.7'
    version_added_collection: ansible.builtin

force_remove_fenced:
    default: false
    description:
    - 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.
    type: bool