migrate module (ansible-collections#747)

Author: amitosw15

plugins/modules/win_product_facts.ps1

@@ -0,0 +1,106 @@
+#!powershell
+
+# Copyright: (c) 2017, Dag Wieers (@dagwieers) <dag@wieers.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+#AnsibleRequires -CSharpUtil Ansible.Basic
+
+# This modules does not accept any options
+$spec = @{
+    supports_check_mode = $true
+}
+
+$module = [Ansible.Basic.AnsibleModule]::Create($args, $spec)
+
+# First try to find the product key from ACPI
+try {
+    $product_key = (Get-CimInstance -Class SoftwareLicensingService).OA3xOriginalProductKey
+}
+catch {
+    $product_key = $null
+}
+
+if (-not $product_key) {
+    # Else try to get it from the registry instead
+    try {
+        $data = Get-ItemPropertyValue -LiteralPath "HKLM:\Software\Microsoft\Windows NT\CurrentVersion" -Name DigitalProductId
+    }
+    catch {
+        $data = $null
+    }
+
+    # And for Windows 2008 R2
+    if (-not $data) {
+        try {
+            $data = Get-ItemPropertyValue -LiteralPath "HKLM:\Software\Microsoft\Windows NT\CurrentVersion" -Name DigitalProductId4
+        }
+        catch {
+            $data = $null
+        }
+    }
+
+    if ($data) {
+        $product_key = $null
+        $isWin8 = [int]($data[66] / 6) -band 1
+        $HF7 = 0xF7
+        $data[66] = ($data[66] -band $HF7) -bOr (($isWin8 -band 2) * 4)
+        $hexdata = $data[52..66]
+        $chardata = "B", "C", "D", "F", "G", "H", "J", "K", "M", "P", "Q", "R", "T", "V", "W", "X", "Y", "2", "3", "4", "6", "7", "8", "9"
+
+        # Decode base24 binary data
+        for ($i = 24; $i -ge 0; $i--) {
+            $k = 0
+            for ($j = 14; $j -ge 0; $j--) {
+                $k = $k * 256 -bxor $hexdata[$j]
+                $hexdata[$j] = [math]::truncate($k / 24)
+                $k = $k % 24
+            }
+            $product_key_output = $chardata[$k] + $product_key_output
+            $last = $k
+        }
+
+        $product_key_tmp1 = $product_key_output.SubString(1, $last)
+        $product_key_tmp2 = $product_key_output.SubString(1, $product_key_output.Length - 1)
+        if ($last -eq 0) {
+            $product_key_output = "N" + $product_key_tmp2
+        }
+        else {
+            $product_key_output = $product_key_tmp2.Insert($product_key_tmp2.IndexOf($product_key_tmp1) + $product_key_tmp1.Length, "N")
+        }
+        $num = 0
+        $product_key_split = @()
+        for ($i = 0; $i -le 4; $i++) {
+            $product_key_split += $product_key_output.SubString($num, 5)
+            $num += 5
+        }
+        $product_key = $product_key_split -join "-"
+    }
+}
+
+# Retrieve license information
+$license_info = Get-CimInstance SoftwareLicensingProduct | Where-Object {
+    $product_key -match $_.PartialProductKey -and $_.Name -match "Windows"
+}
+$winlicense_status = switch ($license_info.LicenseStatus) {
+    0 { "Unlicensed" }
+    1 { "Licensed" }
+    2 { "OOBGrace" }
+    3 { "OOTGrace" }
+    4 { "NonGenuineGrace" }
+    5 { "Notification" }
+    6 { "ExtendedGrace" }
+    default { $null }
+}
+
+$winlicense_edition = $license_info.Name
+$winlicense_channel = $license_info.ProductKeyChannel
+
+$module.Result.ansible_facts = @{
+    ansible_os_product_id = (Get-CimInstance Win32_OperatingSystem).SerialNumber
+    ansible_os_product_key = $product_key
+    ansible_os_license_edition = $winlicense_edition
+    ansible_os_license_channel = $winlicense_channel
+    ansible_os_license_status = $winlicense_status
+}
+
+$module.ExitJson()

plugins/modules/win_product_facts.py

@@ -0,0 +1,62 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2017, Dag Wieers (@dagwieers) <dag@wieers.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+DOCUMENTATION = r'''
+---
+module: win_product_facts
+short_description: Provides Windows product and license information
+description:
+- Provides Windows product and license information.
+version_added: 2.7.0
+author:
+- Dag Wieers (@dagwieers)
+'''
+
+EXAMPLES = r'''
+- name: Get product id and product key
+  ansible.windows.win_product_facts:
+
+- name: Display Windows edition
+  debug:
+    var: ansible_os_license_edition
+
+- name: Display Windows license status
+  debug:
+    var: ansible_os_license_status
+'''
+
+RETURN = r'''
+ansible_facts:
+  description: Dictionary containing all the detailed information about the Windows product and license.
+  returned: always
+  type: complex
+  contains:
+    ansible_os_license_channel:
+      description: The Windows license channel.
+      returned: always
+      type: str
+      sample: Volume:MAK
+    ansible_os_license_edition:
+      description: The Windows license edition.
+      returned: always
+      type: str
+      sample: Windows(R) ServerStandard edition
+    ansible_os_license_status:
+      description: The Windows license status.
+      returned: always
+      type: str
+      sample: Licensed
+    ansible_os_product_id:
+      description: The Windows product ID.
+      returned: always
+      type: str
+      sample: 00326-10000-00000-AA698
+    ansible_os_product_key:
+      description: The Windows product key.
+      returned: always
+      type: str
+      sample: T49TD-6VFBW-VV7HY-B2PXY-MY47H
+'''

tests/integration/targets/win_product_facts/aliases

@@ -0,0 +1 @@
+shippable/windows/group1

tests/integration/targets/win_product_facts/tasks/main.yml

@@ -0,0 +1,11 @@
+# This file is part of Ansible
+
+# Copyright: (c) 2017, Dag Wieers (dagwieers) <dag@wieers.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+- win_product_facts:
+
+- assert:
+    that:
+    - ansible_os_product_id is defined
+    - ansible_os_product_key is defined