Changes to xPowerPlan

Improved the description for parameter Name
Removed ShouldProcess and SupportsShouldProcess
Added comment-based help
Cleaned up the code somewhat

Author: johlju

DSCResources/MSFT_xPowerPlan/MSFT_xPowerPlan.psm1

@@ -1,9 +1,23 @@
+<#
+    .SYNOPSIS
+        Returns the current state of the power plan.
+
+    .PARAMETER IsSingleInstance
+        Specifies the resource is a single instance, the value must be 'Yes'.
+
+    .PARAMETER Name
+        Specifies the name of the power plan to assign to the node.
+
+    .EXAMPLE
+        Get-TargetResource -IsSingleInstance 'Yes' -Name 'High performance'
+#>
 function Get-TargetResource
 {
     [CmdletBinding()]
     [OutputType([System.Collections.Hashtable])]
     param
     (
+        # This is best practice when writing a single-instance DSC resource.
         [Parameter(Mandatory = $true)]
         [ValidateSet('Yes')]
         [System.String]
@@ -17,7 +31,13 @@ function Get-TargetResource
 
     try
     {
-        $plan = Get-CimInstance -Name root\cimv2\power -Class Win32_PowerPlan -Filter "ElementName = '$Name'"
+        $arguments = @{
+            Name = 'root\cimv2\power'
+            Class = 'Win32_PowerPlan'
+            Filter = "ElementName = '$Name'"
+        }
+
+        $plan = Get-CimInstance @arguments
         if ($plan)
         {
             if( $plan.IsActive )
@@ -47,11 +67,25 @@ function Get-TargetResource
     }
 }
 
+<#
+    .SYNOPSIS
+        Assign the power plan to the node.
+
+    .PARAMETER IsSingleInstance
+        Specifies the resource is a single instance, the value must be 'Yes'.
+
+    .PARAMETER Name
+        Specifies the name of the power plan to assign to the node.
+
+    .EXAMPLE
+        Set-TargetResource -IsSingleInstance 'Yes' -Name 'High performance'
+#>
 function Set-TargetResource
 {
-    [CmdletBinding(SupportsShouldProcess)]
+    [CmdletBinding()]
     param
     (
+        # This is best practice when writing a single-instance DSC resource.
         [Parameter(Mandatory = $true)]
         [ValidateSet('Yes')]
         [System.String]
@@ -63,26 +97,45 @@ function Set-TargetResource
         $Name
     )
 
-    if ($PSCmdlet.ShouldProcess($Name, 'Activating power plan'))
+    try
     {
-        try
-        {
-            $plan = Get-CimInstance -Name root\cimv2\power -Class Win32_PowerPlan -Filter "ElementName = '$Name'" 
-            Invoke-CimMethod -InputObject $plan -MethodName Activate
-        }
-        catch
-        {
-            Throw "Unable to set the power plan $Name to the active plan. Error message: $($_.Exception.Message)" 
+        Write-Verbose -Message "Activating power plan $Name"
+
+        $arguments = @{
+            Name = 'root\cimv2\power'
+            Class = 'Win32_PowerPlan'
+            Filter = "ElementName = '$Name'"
         }
+
+        $plan = Get-CimInstance @arguments 
+        $plan | Invoke-CimMethod -MethodName Activate
+    }
+    catch
+    {
+        Throw "Unable to set the power plan $Name to the active plan. Error message: $($_.Exception.Message)" 
     }
 }
 
+<#
+    .SYNOPSIS
+        Tests if the power plan is assigned to the node.
+
+    .PARAMETER IsSingleInstance
+        Specifies the resource is a single instance, the value must be 'Yes'.
+
+    .PARAMETER Name
+        Specifies the name of the power plan to assign to the node.
+
+    .EXAMPLE
+        Test-TargetResource -IsSingleInstance 'Yes' -Name 'High performance'
+#>
 function Test-TargetResource
 {
     [CmdletBinding()]
     [OutputType([System.Boolean])]
     param
     (
+        # This is best practice when writing a single-instance DSC resource.
         [Parameter(Mandatory = $true)]
         [ValidateSet('Yes')]
         [System.String]

DSCResources/MSFT_xPowerPlan/MSFT_xPowerPlan.schema.mof

@@ -2,5 +2,5 @@
 class MSFT_xPowerPlan : OMI_BaseResource
 {
     [Key, Description("Specifies the resource is a single instance, the value must be 'Yes'"), ValueMap{"Yes"}, Values{"Yes"}] String IsSingleInstance;
-    [Required, Description("The name of the plan to activate.")] String Name;
+    [Required, Description("The name of the power plan to activate.")] String Name;
 };

README.md

@@ -75,7 +75,7 @@ xScheduledTask has the following properties:
 xPowerPlan resource has following properties:
 
  * IsSingleInstance: Specifies the resource is a single instance, the value must be 'Yes'.
- * Name: The name of the plan to activate.
+ * Name: The name of the power plan to activate.
 
 ## Versions