netapp.ontap.na_ontap_igroup – NetApp ONTAP iSCSI or FC igroup configuration
Note
This plugin is part of the netapp.ontap collection (version 21.1.1).
To install it use: ansible-galaxy collection install netapp.ontap
.
To use it in a playbook, specify: netapp.ontap.na_ontap_igroup
.
New in version 2.6.0: of netapp.ontap
Synopsis
- Create/Delete/Rename Igroups and Modify initiators belonging to an igroup
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 |
---|---|---|
bind_portset string | Name of a current portset to bind to the newly created igroup. | |
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. | |
force_remove_initiator boolean |
| Forcibly remove the initiator even if there are existing LUNs mapped to this initiator group. |
from_name string added in 2.7.0 of netapp.ontap | Name of igroup to rename to name. | |
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. |
initiator_group_type string |
| Type of the initiator group. Required when state=present . |
initiators list / elements=string | List of initiators to be mapped to the igroup. WWPN, WWPN Alias, or iSCSI name of Initiator to add or remove. For a modify operation, this list replaces the exisiting initiators This module does not add or remove specific initiator(s) in an igroup aliases: initiator | |
key_filepath string added in 20.6.0 of netapp.ontap | path to SSL client key file. | |
name string / required | The name of the igroup to manage. | |
ontapi integer | The ontap api version to use | |
os_type string | OS type of the initiators within the group. aliases: ostype | |
password string | Password for the specified user. aliases: pass | |
state string |
| Whether the specified Igroup should exist or not. |
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 | The 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 iSCSI Igroup na_ontap_igroup: state: present name: ansibleIgroup3 initiator_group_type: iscsi os_type: linux initiators: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com,abc.com:redhat.com vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create FC Igroup na_ontap_igroup: state: present name: ansibleIgroup4 initiator_group_type: fcp os_type: linux initiators: 20:00:00:50:56:9f:19:82 vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: rename Igroup na_ontap_igroup: state: present from_name: ansibleIgroup3 name: testexamplenewname initiator_group_type: iscsi os_type: linux initiators: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Modify Igroup Initiators (replaces exisiting initiators) na_ontap_igroup: state: present name: ansibleIgroup3 initiator_group_type: iscsi os_type: linux initiator: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete Igroup na_ontap_igroup: state: absent name: ansibleIgroup3 vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}"
Authors
- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netapp/ontap/na_ontap_igroup_module.html