Resource Type: dsc_iscsiinitiator

Defined in:

lib/puppet/type/dsc_iscsiinitiator.rb

Providers:

powershell

Overview

The DSC iSCSIInitiator resource type. Automatically generated from ‘iSCSIDsc/DSCResources/DSR_iSCSIInitiator/DSR_iSCSIInitiator.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_authenticationtype

  AuthenticationType - Specifies the type of authentication to use when logging into the target. Valid values are None, OneWayCHAP, MutualCHAP.

• dsc_chapsecret

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

• dsc_chapusername

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

• dsc_connectionidentifier

  ConnectionIdentifier - This is the current connection identifier for this target connection.

• dsc_ensure

  Ensure - Ensures that Target is Absent or Present. Valid values are Present, Absent.

• dsc_initiatorinstancename

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

• dsc_initiatornodeaddress

  InitiatorNodeAddress - The Initiator Node address assigned to this session.

• dsc_initiatorportaladdress

  InitiatorPortalAddress - Specifies the IP address associated with the target portal.

• dsc_isconnected

  IsConnected - Is the target connected to the server.

  Supported values:

  • true
  • false
• dsc_isdatadigest

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

  Supported values:

  • true
  • false
• dsc_isdiscovered

  IsDiscovered - Is the target discovered in this session.

  Supported values:

  • true
  • false
• dsc_isheaderdigest

  IsHeaderDigest - 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.

  Supported values:

  • true
  • false
• dsc_ismultipathenabled

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

  Supported values:

  • true
  • false
• dsc_isnsserver

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

• dsc_ispersistent

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

  Supported values:

  • true
  • false
• dsc_nodeaddress

  NodeAddress - Represents the IQN of the discovered target.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_reporttopnp

  ReportToPnP - Specifies that the operation is reported to PNP.

  Supported values:

  • true
  • false
• dsc_sessionidentifier

  SessionIdentifier - This is the current session identifier for this target session.

• dsc_targetnodeaddress

  TargetNodeAddress - The Target Node address assigned to this session.

• dsc_targetportaladdress

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

• dsc_targetportalportnumber

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

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_iscsiinitiator` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.