Change examples to meet HQRM standards and optin to Example validation tests.

Author: PlagueHO

.MetaTestOptIn.json

@@ -1,3 +1,4 @@
 [
-        "Common Tests - Validate Markdown Files"
+        "Common Tests - Validate Markdown Files",
+        "Common Tests - Validate Example Files"
 ]

Examples/Sample_xOfflineDomainJoin.ps1

@@ -0,0 +1,33 @@
+<#
+    .EXAMPLE
+    This configuration will set a machine name and changes the
+    workgroup it is in.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost',
+
+        [Parameter(Mandatory = $true)]
+        [System.String]
+        $MachineName,
+
+        [Parameter(Mandatory = $true)]
+        [System.String]
+        $WorkGroup
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer NewNameAndWorkgroup
+        {
+            Name          = $MachineName
+            WorkGroupName = $WorkGroup
+        }
+    }
+}

Examples/Sample_xPowerPlan.ps1

@@ -0,0 +1,39 @@
+<#
+    .EXAMPLE
+    This configuration sets the machine name and joins a domain.
+    Note: this requires a credential.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost',
+
+        [Parameter(Mandatory = $true)]
+        [System.String]
+        $MachineName,
+
+        [Parameter(Mandatory = $true)]
+        [System.String]
+        $DomainName,
+
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullorEmpty()]
+        [System.Management.Automation.PSCredential]
+        $Credential
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer JoinDomain
+        {
+            Name       = $MachineName
+            DomainName = $DomainName
+            Credential = $Credential # Credential to join to domain
+        }
+    }
+}

Examples/xComputer/1-RnameComputerAndSetWorkgroup.ps1

@@ -0,0 +1,34 @@
+<#
+    .EXAMPLE
+    This example will change the machines name while remaining on the domain.
+    Note: this requires a credential.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost',
+
+        [Parameter(Mandatory = $true)]
+        [System.String]
+        $MachineName,
+
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullorEmpty()]
+        [System.Management.Automation.PSCredential]
+        $Credential
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer NewName
+        {
+            Name       = $MachineName
+            Credential = $Credential # Domain credential
+        }
+    }
+}

Examples/xComputer/2-JoinDomain.ps1

@@ -0,0 +1,28 @@
+<#
+    .EXAMPLE
+    This example will change the machines name while remaining
+    in the workgroup.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost',
+
+        [Parameter(Mandatory = $true)]
+        [System.String]
+        $MachineName
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer NewName
+        {
+            Name = $MachineName
+        }
+    }
+}

Examples/xComputer/3-RenameComputerInDomain.ps1

@@ -0,0 +1,39 @@
+<#
+    .EXAMPLE
+    This example switches the computer from a domain to a workgroup.
+    Note: this requires a credential.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost',
+
+        [Parameter(Mandatory = $true)]
+        [System.String]
+        $MachineName,
+
+        [Parameter(Mandatory = $true)]
+        [System.String]
+        $WorkGroup,
+
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullorEmpty()]
+        [System.Management.Automation.PSCredential]
+        $Credential
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer JoinWorkgroup
+        {
+            Name          = $MachineName
+            WorkGroupName = $WorkGroup
+            Credential    = $Credential # Credential to unjoin from domain
+        }
+    }
+}

Examples/xComputer/4-RnameComputerInWorkgroup.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'
+        }
+    }
+}

Examples/xComputer/5-UnjoinDomainAndJoinWorkgroup.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'
+        }
+    }
+}