Forge Home

iscsi

A package for managing iscsi initiators

12,076 downloads

12,076 latest version

3.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.1.0 (latest)
released Jul 26th 2015
This version is compatible with:
  • RedHat, CentOS, Debian, Ubuntu

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'tedivm-iscsi', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add tedivm-iscsi
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install tedivm-iscsi --version 0.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: iscsi

Documentation

tedivm/iscsi — version 0.1.0 Jul 26th 2015

iscsi

Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Reference
  6. Limitations
  7. Development

Overview

This module manages the iscsi service on Debian and Redhat family nodes.

Module Description

This module installs and configures the iscsi packages (Redhat's iscsid or Debian's open-iscsi) and manages it's configuration. This allows nodes to connect to iscsi servers, such as the AWS Storage Gateway.

Setup

What iscsi affects

  • This module manages the iscsi configuration and ensures it's service is running.
  • A new fact, "iscsi_initiator", exposes the unique identifier for the iscsi node.

Setup Requirements

In order to use the bundled fact you need to have pluginsync enabled.

Usage

The simplest way to use this module is to include the iscsi::initiator class.

include iscsi::initiator

This class also supports a variety of options, such as CHAP authentication.

class { 'iscsi::initiator':
  startup => "automatic",

  node_authmethod => 'CHAP'
  node_username => 'iqn.1993-08.org.debian:01:3181f68bc3dd',
  node_password => 'jXb8F5uR22KhpJkFTTTYtA',
  node_username_in => $::iscsi_initiator,
  node_password_in => 'C9LbgUQGAXGuv4bEjGxgYt',
}

Reference

Facts

  • [iscsi_initiator] This fact gives the initiator name (ie, "iqn.1993-08.org.debian:01:3181f68bc3dd"). It's important to note that this fact returns false during the first run where the module is installed as the iqn is created when the package is installed, after facts are evaluated.

classes

iscsi::initiator

  • [node_authmethod] - ISCSI authentication method. Defaults to false.

  • [node_username] - Username server uses to authenticate to client. Defaults to false.

  • [node_password] - Password server uses to authenticate to client. Defaults to false.

  • [node_username_in] - Username client uses to authenticate to server. Defaults to false.

  • [node_password_in] - Password client uses to authenticate to server. Defaults to false.

  • [discovery_authmethod] - ISCSI authentication method. Defaults to false.

  • [discovery_username] - Node (server) username for discovery. Defaults to false.

  • [discovery_password] - Node (server) username for discovery. Defaults to false.

  • [discovery_username_in] - Initiator (client) username for discovery. Defaults to false.

  • [discovery_password_in] - Initiator (client) username for discovery. Defaults to false.

  • [startup] - Whether to use automatic or manual startup. Defaults to manual.

  • [leading_login] - Whether to login to targets one at a time (true) or to attempt each connection (false). Defaults to true.

  • [replacement_timeout] - Defaults to 120.

  • [login_timeout] - Defaults to 15.

  • [logout_timeout] - Defaults to 15.

  • [noop_out_interval] - Defaults to 5.

  • [noop_out_timeout] - Defaults to 5.

  • [abort_timeout] - Defaults to 15.

  • [lu_reset_timeout] - Defaults to 30.

  • [tgt_reset_timeout] - Defaults to 30.

  • [initial_login_retry_max] - Defaults to 8.

  • [session_cmds_max] - Defaults to 128.

  • [session_queue_depth] - Defaults to 32.

  • [xmit_thread_priority] - Defaults to -20.

  • [initialR2T] - Defaults to false.

  • [immediateData] - Defaults to true.

  • [firstBurstLength] - Defaults to 262144.

  • [maxBurstLength] - Defaults to 16776192.

  • [maxRecvDataSegmentLength] - Defaults to 262144.

  • [maxXmitDataSegmentLength] - Defaults to 0.

  • [headerDigest] - Defaults to "None".

  • [dataDigest] - Defaults to "None"

  • [nr_sessions] - Defaults to 1.

  • [MaxRecvDataSegmentLength] - Defaults to 32768.

  • [fastAbort] - Defaults to true.

  • [iscsid_conf] - Defaults to "/etc/iscsi/iscsid.conf".

  • [iscsid_startup] - Sets the restart script for the service. The default depends on the operating system.

Limitations

This module currently handles installation and services, but does not yet provide functionality to mount the specific drives. This has to be done manually using iscsiadm.

Development

Contributions are always welcome. Please read the Contributing Guide to get started.