netapp.ontap.na_ontap_iscsi_security – NetApp ONTAP Manage iscsi security.¶
Note
This plugin is part of the netapp.ontap collection (version 21.4.0).
To install it use: ansible-galaxy collection install netapp.ontap
.
To use it in a playbook, specify: netapp.ontap.na_ontap_iscsi_security
.
New in version 19.10.1: of netapp.ontap
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 |
---|---|---|
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.
|
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.
|
|
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.
|
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 20.6.0 of netapp.ontap
|
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
string
|
Password for the specified user.
aliases: pass |
|
state
string
|
|
Whether the specified initiator 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
|
Name of the vserver to use.
|
Examples¶
- name: create
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
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
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) <ng-ansibleteam@netapp.com>