✨ add display_name field to win_domain_user (#477) (#478)

* ✨ add display_name field to win_domain_user (#477)

* 📝 version_added for win_domain_user.display_name

* Added changelog fragment

Co-authored-by: Jordan Borean <[email protected]>

Author: Daniel-Sanchez-Fabregas

Diff for: changelogs/fragments/win_domain_user-display_name.yml

@@ -0,0 +1,2 @@
+minor_changes:
+- win_domain_user - Added the ``display_name`` option to set the users display name attribute

Diff for: plugins/modules/win_domain_user.ps1

@@ -96,6 +96,7 @@ $spec = @{
         identity = @{ type = 'str' }
         firstname = @{ type = 'str' }
         surname = @{ type = 'str'; aliases = @('lastname') }
+        display_name = @{ type = 'str' }
         company = @{ type = 'str' }
         email = @{ type = 'str' }
         street = @{ type = 'str' }
@@ -170,6 +171,7 @@ if ($null -eq $identity) {
 $user_info = @{
     GivenName = $module.Params.firstname
     Surname = $module.Params.surname
+    DisplayName = $module.Params.display_name
     Company = $module.Params.company
     EmailAddress = $module.Params.email
     StreetAddress = $module.Params.street
@@ -529,6 +531,7 @@ If ($user_obj) {
     $module.Result.name = $user_obj.Name
     $module.Result.firstname = $user_obj.GivenName
     $module.Result.surname = $user_obj.Surname
+    $module.Result.display_name = $user_obj.DisplayName
     $module.Result.enabled = $user_obj.Enabled
     $module.Result.company = $user_obj.Company
     $module.Result.street = $user_obj.StreetAddress

Diff for: plugins/modules/win_domain_user.py

@@ -136,6 +136,11 @@
       - Configures the user's last name (surname).
     type: str
     aliases: [ lastname ]
+  display_name:
+    description:
+      - Configures the user's display name.
+    type: str
+    version_added: 1.12.0
   company:
     description:
       - Configures the user's company name.
@@ -251,6 +256,7 @@
     name: bob
     firstname: Bob
     surname: Smith
+    display_name: Mr. Bob Smith
     company: BobCo
     password: B0bP4ssw0rd
     state: present
@@ -359,6 +365,11 @@
     returned: always
     type: str
     sample: Server Administrator
+display_name:
+    description: The user display name
+    returned: always
+    type: str
+    sample: Nick Doe
 distinguished_name:
     description: DN of the user account
     returned: always

Diff for: tests/integration/targets/win_domain_user/tasks/test2.yml

@@ -5,6 +5,7 @@
     upn: [email protected]
     firstname: Hana
     surname: Lytx
+    display_name: Hana Lytx
     company: HelpMeExitVi Inc.
     password: 123
     state: present
@@ -28,6 +29,7 @@
     upn: [email protected]
     firstname: Hana
     surname: Lytx
+    display_name: Hana Lytx
     company: HelpMeExitVi Inc.
     password: h@nAlyTx18!X
     state: present
@@ -50,6 +52,7 @@
     name: katie
     firstname: Katie
     surname: Kickscancer
+    display_name: Katie Kickscancer
     password: SyNs@tI0N
     update_password: on_create
     state: present
@@ -66,6 +69,7 @@
     name: katie
     firstname: Katie
     surname: Kickscancer
+    display_name: Katie Kickscancer
     password: SyNs@tI0N
     update_password: on_create
     state: present