Documentation

na_ontap_license - Manage NetApp ONTAP protocol and feature licenses

New in version 2.6.

Synopsis

  • Add or remove licenses 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.
https
bool
    Choices:
  • no ←
  • yes
Enable and disabled https
license_codes
List of license codes to be added.
license_names
List of license-names to delete.
fcp
FCP License
snaplock
SnapLock License
v_storageattach
Virtual Attached Storage License
cifs
CIFS License
iscsi
iSCSI License
flexclone
FlexClone License
cdmi
CDMI License
snaprestore
SnapRestore License
snapprotectapps
SnapProtectApp License
base
Cluster Base License
nfs
NFS License
snapmirror
SnapMirror License
snapvault
SnapVault License
snapmanagersuite
SnapManagerSuite License
password
required
Password for the specified user.

aliases: pass
remove_expired
bool
    Choices:
  • no
  • yes
Remove licenses that have expired in the cluster.
remove_unused
bool
    Choices:
  • no
  • yes
Remove licenses that have no controller affiliation in the cluster.
serial_number
Serial number of the node associated with the license. This parameter is used primarily when removing license for a specific service.
state
    Choices:
  • present ←
  • absent
Whether the specified license 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

Notes

Note

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

Examples

- name: Add licenses
  na_ontap_license:
    state: present
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    serial_number: #################
    license_codes: CODE1,CODE2

- name: Remove licenses
  na_ontap_license:
    state: absent
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    remove_unused: false
    remove_expired: true
    serial_number: #################
    license_names: nfs,cifs

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

Hint

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