Table of Contents

1. Description
2. Requirements
3. Usage
4. Troubleshooting

Description

This is an auto-generated module, using the Puppet DSC Builder to vendor and expose the PowerShell module's DSC resources as Puppet resources. The functionality of this module comes entirely from the vendored PowerShell resources, which are pinned at v2.0.0. The PowerShell module describes itself like this:

DSC resources for configuring Windows iSCSI Targets and Initiators.

For information on troubleshooting to determine whether any encountered problems are with the Puppet wrapper or the DSC resource, see the troubleshooting section below.

Requirements

This module, like all auto-generated Puppetized DSC modules, relies on two important technologies in the Puppet stack: the Puppet Resource API and the puppetlabs/pwshlib Puppet module.

The Resource API provides a simplified option for writing types and providers and is responsible for how this module is structured. The Resource API ships inside of Puppet starting with version 6. While it is technically possible to add the Resource API functionality to Puppet 5.5.x, the DSC functionality has not been tested in this setup. For more information on the Resource API, review the documentation.

The module also depends on the pwshlib module. This Puppet module includes two important things: the ruby-pwsh library for running PowerShell code from ruby and the base provider for DSC resources, which this module leverages.

All of the actual work being done to call the DSC resources vendored with this module is in this file from the pwshlib module. This is important for troubleshooting and bug reporting, but doesn't impact your use of the module except that the end result will be that nothing works, as the dependency is not installed alongside this module!

Usage

You can specify any of the DSC resources from this module like a normal Puppet resource in your manifests. The examples below use DSC resources from from the PowerShellGet repository, regardless of what module you're looking at here; the syntax, not the specifics, is what's important.

For reference documentation about the DSC resources exposed in this module, see the Reference Forge tab, or the REFERENCE.md file.

# Include a meaningful title for your resource declaration
dsc_psrepository { 'Add team module repo':
    dsc_name               => 'foo',
    dsc_ensure             => present,
    # This location is nonsense, can be any valid folder on your
    # machine or in a share, any location the SourceLocation param
    # for the DSC resource will accept.
    dsc_sourcelocation     => 'C:\Program Files',
    # You must always pass an enum fully lower-cased;
    # Puppet is case sensitive even when PowerShell isn't
    dsc_installationpolicy => untrusted,
}

dsc_psrepository { 'Trust public gallery':
    dsc_name               => 'PSGallery',
    dsc_ensure             => present,
    dsc_installationpolicy => trusted,
}

dsc_psmodule { 'Make Ruby manageable via uru':
  dsc_name   => 'RubyInstaller',
  dsc_ensure => present,
}

For more information about using a built module, check out our narrative documentation.

Properties

Note that the only properties specified in a resource declaration which are passed to Invoke-Dsc are all prepended with dsc. If a property does _not start with dsc_ it is used to control how Puppet interacts with DSC/other Puppet resources - for example, specifying a unique name for the resource for Puppet to distinguish between declarations or Puppet metaparameters (notifies, before, etc).

Troubleshooting

In general, there are three broad categories of problems:

1. Problems with the way the underlying DSC resource works.
2. Problems with the type definition, where you can't specify a valid set of properties for the DSC resource
3. Problems with calling the underlying DSC resource - the parameters aren't being passed correctly or the resource can't be found

Unfortunately, problems with the way the underlying DSC resource works are something we can't help directly with. You'll need to file an issue with the upstream maintainers for the PowerShell module.

Problems with the type definition are when a value that should be valid according to the DSC resource's documentation and code is not accepted by the Puppet wrapper. If and when you run across one of these, please file an issue with the Puppet DSC Builder; this is where the conversion happens and once we know of a problem we can fix it and regenerate the Puppet modules. To help us identify the issue, please specify the DSC module, version, resource, property and values that are giving you issues. Once a fix is available we will regenerate and release updated versions of this Puppet wrapper.

Problems with calling the underlying DSC resource become apparent by comparing <value passed in in puppet> with <value received by DSC>. In this case, please file an issue with the puppetlabs/pwshlib module, which is where the DSC base provider actually lives. We'll investigate and prioritize a fix and update the puppetlabs/pwshlib module. Updating to the pwshlib version with the fix will immediately take advantage of the improved functionality without waiting for this module to be reconverted and published.

