community.general.open_iscsi module – Manage iSCSI targets with Open-iSCSI
Note
This module is part of the community.general collection (version 8.6.4).
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 community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.open_iscsi
.
Synopsis
Discover targets on given portal, (dis)connect targets, mark targets to manually or auto start, return device nodes of connected targets.
Aliases: system.open_iscsi
Requirements
The below requirements are needed on the host that executes this module.
open_iscsi library and tools (iscsiadm)
Parameters
Parameter |
Comments |
---|---|
Whether the target node should be automatically connected at startup. Choices:
|
|
Whether the target node portal should be automatically connected at startup. Choices:
|
|
Whether the list of target nodes on the portal should be (re)discovered and added to the persistent iSCSI database. Keep in mind that Choices:
|
|
Whether the target node should be connected. Choices:
|
|
The value for Default: |
|
The value for |
|
The value for |
|
The value for |
|
The value for |
|
The port on which the iSCSI target process listens. Default: |
|
The domain name or IP address of the iSCSI target. |
|
Rescan an established session for discovering new targets. When Choices:
|
|
Whether the list of nodes in the persistent iSCSI database should be returned by the module. Choices:
|
|
The iSCSI target name. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Perform a discovery on sun.com and show available target nodes
community.general.open_iscsi:
show_nodes: true
discover: true
portal: sun.com
- name: Perform a discovery on 10.1.2.3 and show available target nodes
community.general.open_iscsi:
show_nodes: true
discover: true
ip: 10.1.2.3
# NOTE: Only works if exactly one target is exported to the initiator
- name: Discover targets on portal and login to the one available
community.general.open_iscsi:
portal: '{{ iscsi_target }}'
login: true
discover: true
- name: Connect to the named target, after updating the local persistent database (cache)
community.general.open_iscsi:
login: true
target: iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d
- name: Disconnect from the cached named target
community.general.open_iscsi:
login: false
target: iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d
- name: Override and disable automatic portal login on specific portal
community.general.open_iscsi:
login: false
portal: 10.1.1.250
auto_portal_startup: false
target: iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d
- name: Rescan one or all established sessions to discover new targets (omit target for all sessions)
community.general.open_iscsi:
rescan: true
target: iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d