na_ontap_igroup - NetApp ONTAP iSCSI igroup configuration
- create, destroy or rename Igroups and add or remove initiator in igroups.
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;’
Parameter |
Choices/Defaults |
Comments |
bind_portset
|
|
Name of a current portset to bind to the newly created igroup.
|
force_remove_initiator
bool |
|
Forcibly remove the initiator even if there are existing LUNs mapped to this initiator group.
|
from_name
(added in 2.7) |
|
Name of igroup to rename to name.
|
hostname
required |
|
The hostname or IP address of the ONTAP instance.
|
http_port
int |
|
Override the default port (80 or 443) with this port
|
https
bool |
|
Enable and disable https
|
initiator
|
|
WWPN, WWPN Alias, or iSCSI name of Initiator to add or remove.
|
initiator_group_type
|
|
Type of the initiator group.
Required when state=present .
|
name
required |
|
The name of the igroup to manage.
|
ostype
|
|
OS type of the initiators within the group.
|
password
required |
|
Password for the specified user.
aliases: pass
|
state
|
Choices:
present ←
- absent
|
Whether the specified Igroup should exist or not.
|
username
required |
|
aliases: user
|
validate_certs
bool |
|
If set to False , the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.
|
vserver
required |
|
The name of the vserver to use.
|
Note
- The modules prefixed with na_ontap are built to support the ONTAP storage platform.
- name: Create Igroup
na_ontap_igroup:
state: present
name: ansibleIgroup3
initiator_group_type: iscsi
ostype: linux
initiator: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com
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
ostype: linux
initiator: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: remove Igroup
na_ontap_igroup:
state: absent
name: ansibleIgroup3
initiator_group_type: iscsi
ostype: linux
initiator: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by an Ansible Partner, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.