For specific information on troubleshooting a generated module, check the troubleshooting guide for the puppet.dsc module.

Known Limitations

Currently, because of the way Puppet caches files on agents, use of the legacy puppetlabs-dsc module is not compatible with this or any auto-generated DSC module. Inclusion of both will lead to pluginsync conflicts.

Source

This is a fork of https://forge.puppet.com/modules/dsc/iscsidsc This project is temporary until changes will be included in the default icsci dsc module

Reference

Table of Contents

Resource types

• dsc_iscsiinitiator: The DSC iSCSIInitiator resource type. Automatically generated from version 2.0.0
• dsc_iscsiservertarget: The DSC iSCSIServerTarget resource type. Automatically generated from version 2.0.0
• dsc_iscsivirtualdisk: The DSC iSCSIVirtualDisk resource type. Automatically generated from version 2.0.0

Resource types

dsc_iscsiinitiator

The DSC iSCSIInitiator resource type. Automatically generated from version 2.0.0

Properties

The following properties are available in the dsc_iscsiinitiator type.

dsc_authenticationtype

Data type: Optional[Enum['None', 'OneWayCHAP', 'MutualCHAP']]

Specifies the type of authentication to use when logging into the target.

dsc_chapsecret

Data type: Optional[String]

Specifies the CHAP secret to use when establishing a connection authenticated by using CHAP.

dsc_chapusername

Data type: Optional[String]

Specifies the user name to use when establishing a connection authenticated by using Mutual CHAP.

dsc_connectionidentifier

Data type: Optional[String]

This is the current connection identifier for this target connection.

dsc_ensure

Data type: Optional[Enum['Present', 'Absent']]

Ensures that Target is Absent or Present.

dsc_initiatorinstancename

Data type: Optional[String]

The name of the initiator instance that the iSCSI initiator service uses to send SendTargets requests to the target portal.

dsc_initiatornodeaddress

Data type: Optional[String]

The Initiator Node address assigned to this session.

dsc_initiatorportaladdress

Data type: Optional[String]

Specifies the IP address associated with the target portal.

dsc_isconnected

Data type: Optional[Boolean]

Is the target connected to the server.

dsc_isdatadigest

Data type: Optional[Boolean]

Enables data digest when the initiator logs into the target portal.

dsc_isdiscovered

Data type: Optional[Boolean]

Is the target discovered in this session.

dsc_isheaderdigest

Data type: Optional[Boolean]

Enables header digest when the initiator logs into the target portal. By not specifying this parameter, the digest setting is determined by the initiator kernel mode driver.

dsc_ismultipathenabled

Data type: Optional[Boolean]

Indicates that the initiator has enabled Multipath I/O (MPIO) and it will be used when logging into the target portal.

dsc_isnsserver

Data type: Optional[String]

Specifies the name of an iSNS Server to register this Initiator with.

dsc_ispersistent

Data type: Optional[Boolean]

Specifies that the session is to be automatically connected after each restart.

dsc_reporttopnp

Data type: Optional[Boolean]

Specifies that the operation is reported to PNP.

dsc_sessionidentifier

Data type: Optional[String]

This is the current session identifier for this target session.

dsc_targetnodeaddress

Data type: Optional[String]

The Target Node address assigned to this session.

dsc_targetportaladdress

Data type: String

Specifies the IP address or DNS name of the target portal.

dsc_targetportalportnumber

Data type: Optional[Integer[0, 65535]]

Specifies the TCP/IP port number for the target portal.

Parameters

The following parameters are available in the dsc_iscsiinitiator type.

dsc_nodeaddress

namevar

Data type: String

Represents the IQN of the discovered target.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

dsc_iscsiservertarget

The DSC iSCSIServerTarget resource type. Automatically generated from version 2.0.0

Properties

The following properties are available in the dsc_iscsiservertarget type.

dsc_ensure

Data type: Optional[Enum['Present', 'Absent']]

Ensures that Server Target is either Absent or Present.

dsc_initiatorids

Data type: Array[String]

Specifies the iSCSI initiator identifiers (IDs) to which the iSCSI target is assigned.

dsc_isnsserver

Data type: Optional[String]

