Merge pull request #86 from PlagueHO/Issue-82

PlagueHO · web-flow · commit 1bbbf03429cb · 2017-07-23T09:22:34.000+12:00
Correct Example Style to meet HQRM and Enable Example Tests - Fixes #82
diff --git a/.MetaTestOptIn.json b/.MetaTestOptIn.json
@@ -1,3 +1,4 @@
 [
-        "Common Tests - Validate Markdown Files"
+        "Common Tests - Validate Markdown Files",
+        "Common Tests - Validate Example Files"
 ]
diff --git a/Examples/Sample_xOfflineDomainJoin.ps1 b/Examples/Sample_xOfflineDomainJoin.ps1
diff --git a/Examples/Sample_xPowerPlan.ps1 b/Examples/Sample_xPowerPlan.ps1
diff --git a/Examples/Sample_xVirtualMemory.ps1 b/Examples/Sample_xVirtualMemory.ps1
diff --git a/Examples/xComputer/1-RenameComputerAndSetWorkgroup.ps1 b/Examples/xComputer/1-RenameComputerAndSetWorkgroup.ps1
@@ -0,0 +1,25 @@
+<#
+    .EXAMPLE
+    This configuration will set the computer name to 'Server01'
+    and make it part of 'ContosoWorkgroup' Workgroup.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost'
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer NewNameAndWorkgroup
+        {
+            Name          = 'Server01'
+            WorkGroupName = 'ContosoWorkgroup'
+        }
+    }
+}
diff --git a/Examples/xComputer/2-JoinDomain.ps1 b/Examples/xComputer/2-JoinDomain.ps1
@@ -0,0 +1,32 @@
+<#
+    .EXAMPLE
+    This configuration sets the machine name to 'Server01' and
+    joins the 'Contoso' domain.
+    Note: this requires an AD credential to join the domain.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost',
+
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullorEmpty()]
+        [System.Management.Automation.PSCredential]
+        $Credential
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer JoinDomain
+        {
+            Name       = 'Server01'
+            DomainName = 'Contoso'
+            Credential = $Credential # Credential to join to domain
+        }
+    }
+}
diff --git a/Examples/xComputer/3-RenameComputerInDomain.ps1 b/Examples/xComputer/3-RenameComputerInDomain.ps1
@@ -0,0 +1,32 @@
+<#
+    .EXAMPLE
+    This example will change the machines name 'Server01' while remaining
+    joined to the current domain.
+    Note: this requires a credential for renaming the machine on the
+    domain.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost',
+
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullorEmpty()]
+        [System.Management.Automation.PSCredential]
+        $Credential
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer NewName
+        {
+            Name       = 'Server01'
+            Credential = $Credential # Domain credential
+        }
+    }
+}
diff --git a/Examples/xComputer/4-RenameComputerInWorkgroup.ps1 b/Examples/xComputer/4-RenameComputerInWorkgroup.ps1
@@ -0,0 +1,24 @@
+<#
+    .EXAMPLE
+    This example will set the machine name to 'Server01' while remaining
+    in the workgroup.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost'
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer NewName
+        {
+            Name = 'Server01'
+        }
+    }
+}
diff --git a/Examples/xComputer/5-UnjoinDomainAndJoinWorkgroup.ps1 b/Examples/xComputer/5-UnjoinDomainAndJoinWorkgroup.ps1
@@ -0,0 +1,32 @@
+<#
+    .EXAMPLE
+    This example switches the computer 'Server01' from a domain and joins it
+    to the 'ContosoWorkgroup' Workgroup.
+    Note: this requires a credential.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost',
+
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullorEmpty()]
+        [System.Management.Automation.PSCredential]
+        $Credential
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer JoinWorkgroup
+        {
+            Name          = 'Server01'
+            WorkGroupName = 'ContosoWorkgroup'
+            Credential    = $Credential # Credential to unjoin from domain
+        }
+    }
+}
diff --git a/Examples/xOfflineDomainJoin/1-JoinDomainUsingODJBlob.ps1 b/Examples/xOfflineDomainJoin/1-JoinDomainUsingODJBlob.ps1
@@ -0,0 +1,25 @@
+<#
+    .EXAMPLE
+    This example will join the computer to a domain using the ODJ
+    request file C:\ODJ\ODJRequest.txt.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost'
+    )
+
+    Import-DscResource -ModuleName xComputerManagement
+
+    Node $NodeName
+    {
+        xOfflineDomainJoin ODJ
+        {
+          IsSingleInstance = 'Yes'
+          RequestFile      = 'C:\ODJ\ODJBlob.txt'
+        }
+    }
+}
diff --git a/Examples/xPowerPlan/1-SetPowerPlan.ps1 b/Examples/xPowerPlan/1-SetPowerPlan.ps1
@@ -0,0 +1,24 @@
+<#
+    .EXAMPLE
+    This examples sets the active power plan to the 'High performance' plan.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost'
+    )
+
+    Import-DscResource -ModuleName xComputerManagement
+
+    Node $NodeName
+    {
+        xPowerPlan SetPlanHighPerformance
+        {
+          IsSingleInstance = 'Yes'
+          Name             = 'High performance'
+        }
+    }
+}
diff --git a/Examples/xScheduledTask/1-CreateScheduledTasks.ps1 b/Examples/xScheduledTask/1-CreateScheduledTasks.ps1
@@ -1,15 +1,24 @@
 <#
