community.windows.win_disk_image module – Manage ISO/VHD/VHDX mounts on Windows hosts
Note
This module is part of the community.windows collection (version 2.3.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.windows
.
To use it in a playbook, specify: community.windows.win_disk_image
.
Synopsis
Manages mount behavior for a specified ISO, VHD, or VHDX image on a Windows host. When
state
ispresent
, the image will be mounted under a system-assigned drive letter, which will be returned in themount_path
value of the module result.Requires Windows 8+ or Windows Server 2012+.
Parameters
Parameter |
Comments |
---|---|
Path to an ISO, VHD, or VHDX image on the target Windows host (the file cannot reside on a network share) |
|
Whether the image should be present as a drive-letter mount or not. Choices:
|
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 |
Description |
---|---|
A list of filesystem paths mounted from the target image. Returned: when Sample: |