netapp.ontap.na_ontap_license module – NetApp ONTAP protocol and feature license packages

Note

This module is part of the netapp.ontap collection (version 22.8.3).

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_license.

New in netapp.ontap 2.6.0

Synopsis

  • Add or remove license packages on NetApp ONTAP.

  • Note that the module is asymmetrical.

  • It requires license codes to add packages and the package name is not visible.

  • It requires package names and as serial number to remove packages.

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

cert_filepath

string

added in netapp.ontap 20.6.0

path to SSL client cert file (.pem).

not supported with python 2.6.

feature_flags

dictionary

added in netapp.ontap 20.5.0

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.

force_ontap_version

string

added in netapp.ontap 21.23.0

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 use_rest is set to auto, this may force a switch to ZAPI based on the version and platform capabilities.

Ignored with ZAPI.

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.

Choices:

  • false ← (default)

  • true

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

license_codes

list / elements=string

List of license codes to be installed.

license_names

list / elements=string

List of license package names to remove.

base

string

Cluster Base License

cdmi

string

CDMI License

cifs

string

CIFS License

fcp

string

FCP License

flexclone

string

FlexClone License

iscsi

string

iSCSI License

nfs

string

NFS License

snaplock

string

SnapLock License

snapmanagersuite

string

SnapManagerSuite License

snapmirror

string

SnapMirror License

snapprotectapps

string

SnapProtectApp License

snaprestore

string

SnapRestore License

snapvault

string

SnapVault License

v_storageattach

string

Virtual Attached Storage License

ontapi

integer

The ontap api version to use

password

aliases: pass

string

Password for the specified user.

remove_expired

boolean

Remove license packages that have expired in the cluster.

Not supported with REST.

Choices:

  • false

  • true

remove_unused

boolean

Remove license packages that have no controller affiliation in the cluster.

Not supported with REST.

Choices:

  • false

  • true

serial_number

string

Serial number of the node or cluster associated with the license package.

This parameter is required when removing a license package.

With REST, ‘*’ is accepted and matches any serial number.

state

string

Whether the specified license packages should be installed or removed.

Choices:

  • "present" ← (default)

  • "absent"

use_rest

string

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: "auto"

username

aliases: user

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.

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.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Partially supports check_mode - some changes cannot be detected until an add or remove action is performed.

  • Supports 28 character key licenses with ZAPI and REST.

  • Supports NetApp License File Version 2 (NLFv2) with REST.

  • NetApp License File Version 1 (NLFv1) with REST is not supported at present but may work.

  • Ansible attempts to reformat license files as the contents are python-like. Use the string filter in case of problem to disable this behavior.

  • This module requires the python ast and json packages when the string filter is not used.

  • This module requires the json package to check for idempotency, and to remove licenses using a NLFv2 file.

  • This module requires the deepdiff package to check for idempotency.

  • None of these packages are required when the string filter is used, but the module will not be idempotent.

  • 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: Add licenses - 28 character keys
  netapp.ontap.na_ontap_license:
    state: present
    serial_number: #################
    license_codes: CODE1,CODE2

- name: Remove licenses
  netapp.ontap.na_ontap_license:
    state: absent
    remove_unused: false
    remove_expired: true
    serial_number: #################
    license_names: nfs,cifs

- name: Add NLF licenses
  netapp.ontap.na_ontap_license:
    state: present
    license_codes:
      - "{{ lookup('file', nlf_filepath) | string }}"

- name: Remove NLF license bundle - using license file
  netapp.ontap.na_ontap_license:
    state: absent
    license_codes:
      - "{{ lookup('file', nlf_filepath) | string }}"

- name: Remove NLF license bundle - using bundle name
  netapp.ontap.na_ontap_license:
    state: absent
    remove_unused: false
    remove_expired: true
    serial_number: #################
    license_names: "Enterprise Edition"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

updated_licenses

dictionary

return list of updated package names

Returned: always

Sample: "['nfs']"

Authors

  • NetApp Ansible Team (@carchi8py)