Documentation

open_iscsi - Manage iscsi targets with open-iscsi

New in version 1.4.

Synopsis

Discover targets on given portal, (dis)connect targets, mark targets to manually or auto start, return device nodes of connected targets.

Requirements (on host that executes module)

  • open_iscsi library and tools (iscsiadm)

Options

parameter required default choices comments
auto_node_startup
 no
  • True
  • False
whether the target node should be automatically connected at startup

aliases: automatic
discover
 no
  • True
  • False
whether the list of target nodes on the portal should be (re)discovered and added to the persistent iscsi database. Keep in mind that iscsiadm discovery resets configurtion, like node.startup to manual, hence combined with auto_node_startup=yes will allways return a changed state.
login
 no
  • True
  • False
whether the target node should be connected
node_auth
 no CHAP
    discovery.sendtargets.auth.authmethod
    node_pass
    		 no
      discovery.sendtargets.auth.password
      node_user
      		 no
        discovery.sendtargets.auth.username
        port
        		 no 3260
          the port on which the iscsi target process listens
          portal
          		 no
            the ip address of the iscsi target

            aliases: ip
            show_nodes
            		 no
            • True
            • False
            whether the list of nodes in the persistent iscsi database should be returned by the module
            target
            		 no
              the iscsi target name

              aliases: name, targetname

              Examples

              # perform a discovery on 10.1.2.3 and show available target nodes
- open_iscsi: show_nodes=yes discover=yes portal=10.1.2.3

# discover targets on portal and login to the one available
# (only works if exactly one target is exported to the initiator)
- open_iscsi: portal={{iscsi_target}} login=yes discover=yes

# description: connect to the named target, after updating the local
# persistent database (cache)
- open_iscsi: login=yes target=iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d

# description: discconnect from the cached named target
- open_iscsi: login=no target=iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d"

              This is an Extras Module

              For more information on what this means please read Extras Modules

              For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.