netapp.ontap.na_ontap_iscsi_security module – NetApp ONTAP Manage iscsi security.

Note

This module is part of the netapp.ontap collection (version 22.0.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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: netapp.ontap.na_ontap_iscsi_security.

New in netapp.ontap 19.11.0

Synopsis

  • Create/Delete/Modify iscsi security.

Requirements

The below requirements are needed on the host that executes this module.

  • Ansible 2.9 or later - 2.12 or later is recommended.

  • Python3 - 3.9 or later is recommended.

  • When using ZAPI, 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

Parameters

Parameter

Comments

address_ranges

list / elements=string

May be a single IPv4 or IPv6 address or a range containing a startaddress and an end address.

The start and end addresses themselves are included in the range.

If not present, the initiator is allowed to log in from any IP address.

auth_type

string

Specifies the authentication type.

Choices:

  • "chap"

  • "none"

  • "deny"

cert_filepath

string

added in netapp.ontap 20.6.0

path to SSL client cert file (.pem).

not supported with python 2.6.

feature_flags

dictionary

added in netapp.ontap 20.5.0

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_ontap_version

string

added in netapp.ontap 21.23.0

Override the cluster ONTAP version when using REST.

The behavior is undefined if the version does not match the target cluster.

This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues.

This should be in the form 9.10 or 9.10.1 with each element being an integer number.

When use_rest is set to auto, this may force a switch to ZAPI based on the version and platform capabilities.

Ignored with ZAPI.

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:

  • false ← (default)

  • true

inbound_password

string

Inbound CHAP user password.

Can not be modified. If want to change password, delete and re-create the initiator.

inbound_username

string

Inbound CHAP username.

Required for CHAP. A null username is not allowed.

initiator

string / required

Specifies the name of the initiator.

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

ontapi

integer

The ontap api version to use

outbound_password

string

Outbound CHAP user password.

Can not be modified. If want to change password, delete and re-create the initiator.

outbound_username

string

Outbound CHAP user name.

password

aliases: pass

string

Password for the specified user.

state

string

Whether the specified initiator should exist or not.

Choices:

  • "present" ← (default)

  • "absent"

use_rest

string

Whether to use REST or ZAPI.

always – will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST.

never – will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI.

auto – will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise.

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:

  • false

  • true ← (default)

vserver

string / required

Name of the vserver to use.

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

  • https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Examples

- name: create
  netapp.ontap.na_ontap_iscsi_security:
    hostname: 0.0.0.0
    username: user
    password: pass
    vserver: test_svm
    state: present
    initiator: eui.9999956789abcdef
    inbound_username: user_1
    inbound_password: password_1
    outbound_username: user_2
    outbound_password: password_2
    auth_type: chap
    address_ranges: 10.125.10.0-10.125.10.10,10.125.193.78

- name: modify outbound username
  netapp.ontap.na_ontap_iscsi_security:
    hostname: 0.0.0.0
    username: user
    password: pass
    vserver: test_svm
    state: present
    initiator: eui.9999956789abcdef
    inbound_username: user_1
    inbound_password: password_1
    outbound_username: user_out_3
    outbound_password: password_3
    auth_type: chap
    address_ranges: 10.125.10.0-10.125.10.10,10.125.193.78

- name: modify address
  netapp.ontap.na_ontap_iscsi_security:
    hostname: 0.0.0.0
    username: user
    password: pass
    vserver: test_svm
    state: present
    initiator: eui.9999956789abcdef
    address_ranges: 10.125.193.90,10.125.10.20-10.125.10.30

Authors

  • NetApp Ansible Team (@carchi8py)