na_ontap_nvme_subsystem – NetApp ONTAP Manage NVME Subsystem
na_ontap_nvme_subsystem – NetApp ONTAP Manage NVME Subsystem
New in version 2.8.
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.
- A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward
- Ansible 2.6
- 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’
- 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 string / required |
The hostname or IP address of the ONTAP instance. | |
hosts list |
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 |
ontapi integer |
The ontap api version to use | |
ostype - |
|
Specifies the ostype for initiators |
password string / required |
Password for the specified user.
| |
paths list |
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 - |
|
Whether the specified subsystem should exist or not. |
subsystem - / required |
Specifies the subsystem | |
username string / 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://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.
| |
validate_certs boolean |
|
If set to This should only set to |
vserver - / required |
Name of the vserver to use. |
Notes
Note
- The modules prefixed with na\_ontap are built to support the ONTAP storage platform.
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 }}"
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- NetApp Ansible Team (@carchi8py) <[email protected]>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/na_ontap_nvme_subsystem_module.html