Prepare for v1.9.0 release (#350)

ansible-collections · Dec 20, 2021 · 1f7d28e · 1f7d28e
1 parent 65ddb71
commit 1f7d28e
Show file tree

Hide file tree

Showing 13 changed files with 180 additions and 29 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,13 +5,32 @@ Community Windows Release Notes
 .. contents:: Topics
 
 
-v1.8.0
+v1.9.0
 ======
 
 Release Summary
 ---------------
 
-- Release summary for v1.8.0
+- Release summary for v1.9.0
+
+Minor Changes
+-------------
+
+- win_disk_facts - Added ``filter`` option to filter returned facts by type of disk information - https://github.com/ansible-collections/community.windows/issues/33
+- win_disk_facts - Converted from ``#Requires -Module Ansible.ModuleUtils.Legacy`` to ``#AnsibleRequires -CSharpUtil Ansible.Basic``
+- win_iis_virtualdirectory - Added the ``connect_as``, ``username``, and ``password`` options to control the virtual directory authentication - https://github.com/ansible-collections/community.windows/issues/346
+- win_power_plan - Added ``guid`` option to specify plan by a unique identifier - https://github.com/ansible-collections/community.windows/issues/310
+
+Bugfixes
+--------
+
+- win_domain_user - Module now properly captures and reports bad password - https://github.com/ansible-collections/community.windows/issues/316
+- win_domain_user - Module now reports user created and changed properly - https://github.com/ansible-collections/community.windows/issues/316
+- win_domain_user - The AD user's existing identity is searched using their sAMAccountName name preferentially and falls back to the provided name property instead - https://github.com/ansible-collections/community.windows/issues/344
+- win_iis_virtualdirectory - Fixed an issue where virtual directory information could not be obtained correctly when the parameter ``application`` was set
+
+v1.8.0
+======
 
 Minor Changes
 -------------

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -282,8 +282,6 @@ releases:
       - win_nssm - Remove deprecation for ``state``, ``dependencies``, ``user``, ``password``,
         ``start_mode``
       - win_nssm - Support gMSA accounts for ``user``
-      release_summary:
-      - Release summary for v1.8.0
     fragments:
     - 205-win_xml-warning.yml
     - 275-win_xml-verbose-removed.yml
@@ -299,3 +297,33 @@ releases:
       name: win_domain_ou
       namespace: ''
     release_date: '2021-11-03'
+  1.9.0:
+    changes:
+      bugfixes:
+      - win_domain_user - Module now properly captures and reports bad password -
+        https://github.com/ansible-collections/community.windows/issues/316
+      - win_domain_user - Module now reports user created and changed properly - https://github.com/ansible-collections/community.windows/issues/316
+      - win_domain_user - The AD user's existing identity is searched using their
+        sAMAccountName name preferentially and falls back to the provided name property
+        instead - https://github.com/ansible-collections/community.windows/issues/344
+      - win_iis_virtualdirectory - Fixed an issue where virtual directory information
+        could not be obtained correctly when the parameter ``application`` was set
+      minor_changes:
+      - win_disk_facts - Added ``filter`` option to filter returned facts by type
+        of disk information - https://github.com/ansible-collections/community.windows/issues/33
+      - win_disk_facts - Converted from ``#Requires -Module Ansible.ModuleUtils.Legacy``
+        to ``#AnsibleRequires -CSharpUtil Ansible.Basic``
+      - win_iis_virtualdirectory - Added the ``connect_as``, ``username``, and ``password``
+        options to control the virtual directory authentication - https://github.com/ansible-collections/community.windows/issues/346
+      - win_power_plan - Added ``guid`` option to specify plan by a unique identifier
+        - https://github.com/ansible-collections/community.windows/issues/310
+      release_summary:
+      - Release summary for v1.9.0
+    fragments:
+    - 310_win_disk_facts.yml
+    - 330_win_domain_user.yml
+    - 337_win_power_plan.yml
+    - 345_win_domain_user.yml
+    - 347_win_iis_virtualdirectory.yml
+    - release-2.9.0.yml
+    release_date: '2021-12-21'
diff --git a/changelogs/fragments/310_win_disk_facts.yml b/changelogs/fragments/310_win_disk_facts.yml
diff --git a/changelogs/fragments/330_win_domain_user.yml b/changelogs/fragments/330_win_domain_user.yml
diff --git a/changelogs/fragments/337_win_power_plan.yml b/changelogs/fragments/337_win_power_plan.yml
diff --git a/changelogs/fragments/345_win_domain_user.yml b/changelogs/fragments/345_win_domain_user.yml
diff --git a/changelogs/fragments/347_win_iis_virtualdirectory.yml b/changelogs/fragments/347_win_iis_virtualdirectory.yml
diff --git a/docs/community.windows.win_credential_module.rst b/docs/community.windows.win_credential_module.rst
@@ -153,7 +153,7 @@ Parameters
                 <td>
                         <div>The target that identifies the server or servers that the credential is to be used for.</div>
                         <div>If the value can be a NetBIOS name, DNS server name, DNS host name suffix with a wildcard character (<code>*</code>), a NetBIOS of DNS domain name that contains a wildcard character sequence, or an asterisk.</div>
-                        <div>See <code>TargetName</code> in <a href='https://docs.microsoft.com/en-us/windows/desktop/api/wincred/ns-wincred-_credentiala'>https://docs.microsoft.com/en-us/windows/desktop/api/wincred/ns-wincred-_credentiala</a> for more details on what this value can be.</div>
+                        <div>See <code>TargetName</code> in <a href='https://docs.microsoft.com/en-us/windows/win32/api/wincred/ns-wincred-credentiala'>https://docs.microsoft.com/en-us/windows/win32/api/wincred/ns-wincred-credentiala</a> for more details on what this value can be.</div>
                         <div>This is used with <em>type</em> to produce a unique credential.</div>
                 </td>
             </tr>

diff --git a/docs/community.windows.win_disk_facts_module.rst b/docs/community.windows.win_disk_facts_module.rst
@@ -27,6 +27,46 @@ The below requirements are needed on the host that executes this module.
 - Windows 8.1 / Windows 2012 (NT 6.2)
 
 
+Parameters
+----------
+
+.. raw:: html
+
+    <table  border=0 cellpadding=0 class="documentation-table">
+        <tr>
+            <th colspan="1">Parameter</th>
+            <th>Choices/<font color="blue">Defaults</font></th>
+            <th width="100%">Comments</th>
+        </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>filter</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">list</span>
+                         / <span style="color: purple">elements=string</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.9.0</div>
+                </td>
+                <td>
+                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
+                                    <li><div style="color: blue"><b>physical_disk</b>&nbsp;&larr;</div></li>
+                                    <li><div style="color: blue"><b>virtual_disk</b>&nbsp;&larr;</div></li>
+                                    <li><div style="color: blue"><b>win32_disk_drive</b>&nbsp;&larr;</div></li>
+                                    <li><div style="color: blue"><b>partitions</b>&nbsp;&larr;</div></li>
+                                    <li><div style="color: blue"><b>volumes</b>&nbsp;&larr;</div></li>
+                        </ul>
+                        <b>Default:</b><br/><div style="color: blue">["physical_disk", "virtual_disk", "win32_disk_drive", "partitions", "volumes"]</div>
+                </td>
+                <td>
+                        <div>Allows to filter returned facts by type of disk information.</div>
+                        <div>If volumes are selected partitions will be returned as well.</div>
+                </td>
+            </tr>
+    </table>
+    <br/>
+
 
 Notes
 -----
@@ -67,6 +107,12 @@ Examples
       debug:
         var: ansible_facts.disks[1].serial_number
 
+    - name: get disk physical_disk and partition facts on the target
+      win_disk_facts:
+        filter:
+          - physical_disk
+          - partitions
+
 
 Returned Facts
 --------------

diff --git a/docs/community.windows.win_iis_virtualdirectory_module.rst b/docs/community.windows.win_iis_virtualdirectory_module.rst
@@ -47,6 +47,28 @@ Parameters
                         <div>The application under which the virtual directory is created or exists.</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>connect_as</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">string</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.9.0</div>
+                </td>
+                <td>
+                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
+                                    <li>pass_through</li>
+                                    <li>specific_user</li>
+                        </ul>
+                </td>
+                <td>
+                        <div>The type of authentication to use for the virtual directory. Either <code>pass_through</code> or <code>specific_user</code></div>
+                        <div>If <code>pass_through</code>, IIS will use the identity of the user or application pool identity to access the physical path.</div>
+                        <div>If <code>specific_user</code>, IIS will use the credentials provided in <em>username</em> and <em>password</em> to access the physical path.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="1">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -63,6 +85,23 @@ Parameters
                         <div>The name of the virtual directory to create or remove.</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>password</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">string</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.9.0</div>
+                </td>
+                <td>
+                </td>
+                <td>
+                        <div>The password associated with <em>username</em>.</div>
+                        <div>Required when <em>connect_as</em> is set to <code>specific_user</code>.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="1">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -115,6 +154,23 @@ Parameters
                         <div>Removing will remove the virtual directory and all under it (Recursively).</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>username</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">string</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.9.0</div>
+                </td>
+                <td>
+                </td>
+                <td>
+                        <div>Specifies the user name of an account that can access configuration files and content for the virtual directory.</div>
+                        <div>Required when <em>connect_as</em> is set to <code>specific_user</code>.</div>
+                </td>
+            </tr>
     </table>
     <br/>
 

diff --git a/docs/community.windows.win_nssm_module.rst b/docs/community.windows.win_nssm_module.rst
@@ -404,7 +404,7 @@ Notes
 
 .. note::
    - The service will NOT be started after its creation when ``state=present``.
-   - Once the service is created, you can use the :ref:`ansible.windowswin_service <ansible.windowswin_service_module>` module to start it or configure some additionals properties, such as its startup type, dependencies, service account, and so on.
+   - Once the service is created, you can use the :ref:`ansible.windows.win_service <ansible.windows.win_service_module>` module to start it or configure some additionals properties, such as its startup type, dependencies, service account, and so on.
 
 
 See Also

diff --git a/docs/community.windows.win_power_plan_module.rst b/docs/community.windows.win_power_plan_module.rst
@@ -18,6 +18,7 @@ Synopsis
 --------
 - This module will change the power plan of a Windows system to the defined string.
 - Windows defaults to ``balanced`` which will cause CPU throttling. In some cases it can be preferable to change the mode to ``high performance`` to increase CPU performance.
+- One of *name* or *guid* must be provided.
 
 
 
@@ -33,20 +34,37 @@ Parameters
             <th>Choices/<font color="blue">Defaults</font></th>
             <th width="100%">Comments</th>
         </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>guid</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">string</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.9.0</div>
+                </td>
+                <td>
+                </td>
+                <td>
+                        <div>String value that indicates the desired power plan by guid.</div>
+                        <div>The power plan must already be present on the system.</div>
+                        <div>For out of box guids see <a href='https://docs.microsoft.com/en-us/windows/win32/power/power-policy-settings'>https://docs.microsoft.com/en-us/windows/win32/power/power-policy-settings</a>.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="1">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
                     <b>name</b>
                     <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                     <div style="font-size: small">
                         <span style="color: purple">string</span>
-                         / <span style="color: red">required</span>
                     </div>
                 </td>
                 <td>
                 </td>
                 <td>
-                        <div>String value that indicates the desired power plan.</div>
+                        <div>String value that indicates the desired power plan by name.</div>
                         <div>The power plan must already be present on the system.</div>
                         <div>Commonly there will be options for <code>balanced</code> and <code>high performance</code>.</div>
                 </td>
@@ -66,6 +84,10 @@ Examples
       community.windows.win_power_plan:
         name: high performance
 
+    - name: Change power plan to high performance
+      community.windows.win_power_plan:
+        guid: 8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c
+
 
 
 Return Values

diff --git a/galaxy.yml b/galaxy.yml
@@ -1,6 +1,6 @@
 namespace: community
 name: windows
-version: 1.8.0
+version: 1.9.0
 readme: README.md
 authors:
 - Jordan Borean @jborean93