From a5edd6e635afdf9255a81dacc1772c13ae967acd Mon Sep 17 00:00:00 2001 From: Matt Davis Date: Wed, 1 Mar 2017 16:31:01 -0800 Subject: [PATCH] initial commit of win_disk_image (#22175) --- CHANGELOG.md | 1 + .../modules/windows/win_disk_image.ps1 | 91 +++++++++++++++++++ lib/ansible/modules/windows/win_disk_image.py | 76 ++++++++++++++++ 3 files changed, 168 insertions(+) create mode 100644 lib/ansible/modules/windows/win_disk_image.ps1 create mode 100644 lib/ansible/modules/windows/win_disk_image.py diff --git a/CHANGELOG.md b/CHANGELOG.md index bbff183a07e..b29ef21556e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -262,6 +262,7 @@ Ansible Changes By Release - system * parted - windows: + * win_disk_image * win_dns_client * win_domain_membership * win_find diff --git a/lib/ansible/modules/windows/win_disk_image.ps1 b/lib/ansible/modules/windows/win_disk_image.ps1 new file mode 100644 index 00000000000..76b04e572e4 --- /dev/null +++ b/lib/ansible/modules/windows/win_disk_image.ps1 @@ -0,0 +1,91 @@ +#!powershell + +# (c) 2017, Red Hat, Inc. +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . + +# POWERSHELL_COMMON +# WANT_JSON + +$ErrorActionPreference = "Stop" +Set-StrictMode -Version 2 + +If(-not (Get-Command Get-DiskImage -ErrorAction SilentlyContinue)) { + Fail-Json -message "win_disk_image requires Windows 8+ or Windows Server 2012+" +} + +$parsed_args = Parse-Args $args -supports_check_mode $true + +$result = @{changed=$false} + +$image_path = Get-AnsibleParam $parsed_args "image_path" -failifempty $result +$state = Get-AnsibleParam $parsed_args "state" -default "present" -validateset "present","absent" +$check_mode = Get-AnsibleParam $parsed_args "_ansible_check_mode" -default $false + +$di = Get-DiskImage $image_path + +If($state -eq "present") { + If(-not $di.Attached) { + $result.changed = $true + + If(-not $check_mode) { + $di = Mount-DiskImage $image_path -PassThru + + # the actual mount is async, so the CIMInstance result may not immediately contain the data we need + $retry_count = 0 + While(-not $di.Attached -and $retry_count -lt 5) { + Sleep -Seconds 1 | Out-Null + $di = $di | Get-DiskImage + $retry_count++ + } + + If(-not $di.Attached) { + Fail-Json $result -message "Timed out waiting for disk to attach" + } + } + } + + # FUTURE: detect/handle "ejected" ISOs + # FUTURE: support explicit drive letter and NTFS in-volume mountpoints. + # VHDs don't always auto-assign, and other system settings can prevent automatic assignment + + If($di.Attached) { # only try to get the mount_path if the disk is attached ( + If($di.StorageType -eq 1) { # ISO, we can get the mountpoint directly from Get-Volume + $drive_letter = ($di | Get-Volume).DriveLetter + } + ElseIf($di.StorageType -in @(2,3)) { # VHD/VHDX, need Get-Disk + Get-Partition to discover mountpoint + # FUTURE: support multi-partition VHDs + $drive_letter = ($di | Get-Disk | Get-Partition)[0].DriveLetter + } + + + If(-not $drive_letter) { + Fail-Json -message "Unable to retrieve drive letter from mounted image" + } + + $result.mount_path = $drive_letter + ":\" + } +} +ElseIf($state -eq "absent") { + If($di.Attached) { + $result.changed = $true + If(-not $check_mode) { + Dismount-DiskImage $image_path | Out-Null + } + } +} + +Exit-Json $result \ No newline at end of file diff --git a/lib/ansible/modules/windows/win_disk_image.py b/lib/ansible/modules/windows/win_disk_image.py new file mode 100644 index 00000000000..3b17776ee2b --- /dev/null +++ b/lib/ansible/modules/windows/win_disk_image.py @@ -0,0 +1,76 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# (c) 2017, Red Hat, Inc. +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . + +ANSIBLE_METADATA = {'status': ['preview'], + 'supported_by': 'core', + 'version': '1.0'} + +DOCUMENTATION=''' +module: win_disk_image +short_description: Manage ISO/VHD/VHDX mounts on Windows hosts +version_added: 2.3 +description: + - Manages mount behavior for a specified ISO, VHD, or VHDX image on a Windows host. When C(state) is C(present), + the image will be mounted under a system-assigned drive letter, which will be returned in the C(mount_path) value + of the module result. Requires Windows 8+ or Windows Server 2012+. +options: + image_path: + description: + - path to an ISO, VHD, or VHDX image on the target Windows host (the file cannot reside on a network share) + required: true + state: + description: + - whether the image should be present as a drive-letter mount or not. + choices: + - present + - absent + default: present +author: + - Matt Davis (@nitzmahone) +''' + +RETURN=r''' +mount_path: + description: filesystem path where the target image is mounted + returned: when C(state) is C(present) + type: string + sample: F:\ +''' + +EXAMPLES=r''' +# ensure an iso is mounted +- win_disk_image: + image_path: C:\install.iso + state: present + register: disk_image_out + +# run installer from mounted iso +- win_package: + path: '{{ disk_image_out.mount_path }}setup\setup.exe' + product_id: '35a4e767-0161-46b0-979f-e61f282fee21' + state: present + +# unmount iso +- win_disk_image: + image_path: C:\install.iso + state: absent + +''' +