Changes to xPowerPlan

Made the resource a single-instance resource

Author: johlju

DSCResources/MSFT_xPowerPlan/MSFT_xPowerPlan.psm1

@@ -1,29 +1,22 @@
-$script:presentStateDefaultPlanName = 'High performance'
-# Absent state is hard-coded to plan name 'Balanced' because that is the default plan after OS installation
-$script:absentStateDefaultPlanName = 'Balanced'
-
 function Get-TargetResource
 {
     [CmdletBinding()]
     [OutputType([System.Collections.Hashtable])]
     param
     (
         [Parameter(Mandatory = $true)]
-        [ValidateSet("Present","Absent")]
+        [ValidateSet('Yes')]
         [System.String]
-        $Ensure,
+        $IsSingleInstance,
 
+        [parameter(Mandatory = $true)]
+        [ValidateNotNullOrEmpty()]
         [System.String]
-        $Name = $script:presentStateDefaultPlanName
+        $Name
     )
 
     try
     {
-        if ($Ensure -eq 'Absent' )
-        {
-            $Name = $script:absentStateDefaultPlanName 
-        }
-        
         $plan = Get-CimInstance -Name root\cimv2\power -Class Win32_PowerPlan -Filter "ElementName = '$Name'"
         if ($plan)
         {
@@ -49,7 +42,7 @@ function Get-TargetResource
     }
 
     return @{
-        Ensure = $Ensure
+        IsSingleInstance = $IsSingleInstance
         Name = $activePlanName
     }
 }
@@ -60,19 +53,16 @@ function Set-TargetResource
     param
     (
         [Parameter(Mandatory = $true)]
-        [ValidateSet("Present","Absent")]
+        [ValidateSet('Yes')]
         [System.String]
-        $Ensure,
+        $IsSingleInstance,
 
+        [parameter(Mandatory = $true)]
+        [ValidateNotNullOrEmpty()]
         [System.String]
-        $Name = $script:presentStateDefaultPlanName
+        $Name
     )
 
-    if ($Ensure -eq 'Absent' )
-    {
-        $Name = $script:absentStateDefaultPlanName
-    }
-
     if ($PSCmdlet.ShouldProcess($Name, 'Activating power plan'))
     {
         try
@@ -94,22 +84,20 @@ function Test-TargetResource
     param
     (
         [Parameter(Mandatory = $true)]
-        [ValidateSet("Present","Absent")]
+        [ValidateSet('Yes')]
         [System.String]
-        $Ensure,
+        $IsSingleInstance,
 
+        [parameter(Mandatory = $true)]
+        [ValidateNotNullOrEmpty()]
         [System.String]
-        $Name = $script:presentStateDefaultPlanName
+        $Name
     )
 
     $returnValue = $false
 
-    $result = Get-TargetResource -Ensure $Ensure -Name $Name
-    if ($result.Ensure -eq 'Present' -and $result.Name -eq $Name )
-    {
-        $returnValue = $true
-    }
-    elseif ($result.Ensure -eq 'Absent' -and $result.Name -eq $script:absentStateDefaultPlanName )
+    $result = Get-TargetResource -IsSingleInstance $IsSingleInstance -Name $Name
+    if ($result.Name -eq $Name)
     {
         $returnValue = $true
     }

DSCResources/MSFT_xPowerPlan/MSFT_xPowerPlan.schema.mof

@@ -1,6 +1,6 @@
 [ClassVersion("1.0.0.0"), FriendlyName("xPowerPlan")]
 class MSFT_xPowerPlan : OMI_BaseResource
 {
-    [Key, Description("Use value 'Present' if the plan name should be activated. Use value 'Absent' to active the default plan for the operating system (hard-coded to plan 'Balanced')."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
-    [Write, Description("The name och the plan to activate. Default value is 'High performance'.")] String Name;
+    [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;
 };

Examples/Sample_xPowerPlan.ps1

@@ -11,7 +11,7 @@ configuration Sample_xPowerPlan
     {
         xPowerPlan SetPlanHighPerformance
         {
-          Ensure = 'Present'
+          IsSingleInstance = 'Yes'
           Name = 'High performance'
         }
     }

README.md

@@ -74,8 +74,8 @@ xScheduledTask has the following properties:
 ## xPowerPlan
 xPowerPlan resource has following properties:
 
-* Ensure: Use value 'Present' if the plan name should be activated. Use value 'Absent' to active the default plan for the operating system (hard-coded to plan 'Balanced').
-* Name: The name och the plan to activate. Default value is 'High performance'.
+ * IsSingleInstance: Specifies the resource is a single instance, the value must be 'Yes'.
+ * Name: The name of the plan to activate.
 
 ## Versions