Docs4dev
Docs
ansible / 2.6 / modules / na_ontap_igroup_module.html

na_ontap_igroup - ONTAP iSCSI igroup configuration

New in version 2.6.

Synopsis

  • create, destroy or rename Igroups and add or remove initiator in igroups.

Requirements

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;’

Parameters

Parameter Choices/Defaults Comments
bind_portset
Name of a current portset to bind to the newly created igroup.
force_remove_initiator
bool
    Choices:
  • no ←
  • yes
Forcibly remove the initiator even if there are existing LUNs mapped to this initiator group.
hostname
required
The hostname or IP address of the ONTAP instance.
https
bool
    Choices:
  • no ←
  • yes
Enable and disabled https
initiator
WWPN, WWPN Alias, or iSCSI name of Initiator to add or remove.
initiator_group_type
    Choices:
  • fcp
  • iscsi
  • mixed
Type of the initiator group.
Required when state=present.
name
required
The name of the lun to manage.
new_name
New name to be given to initiator group.
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
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://goo.gl/BRu78Z.

aliases: user
vserver
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 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: 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 }}"

- 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 }}"

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/na_ontap_igroup_module.html