Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0 < 8.0.0
Start using this module
Add this module to your Puppetfile:
mod 'dsc-storagedsc', '5.0.1-0-2'
Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
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 v5.0.1. The PowerShell module describes itself like this:
DSC resources for managing storage on Windows Servers.
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:
- Problems with the way the underlying DSC resource works.
- Problems with the type definition, where you can't specify a valid set of properties for the DSC resource
- 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.
Reference
Table of Contents
Resource types
dsc_disk
: The DSC Disk resource type. Automatically generated from version 5.0.1dsc_diskaccesspath
: The DSC DiskAccessPath resource type. Automatically generated from version 5.0.1dsc_mountimage
: The DSC MountImage resource type. Automatically generated from version 5.0.1dsc_opticaldiskdriveletter
: The DSC OpticalDiskDriveLetter resource type. Automatically generated from version 5.0.1dsc_waitfordisk
: The DSC WaitForDisk resource type. Automatically generated from version 5.0.1dsc_waitforvolume
: The DSC WaitForVolume resource type. Automatically generated from version 5.0.1
Resource types
dsc_disk
The DSC Disk resource type. Automatically generated from version 5.0.1
Properties
The following properties are available in the dsc_disk
type.
dsc_allocationunitsize
Data type: Optional[Integer[0, 4294967295]]
Specifies the allocation unit size to use when formatting the volume.
dsc_allowdestructive
Data type: Optional[Boolean]
Specifies if potentially destructive operations may occur.
dsc_cleardisk
Data type: Optional[Boolean]
Specifies if the disks partition schema should be removed entirely, even if data and OEM partitions are present. Only possible with AllowDestructive enabled.
dsc_diskid
Data type: String
Specifies the disk identifier for the disk to modify.
dsc_diskidtype
Data type: Optional[Enum['Number', 'UniqueId', 'Guid', 'Location']]
Specifies the identifier type the DiskId contains. Defaults to Number.
dsc_fsformat
Data type: Optional[Enum['NTFS', 'ReFS']]
Specifies the file system format of the new volume.
dsc_fslabel
Data type: Optional[String]
Define volume label if required.
dsc_partitionstyle
Data type: Optional[Enum['MBR', 'GPT']]
Specifies the partition style of the disk. Defaults to GPT.
dsc_size
Data type: Optional[Integer[0, 18446744073709551615]]
Specifies the size of new volume. Leave empty to use the remaining free space.
Parameters
The following parameters are available in the dsc_disk
type.
dsc_driveletter
namevar
Data type: String
Specifies the identifier for which disk to modify.
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_diskaccesspath
The DSC DiskAccessPath resource type. Automatically generated from version 5.0.1
Properties
The following properties are available in the dsc_diskaccesspath
type.
dsc_allocationunitsize
Data type: Optional[Integer[0, 4294967295]]
Specifies the allocation unit size to use when formatting the volume.
dsc_diskid
Data type: String
Specifies the disk identifier for the disk to modify.
dsc_diskidtype
Data type: Optional[Enum['Number', 'UniqueId', 'Guid', 'Location']]
Specifies the identifier type the DiskId contains. Defaults to Number.
dsc_fsformat
Data type: Optional[Enum['NTFS', 'ReFS']]
Specifies the file system format of the new volume.
dsc_fslabel
Data type: Optional[String]
Define volume label if required.
dsc_nodefaultdriveletter
Data type: Optional[Boolean]
Specifies no automatic drive letter assignment to the partition: Defaults to True
dsc_size
Data type: Optional[Integer[0, 18446744073709551615]]
Specifies the size of new volume.
Parameters
The following parameters are available in the dsc_diskaccesspath
type.
dsc_accesspath
namevar
Data type: String
Specifies the access path folder to the assign the disk volume to.
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_mountimage
The DSC MountImage resource type. Automatically generated from version 5.0.1
Properties
The following properties are available in the dsc_mountimage
type.
dsc_access
Data type: Optional[Enum['ReadOnly', 'ReadWrite']]
Allows a VHD file to be mounted in read-only or read-write mode. ISO files are mounted in read-only mode regardless of what parameter value you provide.
dsc_driveletter
Data type: Optional[String]
Specifies the drive letter to mount this VHD or ISO to.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Determines whether the VHD or ISO should be mounted or not.
dsc_storagetype
Data type: Optional[Enum['ISO', 'VHD', 'VHDx', 'VHDSet']]
Specifies the storage type of a file. If the StorageType parameter is not specified, then the storage type is determined by file extension.
Parameters
The following parameters are available in the dsc_mountimage
type.
dsc_imagepath
namevar
Data type: String
Specifies the path of the VHD or ISO file.
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_opticaldiskdriveletter
The DSC OpticalDiskDriveLetter resource type. Automatically generated from version 5.0.1
Properties
The following properties are available in the dsc_opticaldiskdriveletter
type.
dsc_driveletter
Data type: String
Specifies the drive letter to assign to the optical disk. Can be a single letter, optionally followed by a colon. This value is ignored if Ensure is set to Absent.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Determines whether a drive letter should be assigned to the optical disk. Defaults to 'Present'.
Parameters
The following parameters are available in the dsc_opticaldiskdriveletter
type.
dsc_diskid
namevar
Data type: String
Specifies the optical disk number for the disk to assign the drive letter to.
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_waitfordisk
The DSC WaitForDisk resource type. Automatically generated from version 5.0.1
Properties
The following properties are available in the dsc_waitfordisk
type.
dsc_diskidtype
Data type: Optional[Enum['Number', 'UniqueId', 'Guid', 'Location']]
Specifies the identifier type the DiskId contains. Defaults to Number.
dsc_isavailable
Data type: Optional[Boolean]
Will indicate whether Disk is available.
dsc_retrycount
Data type: Optional[Integer[0, 4294967295]]
The number of times to loop the retry interval while waiting for the disk.
dsc_retryintervalsec
Data type: Optional[Integer[0, 4294967295]]
Specifies the number of seconds to wait for the disk to become available.
Parameters
The following parameters are available in the dsc_waitfordisk
type.
dsc_diskid
namevar
Data type: String
Specifies the disk identifier for the disk to wait for.
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_waitforvolume
The DSC WaitForVolume resource type. Automatically generated from version 5.0.1
Properties
The following properties are available in the dsc_waitforvolume
type.
dsc_retrycount
Data type: Optional[Integer[0, 4294967295]]
The number of times to loop the retry interval while waiting for the volume.
dsc_retryintervalsec
Data type: Optional[Integer[0, 4294967295]]
Specifies the number of seconds to wait for the volume to become available.
Parameters
The following parameters are available in the dsc_waitforvolume
type.
dsc_driveletter
namevar
Data type: String
Specifies the drive letter of the volume to wait for.
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.
[5.0.1] - 2020-08-03
Changed
- Fixed build failures caused by changes in
ModuleBuilder
module v1.7.0 by changingCopyDirectories
toCopyPaths
- Fixes Issue #237. - Updated to use the common module DscResource.Common - Fixes Issue #234.
- Pin
Pester
module to 4.10.1 because Pester 5.0 is missing code coverage - Fixes Issue #238. - OpticalDiskDriveLetter:
- Removed integration test that tests when a disk is not in the system as it is not a useful test, does not work correctly and is covered by unit tests - Fixes Issue #240.
- StorageDsc
- Automatically publish documentation to GitHub Wiki - Fixes Issue #241.
Fixed
- Disk:
- Fix bug when multiple partitions with the same drive letter are reported by the disk subsystem - Fixes Issue #210.
Dependencies
- puppetlabs/pwshlib (>= 0.7.0 < 2.0.0)