Merge pull request #99 from gesbeckj/dev

xComputer: Added Description

Author: PlagueHO

DSCResources/MSFT_xComputer/MSFT_xComputer.psm1

@@ -33,7 +33,11 @@ function Get-TargetResource
 
         [Parameter()]
         [System.String]
-        $WorkGroupName
+        $WorkGroupName,
+
+        [Parameter()]
+        [System.String]
+        $Description
     )
 
     Write-Verbose -Message "Getting computer state for '$($Name)'."
@@ -64,6 +68,7 @@ function Get-TargetResource
         Credential       = [ciminstance]$convertToCimCredential
         UnjoinCredential = [ciminstance]$convertToCimUnjoinCredential
         WorkGroupName    = (Get-CimInstance -Class 'Win32_ComputerSystem').Workgroup
+        Description      = (Get-CimInstance -Class 'Win32_OperatingSystem').Description
     }
 
     $returnValue
@@ -98,7 +103,11 @@ function Set-TargetResource
 
         [Parameter()]
         [System.String]
-        $WorkGroupName
+        $WorkGroupName,
+
+        [Parameter()]
+        [System.String]
+        $Description
     )
 
     Assert-DomainOrWorkGroup -DomainName $DomainName -WorkGroupName $WorkGroupName
@@ -108,6 +117,14 @@ function Set-TargetResource
         $Name = $env:COMPUTERNAME
     }
 
+    if ($PSBoundParameters.ContainsKey('Description'))
+    {
+        Write-Verbose -Message "Setting computer description to '$($Description)'."
+        $win32OperatingSystemCimInstance = Get-CimInstance -ClassName Win32_OperatingSystem
+        $win32OperatingSystemCimInstance.Description = $Description
+        Set-CimInstance -InputObject $win32OperatingSystemCimInstance
+    }
+
     if ($Credential)
     {
         if ($DomainName)
@@ -274,7 +291,11 @@ function Test-TargetResource
 
         [Parameter()]
         [System.String]
-        $WorkGroupName
+        $WorkGroupName,
+
+        [Parameter()]
+        [System.String]
+        $Description
     )
 
     Write-Verbose -Message 'Validate desired Name is a valid name'
@@ -285,6 +306,15 @@ function Test-TargetResource
         return $false
     }
 
+    if ($PSBoundParameters.ContainsKey('Description'))
+    {
+        Write-Verbose -Message 'Checking if description is corerect'
+        if ($Description -ne (Get-CimInstance -Class 'Win32_OperatingSystem').Description)
+        {
+            return $false
+        }
+    }
+
     Assert-DomainOrWorkGroup -DomainName $DomainName -WorkGroupName $WorkGroupName
 
     if ($DomainName)

DSCResources/MSFT_xComputer/MSFT_xComputer.schema.mof

@@ -1,11 +1,12 @@
 [ClassVersion("1.0.1.0"), FriendlyName("xComputer")]
 class MSFT_xComputer : OMI_BaseResource
 {
-    [key] string Name;
-    [write] string DomainName;
-    [write] string JoinOU;
-    [read] string CurrentOU;
-    [write,EmbeddedInstance("MSFT_Credential")] String Credential;
-    [write,EmbeddedInstance("MSFT_Credential")] String UnjoinCredential;
-    [write] string WorkGroupName;
+    [Key, Description("The desired computer name")] String Name;
+    [Write, Description("The name of the domain to join")] String DomainName;
+    [Write, Description("The distinguished name of the organizational unit that the computer account will be created in")] String JoinOU;
+    [Read, Description("A read-only property that specifies the organizational unit that the computer account is currently in")] String CurrentOU;
+    [Write, EmbeddedInstance("MSFT_Credential"), Description("Credential to be used to join or leave domain")] String Credential;
+    [Write, EmbeddedInstance("MSFT_Credential"), Description("Credential to be used to join or leave domain")] String UnjoinCredential;
+    [Write, Description("The name of the workgroup")] String WorkGroupName;
+    [Write, Description("The value assigned here will be set as the local computer description")] String Description;
 };

Examples/xComputer/6-SetComputerDescriptionInWorkgroup.ps1

@@ -0,0 +1,24 @@
+<#
+    .EXAMPLE
+    This example will set the computer description
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost'
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer NewDescription
+        {
+            Name = 'localhost'
+            Description = 'This is my computer.'
+        }
+    }
+}

README.md

@@ -53,6 +53,7 @@ xComputer resource has following properties:
 * Credential: Credential to be used to join or leave domain
 * CurrentOU: A read-only property that specifies the organizational unit that
   the computer account is currently in
+* Description: The value assigned here will be set as the local computer description
 
 ### xComputer Examples
 
@@ -61,6 +62,7 @@ xComputer resource has following properties:
 * [Set the Name while staying on the Domain](/Examples/xComputer/3-RenameComputerInDomain.ps1)
 * [Set the Name while staying on the Workgroup](/Examples/xComputer/4-RenameComputerInWorkgroup.ps1)
 * [Switch from a Domain to a Workgroup](/Examples/xComputer/5-UnjoinDomainAndJoinWorkgroup.ps1)
+* [Set a Description for the Workstation](/Examples/xComputer/6-SetComputerDescriptionInWorkgroup.ps1)
 
 ## xOfflineDomainJoin
 
@@ -202,6 +204,9 @@ xVirtualMemory has the following properties:
 
 ### Unreleased
 
+* xComputer: Added parameter to set the local computer description along with documentation
+ and unit tests for this change.
+
 ### 2.1.0.0
 
 * xComputer: Changed comparison that validates if we are in the correct AD