-This example creates five tasks with the following schedules that start a new powershell process
-- Once at 00:00 repeating every 15 minutes for 8 hours
-- Daily at 00:00 repeating every 15 minutes for 8 hours
-- Weekly at 00:00 repeating every 15 minutes for 8 hours on Mon, Wed, Sat
-- At logon repeating every 15 minutes for 8 hours
-- At startup repeating every 15 minutes for 8 hours
+    .EXAMPLE
+    This example creates five tasks with the following schedules that start a new powershell process
+        - Once at 00:00 repeating every 15 minutes for 8 hours
+        - Daily at 00:00 repeating every 15 minutes for 8 hours
+        - Weekly at 00:00 repeating every 15 minutes for 8 hours on Mon, Wed, Sat
+        - At logon repeating every 15 minutes for 8 hours
+        - At startup repeating every 15 minutes for 8 hours
 #>
-Configuration Sample_xScheduledTask
+Configuration Example
 {
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost'
+    )
+
     Import-DscResource -ModuleName xComputerManagement
-    node 'localhost'
+
+    Node $NodeName
     {
         xScheduledTask xScheduledTaskOnceAdd
         {
@@ -26,7 +35,7 @@ Configuration Sample_xScheduledTask
             RunOnlyIfIdle = $false
             Priority = 9
         }
-    
+
         xScheduledTask xScheduledTaskDailyAdd
         {
             TaskName = 'Test task Daily'
@@ -41,7 +50,7 @@ Configuration Sample_xScheduledTask
             RunOnlyIfNetworkAvailable = $true
             WakeToRun = $true
         }
-    
+
         xScheduledTask xScheduledTaskWeeklyAdd
         {
             TaskName = 'Test task Weekly'
@@ -56,7 +65,7 @@ Configuration Sample_xScheduledTask
             Compatibility = 'Win8'
             Hidden = $true
         }
-    
+
         xScheduledTask xScheduledTaskLogonAdd
         {
             TaskName = 'Test task Logon'
@@ -78,6 +87,3 @@ Configuration Sample_xScheduledTask
         }
     }
 }
-
-Sample_xScheduledTask
-Start-DscConfiguration -Path Sample_xScheduledTask -Wait -Verbose -Force
diff --git a/Examples/xScheduledTask/2-RunPowerShellTaskEvery15Minutes.ps1 b/Examples/xScheduledTask/2-RunPowerShellTaskEvery15Minutes.ps1
@@ -0,0 +1,30 @@
+<#
+    .EXAMPLE
+    This example will create a scheduled task that will call PowerShell.exe every 15
+    minutes to run a script saved locally.
+    The script will be called as the local system account
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost'
+    )
+
+    Import-DscResource -ModuleName xComputerManagement
+
+    Node $NodeName
+    {
+        xScheduledTask MaintenanceScriptExample
+        {
+          TaskName           = "Custom maintenance tasks"
+          ActionExecutable   = "C:\windows\system32\WindowsPowerShell\v1.0\powershell.exe"
+          ActionArguments    = "-File `"C:\scripts\my custom script.ps1`""
+          ScheduleType       = 'Once'
+          RepeatInterval     = [datetime]::Today.AddMinutes(15)
+          RepetitionDuration = [datetime]::Today.AddHours(10)
+        }
+    }
+}
diff --git a/Examples/xVirtualMemory/1-SetVirtualMemory.ps1 b/Examples/xVirtualMemory/1-SetVirtualMemory.ps1
diff --git a/README.md b/README.md

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`[`
`2`		`- "Common Tests - Validate Markdown Files"`
	`2`	`+ "Common Tests - Validate Markdown Files",`
	`3`	`+ "Common Tests - Validate Example Files"`
`3`	`4`	`]`