MountImages.adoc

DSC Resource 'MountImages'

MountImages is used to mount or unmount an ISO/VHD disk image.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/MountImages
DSC Resource	StorageDSC
Documentation	MountImage

Table 1. Attributes of category 'MountImages'

Parameter	Attribute	DataType	Description	Allowed Values
Images	Mandatory	Hashtable[]	List of images to mount

Table 2. Attributes of category 'MountImages/Images'

Parameter	Attribute	DataType	Description	Allowed Values
ImagePath	Key	String	Specifies the path of the VHD or ISO file.
DriveLetter		String	Specifies the drive letter to mount this VHD or ISO to.
StorageType		String	Specifies the storage type of a file. If the StorageType parameter is not specified, then the storage type is determined by file extension.	ISO VHD VHDx VHDSet
Access		String	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.	ReadOnly (default) ReadWrite
Ensure		String	Determines whether the VHD or ISO should be mounted or not.	Present (default) Absent

Example

MountImages:
  Images:
    - ImagePath: C:\ISO\Test.iso
      DriveLetter: F
      StorageType: ISO
      Access: ReadOnly
      Ensure: Present
    - ImagePath: C:\VHD\Test.vhd
      DriveLetter: G
      StorageType: VHDx
      Access: ReadWrite
    - ImagePath: C:\ISO\Test2.iso