Merge pull request #1 from dbretty/Enable-Advanced-Function-Options

Update to include State Parameter

Author: dbretty

CitrixOptimizerAutomation/Public/New-CitrixTemplateService.ps1

@@ -21,20 +21,23 @@ function New-CitrixTemplateService {
     .PARAMETER GroupName
     The existing Group to add the Service to
 
+    .PARAMETER State
+    The Service State (Enabled / Disabled)
+
     .INPUTS
     This function will take inputs via pipeline as string
 
     .OUTPUTS
     Returns $true or $false depending on the Service creation state
 
     .EXAMPLE
-    PS> New-CitrixTemplateService -Path 'template.xml' -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName 'Group 1'
+    PS> New-CitrixTemplateService -Path 'template.xml' -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName 'Group 1' -State "Disabled"
     Adds an entry to disable the Print Spooler service in the template file.
     .EXAMPLE
-    PS> New-CitrixTemplateService -Path $Template.Path -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName 'Group 1'
+    PS> New-CitrixTemplateService -Path $Template.Path -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName 'Group 1' -State "Disabled"
     Adds an entry to disable the Print Spooler service in the template file passed in via the output from the New-CitrixTemplate cmdlet.
     .EXAMPLE
-    PS> New-CitrixTemplateService -Path 'template.xml' -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName $Group.GroupName
+    PS> New-CitrixTemplateService -Path 'template.xml' -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName $Group.GroupName -State "Disabled"
     Adds an entry to disable the Print Spooler service in the template file passed in via the output from the New-CitrixTemplate cmdlet and the Group Name passed in via the output $Group.GroupName.
 
     .LINK
@@ -63,7 +66,12 @@ Param (
     [Parameter(
         ValuefromPipelineByPropertyName = $true,mandatory=$true
     )]
-    [System.String]$GroupName
+    [System.String]$GroupName,
+    [Parameter(
+        ValuefromPipelineByPropertyName = $true,mandatory=$true
+    )]
+    [ValidateSet("Enabled","Disabled")]
+    $State
 )
 
 begin {
@@ -127,7 +135,7 @@ process {
                             $Params.AppendChild($ParamName)
 
                             $ParamValue = $XMLFile.CreateElement("value")
-                            $ParamValue.InnerText = "Disabled"
+                            $ParamValue.InnerText = $State
                             $Params.AppendChild($ParamValue)
 
                         $Action.AppendChild($Params)

CitrixOptimizerAutomation/Public/New-CitrixTemplateTask.ps1

@@ -21,20 +21,23 @@ function New-CitrixTemplateTask {
     .PARAMETER TaskDescription
     The Description for the Scheduled Task
 
+    .PARAMETER State
+    The Service State (Enabled / Disabled)
+
     .INPUTS
     This function will take inputs via pipeline as string
 
     .OUTPUTS
     Returns $true or $false depending on the Scheduled Task creation state
 
     .EXAMPLE
-    PS> New-CitrixTemplateTask -Path 'template.xml' -GroupName 'Group1' -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task'
+    PS> New-CitrixTemplateTask -Path 'template.xml' -GroupName 'Group1' -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task' -State "Disabled"
     Adds an entry to disable the AppID Scheduled Task in the template file.
     .EXAMPLE
-    PS> New-CitrixTemplateTask -Path $Template.Path -GroupName 'Group1' -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task'
+    PS> New-CitrixTemplateTask -Path $Template.Path -GroupName 'Group1' -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task' -State "Disabled"
     Adds an entry to disable the AppID Scheduled Task in the template file based on the return value in $Template.Path
     .EXAMPLE
-    PS> New-CitrixTemplateTask -Path $Template.Path -GroupName $Group.Name -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task'
+    PS> New-CitrixTemplateTask -Path $Template.Path -GroupName $Group.Name -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task' -State "Disabled"
     Adds an entry to disable the AppID Scheduled Task in the template file based on the return value in $Template.Path and $Group.Name
 
     .LINK
@@ -63,7 +66,12 @@ Param (
     [Parameter(
         ValuefromPipelineByPropertyName = $true,mandatory=$true
     )]
-    [System.String]$TaskDescription
+    [System.String]$TaskDescription,
+    [Parameter(
+        ValuefromPipelineByPropertyName = $true,mandatory=$true
+    )]
+    [ValidateSet("Enabled","Disabled")]
+    $State
 )
 
 begin {
@@ -130,7 +138,7 @@ process {
                             $Params.AppendChild($ParamPath)
 
                             $ParamValue = $XMLFile.CreateElement("value")
-                            $ParamValue.InnerText = "Disabled"
+                            $ParamValue.InnerText = $State
                             $Params.AppendChild($ParamValue)
 
                         $Action.AppendChild($Params)

Examples/TestScript.ps1

@@ -18,12 +18,12 @@ New-CitrixTemplateGroup -Path $Template.Path -GroupName 'OS Optimizations' -Grou
 New-CitrixTemplateGroup -Path $Template.Path -GroupName 'HKLM Optimizations' -GroupDescription "HKLM Optimization Group"
 
 # Create Service Entries
-New-CitrixTemplateService -Path $Template.Path -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName 'System Optimizations'
-New-CitrixTemplateService -Path $Template.Path -EntryName 'Disable the AppID Service' -ServiceName 'AppID' -ServiceDescription 'AppID Service' -GroupName 'System Optimizations'
-New-CitrixTemplateService -Path $Template.Path -EntryName 'Disable the Citrix Primt Management' -ServiceName 'CpSvc' -ServiceDescription 'Citrix Print Service' -GroupName 'System Optimizations'
+New-CitrixTemplateService -Path $Template.Path -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName 'System Optimizations' -State "Disabled"
+New-CitrixTemplateService -Path $Template.Path -EntryName 'Disable the AppID Service' -ServiceName 'AppID' -ServiceDescription 'AppID Service' -GroupName 'System Optimizations' -State "Disabled"
+New-CitrixTemplateService -Path $Template.Path -EntryName 'Disable the Citrix Primt Management' -ServiceName 'CpSvc' -ServiceDescription 'Citrix Print Service' -GroupName 'System Optimizations' -State "Disabled"
 
 # Create Scheduled Task Entries
-New-CitrixTemplateTask -Path $Template.Path -GroupName 'System Optimizations' -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task'
-New-CitrixTemplateTask -Path $Template.Path -GroupName 'System Optimizations' -TaskName 'SchTask - OfficeUpdate' -TaskPath '\Microsoft\Windows\Office\Update\' -TaskDescription 'This is the Office Update Scheduled Task'
-New-CitrixTemplateTask -Path $Template.Path -GroupName 'System Optimizations' -TaskName 'SchTask - Microsoft Edge Update' -TaskPath '\Microsoft\Edge\Update\' -TaskDescription 'This is the Microsoft Edge Update Scheduled Task'
+New-CitrixTemplateTask -Path $Template.Path -GroupName 'System Optimizations' -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task' -State "Disabled"
+New-CitrixTemplateTask -Path $Template.Path -GroupName 'System Optimizations' -TaskName 'SchTask - OfficeUpdate' -TaskPath '\Microsoft\Windows\Office\Update\' -TaskDescription 'This is the Office Update Scheduled Task' -State "Disabled"
+New-CitrixTemplateTask -Path $Template.Path -GroupName 'System Optimizations' -TaskName 'SchTask - Microsoft Edge Update' -TaskPath '\Microsoft\Edge\Update\' -TaskDescription 'This is the Microsoft Edge Update Scheduled Task' -State "Disabled"
 

Help/New-CitrixTemplateService.MD

@@ -11,6 +11,7 @@ New-CitrixTemplateService
     [-ServiceName] <String[]>
     [-ServiceDescription] <String[]>
     [-GroupName] <String[]>
+    [-State] <String[]>
     [<CommonParameters>]
 ```
 ## Description
@@ -22,23 +23,23 @@ This function will create Service Definition in the Citrix Optimizer template.
 ### Example 1
 
 ```PowerShell
-New-CitrixTemplateService -Path 'template.xml' -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName 'Group 1'
+New-CitrixTemplateService -Path 'template.xml' -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName 'Group 1' -State "Disabled"
 ```
 
 Adds an entry to disable the Print Spooler service in the template file.
 
 ### Example 2
 
 ```PowerShell
-New-CitrixTemplateService -Path $Template.Path -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName 'Group 1'
+New-CitrixTemplateService -Path $Template.Path -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName 'Group 1' -State "Disabled"
 ```
 
 Adds an entry to disable the Print Spooler service in the template file passed in via the output from the ```New-CitrixTemplate``` cmdlet.
 
 ### Example 3
 
 ```PowerShell
-New-CitrixTemplateService -Path 'template.xml' -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName $Group.GroupName
+New-CitrixTemplateService -Path 'template.xml' -EntryName 'Disable the Print Spooler' -ServiceName 'spooler' -ServiceDescription 'Windows Print Service' -GroupName $Group.GroupName -State "Disabled"
 ```
 
 Adds an entry to disable the Print Spooler service in the template file passed in via the output from the ```New-CitrixTemplate``` cmdlet and the Group Name passed in via the output $Group.GroupName.
@@ -97,6 +98,18 @@ Specifies the Service Description to add to the template
 
 Specifies the Group to add the Service definition to
 
+| Description | Option |
+|:---|:---|
+| Type    | String |
+| Mandatory    | True |
+| Default Value: | None |
+| Accept pipeline input: | True |
+| Accept wildcard characters: | False |
+
+### -State
+
+Specifies the Service State (Enabled/Disabled)
+
 | Description | Option |
 |:---|:---|
 | Type    | String |

Help/New-CitrixTemplateTask.MD

@@ -11,6 +11,7 @@ New-CitrixTemplateTask
     [-TaskName] <String[]>
     [-TaskPath] <String[]>
     [-TaskDescription] <String[]>
+    [-State] <String[]>
     [<CommonParameters>]
 ```
 ## Description
@@ -22,23 +23,23 @@ This function will create a Scheduled Task Definition in the Citrix Optimizer te
 ### Example 1
 
 ```PowerShell
-New-CitrixTemplateTask -Path 'template.xml' -Group 'Group1' -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task'
+New-CitrixTemplateTask -Path 'template.xml' -Group 'Group1' -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task' -State "Disabled"
 ```
 
 Adds an entry to disable the AppID Scheduled Task in the template file.
 
 ### Example 2
 
 ```PowerShell
-New-CitrixTemplateTask -Path $Template.Path -GroupName 'Group1' -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task'
+New-CitrixTemplateTask -Path $Template.Path -GroupName 'Group1' -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task' -State "Disabled"
 ```
 
 Adds an entry to disable the AppID Scheduled Task in the template file based on the return value in $Template.Path
 
 ### Example 3
 
 ```PowerShell
-New-CitrixTemplateTask -Path $Template.Path -GroupName $Group.Name -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task'
+New-CitrixTemplateTask -Path $Template.Path -GroupName $Group.Name -TaskName 'SchTask - AppID' -TaskPath '\Microsoft\Windows\AppID\' -TaskDescription 'This is the AppID Scheduled Task' -State "Disabled"
 ```
 
 Adds an entry to disable the AppID Scheduled Task in the template file based on the return value in $Template.Path and $Group.Name
@@ -97,6 +98,18 @@ The Full Path to the Scheduled Task
 
 The Description for the Scheduled Task
 
+| Description | Option |
+|:---|:---|
+| Type    | String |
+| Mandatory    | True |
+| Default Value: | None |
+| Accept pipeline input: | True |
+| Accept wildcard characters: | False |
+
+### -State
+
+Specifies the Service State (Enabled/Disabled)
+
 | Description | Option |
 |:---|:---|
 | Type    | String |