netapp.ontap.na_ontap_igroup – NetApp ONTAP iSCSI or FC igroup configuration

Note

This plugin is part of the netapp.ontap collection (version 21.14.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

aliases: allow_delete_while_mapped

boolean

Forcibly remove the initiator even if there are existing LUNs mapped to this initiator group.

Choices:

  • no ← (default)

  • yes

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.

Choices:

  • no ← (default)

  • yes

igroups

list / elements=string

added in 21.3.0 of netapp.ontap

List of igroups to be mapped to the igroup.

For a modify operation, this list replaces the existing igroups, or existing initiators.

This module does not add or remove specific igroup(s) in an igroup.

Mutually exclusive with initiator_names (initiators) and initiator_objects.

Requires ONTAP 9.9 or newer.

initiator_group_type

aliases: protocol

string

Type of the initiator group.

Required when state=present.

Choices:

  • fcp

  • iscsi

  • mixed

initiator_names

aliases: initiator, initiators

list / elements=string

added in 21.4.0 of netapp.ontap

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 existing initiators, or existing igroups.

This module does not add or remove specific initiator(s) in an igroup.

Mutually exclusive with igroups and initiator_objects.

This serves the same purpose as initiator_objects, but without the comment suboption.

initiator_objects

list / elements=dictionary

added in 21.4.0 of netapp.ontap

List of initiators to be mapped to the igroup, with an optional comment field.

WWPN, WWPN Alias, or iSCSI name of Initiator to add or remove.

For a modify operation, this list replaces the existing initiators, or existing igroups.

This module does not add or remove specific initiator(s) in an igroup.

Mutually exclusive with initiator_names (initiators) and igroups.

Requires ONTAP 9.9 with REST support.

comment

string

a more descriptive comment as the WWPN can be quite opaque.

name

string / required

name of the 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

aliases: ostype

string

OS type of the initiators within the group.

password

aliases: pass

string

Password for the specified user.

state

string

Whether the specified Igroup should exist or not.

Choices:

  • present ← (default)

  • absent

use_rest

string

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

Default: “auto”

username

aliases: user

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.

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.

Choices:

  • no

  • yes ← (default)

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
    initiator_names: 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 iSCSI Igroup - ONTAP 9.9
  na_ontap_igroup:
    state: present
    name: ansibleIgroup3
    initiator_group_type: iscsi
    os_type: linux
    initiator_objects:
      - name: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com
        comment: for test only
      - name: 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
    initiator_names: 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
    initiator_names: 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 initiator_names)
  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