community.windows.win_disk_image_module.rst

community.windows.win_disk_image

Manage ISO/VHD/VHDX mounts on Windows hosts

• Synopsis
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Manages mount behavior for a specified ISO, VHD, or VHDX image on a Windows host. When state is present, the image will be mounted under a system-assigned drive letter, which will be returned in the mount_path value of the module result.
• Requires Windows 8+ or Windows Server 2012+.

Parameters

Parameter	Choices/Defaults	Comments
image_path string / required		Path to an ISO, VHD, or VHDX image on the target Windows host (the file cannot reside on a network share)
state string	Choices: absent present ←	Whether the image should be present as a drive-letter mount or not.

Examples

# Run installer from mounted ISO, then unmount
- name: Ensure an ISO is mounted
  community.windows.win_disk_image:
    image_path: C:\install.iso
    state: present
  register: disk_image_out

- name: Run installer from mounted ISO
  ansible.windows.win_package:
    path: '{{ disk_image_out.mount_paths[0] }}setup\setup.exe'
    product_id: 35a4e767-0161-46b0-979f-e61f282fee21
    state: present

- name: Unmount ISO
  community.windows.win_disk_image:
    image_path: C:\install.iso
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
mount_paths list	when state is present	A list of filesystem paths mounted from the target image. Sample: ['E:\\', 'F:\\']

Status

Authors

• Matt Davis (@nitzmahone)