Specifies the name of an iSNS Server to register this Server Target with.

dsc_paths

Data type: Array[String]

Specifies the path of the virtual hard disk (VHD) files that are associated with the Server Target.

Parameters

The following parameters are available in the dsc_iscsiservertarget type.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_targetname

namevar

Data type: String

Specifies the name of the iSCSI target.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

dsc_iscsivirtualdisk

The DSC iSCSIVirtualDisk resource type. Automatically generated from version 2.0.0

Properties

The following properties are available in the dsc_iscsivirtualdisk type.

dsc_blocksizebytes

Data type: Optional[Integer[0, 4294967295]]

Specifies the block size, in bytes, for the VHDX.

dsc_description

Data type: Optional[String]

Specifies the description for the iSCSI virtual disk.

dsc_disktype

Data type: Optional[Enum['Dynamic', 'Fixed', 'Differencing']]

Specifies the type of the VHDX.

dsc_ensure

Data type: Optional[Enum['Present', 'Absent']]

Ensures that Virtual Disk is either Absent or Present.

dsc_logicalsectorsizebytes

Data type: Optional[Enum['512', '4096']]

Specifies the logical sector size, in bytes, for the VHDX.

dsc_parentpath

Data type: Optional[String]

Specifies the parent virtual disk path if the VHDX is a differencing disk.

dsc_physicalsectorsizebytes

Data type: Optional[Enum['512', '4096']]

Specifies the physical sector size, in bytes, for the VHDX.

dsc_sizebytes

Data type: Optional[Integer[0, 18446744073709551615]]

Specifies the size, in bytes, of the iSCSI virtual disk.

Parameters

The following parameters are available in the dsc_iscsivirtualdisk type.

dsc_path

namevar

Data type: String

Specifies the path of the VHDX file that is associated with the iSCSI virtual disk.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

Changelog

All notable changes to this project will be documented in this file.

Release 1.0.2 (2025-01-02)

Full Changelog

Features

• Code cleaning

Bugfixes

Known Issues

[1.0.1] - 2021-01-21

Changed

• Transferred ownership to DSCCommunity.org - Fixes Issue #50.
• Fix hash table style guideline violations.
• Added .gitattributes file to fix bug publishing examples - Fixes Issue #40.
• Opted into Common Tests 'Common Tests - Validate Localization' - Fixes Issue #44.
• Renamed iSCSIDsc.ResourceHelpers module to iSCSIDsc.Common to align to other modules.
• Renamed all localization strings so that they are detected by 'Common Tests - Validate Localization'.
• Fixed issues with mismatched localization strings.
• Replaced iSCSIDsc.Common module with the latest version from DSCResource.Template.
• Fix minor style issues in statement case.
• Fix minor style issues in hashtable layout.
• Correct other minor style issues.
• Enabled PSSA rule violations to fail build - Fixes Issue #27.
• Updated tests to meet Pester v4 standard.
• Added Open Code of Conduct.
• Refactored module folder structure to move resource to root folder of repository and remove test harness - Fixes Issue #36.
• Converted Examples to support format for publishing to PowerShell Gallery.
• Opted into common tests:
  • Common Tests - Validate Example Files To Be Published
  • Common Tests - Validate Markdown Links
  • Common Tests - Relative Path Length
  • Common Tests - Relative Path Length
• Update to new format LICENSE.
• Added .VSCode settings for applying DSC PSSA rules - fixes Issue #37.
• BREAKING CHANGE: Changed resource prefix from MSFT to DSC.
• Updated to use continuous delivery pattern using Azure DevOps - fixes Issue #52.
• Update build badges in README.md with correct build IDs.
• Removed unused test helper function New-VDisk.
• Added test helper function Assert-CanRunIntegrationTest to validate if integration tests can be successfully run on a machine.
• Fixed build failures caused by changes in ModuleBuilder module v1.7.0 by changing CopyDirectories to CopyPaths - Fixes Issue #58.
• Updated to use the common module DscResource.Common - Fixes Issue #53.
• Pin Pester module to 4.10.1 because Pester 5.0 is missing code coverage - Fixes Issue #60.
• Automatically publish documentation to GitHub Wiki - Fixes Issue #61.
• Renamed master branch to main - Fixes Issue #63.