netapp.ontap.na_ontap_nvme_subsystem – NetApp ONTAP Manage NVME Subsystem¶
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_nvme_subsystem
.
New in version 2.8.0: of netapp.ontap
Synopsis¶
Create/Delete NVME subsystem
Associate(modify) host/map to NVME subsystem
NVMe service should be existing in the data vserver with NVMe protocol as a pre-requisite
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.
|
|
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.
|
|
hostname
string
/ required
|
The hostname or IP address of the ONTAP instance.
|
|
hosts
list
/ elements=string
|
List of host NQNs (NVMe Qualification Name) associated to the controller.
|
|
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.
|
|
ontapi
integer
|
The ontap api version to use
|
|
ostype
string
|
|
Specifies the ostype for initiators
|
password
string
|
Password for the specified user.
aliases: pass |
|
paths
list
/ elements=string
|
List of Namespace paths to be associated with the subsystem.
|
|
skip_host_check
boolean
|
|
Skip host check
Required to delete an NVMe Subsystem with attached NVMe namespaces
|
skip_mapped_check
boolean
|
|
Skip mapped namespace check
Required to delete an NVMe Subsystem with attached NVMe namespaces
|
state
string
|
|
Whether the specified subsystem should exist or not.
|
subsystem
string
/ required
|
Specifies the subsystem
|
|
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
|
Name of the vserver to use.
|
Examples¶
- name: Create NVME Subsystem
na_ontap_nvme_subsystem:
state: present
subsystem: test_sub
vserver: test_dest
ostype: linux
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Delete NVME Subsystem
na_ontap_nvme_subsystem:
state: absent
subsystem: test_sub
vserver: test_dest
skip_host_check: True
skip_mapped_check: True
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Associate NVME Subsystem host/map
na_ontap_nvme_subsystem:
state: present
subsystem: "{{ subsystem }}"
ostype: linux
hosts: nqn.1992-08.com.netapp:sn.3017cfc1e2ba11e89c55005056b36338:subsystem.ansible
paths: /vol/ansible/test,/vol/ansible/test1
vserver: "{{ vserver }}"
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Modify NVME subsystem map
na_ontap_nvme_subsystem:
state: present
subsystem: test_sub
vserver: test_dest
skip_host_check: True
skip_mapped_check: True
paths: /vol/ansible/test
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
Authors¶
NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>