|
1 | | -# Status |
2 | | -[](https://ci.appveyor.com/project/dbretty/citrixoptimizer) |
| 1 | +[](https://ci.appveyor.com/project/dbretty/citrixoptimizerautomation) |
3 | 2 |
|
4 | 3 | # Citrix Optimizer Automation |
| 4 | + |
| 5 | +PowerShell module to automate the creation of Citrix Optimizer Templates using simple pre-build cmdlets such as: |
| 6 | + |
| 7 | +* New-CitrixTemplate |
| 8 | +* New-CitrixTemplateGroup |
| 9 | +* New-CitrixTemplateRegistry |
| 10 | +* New-CitrixTemplateService |
| 11 | +* New-CitrixTemplateTask |
| 12 | + |
| 13 | +The reason behind creating this module is the time is takes to build up the template files using the user interface. Often customers have various CSV files and JSON files with the settings you want applied to a master image, with this module you are able to parse those files and inject the settings automatically. |
| 14 | + |
| 15 | +## Installing the Module |
| 16 | + |
| 17 | +### PowerShell Support |
| 18 | + |
| 19 | +Citrix Optimizer Automation supports Windows PowerShell 5.1 and above. |
| 20 | + |
| 21 | +### Install from the PowerShell Gallery |
| 22 | + |
| 23 | +The Citrix Optimizer Automation module is published in the [PowerShell Gallery](https://www.powershellgallery.com/packages/CitrixOptimizerAutomation/) |
| 24 | + |
| 25 | +You can install the module by entering the below commands in an elevated PowerShell session: |
| 26 | + |
| 27 | +```powershell |
| 28 | +Install-Module -Name CitrixOptimizerAutomation |
| 29 | +Import-Module -Name CitrixOptimizerAutomation |
| 30 | +``` |
| 31 | + |
| 32 | +### Updating the Module |
| 33 | + |
| 34 | +If you have installed a previous version of the module from the gallery, you can install the latest update with `Update-Module` and the `-Force` parameter: |
| 35 | + |
| 36 | +```powershell |
| 37 | +Update-Module -Name CitrixOptimizerAutomation -Force |
| 38 | +``` |
| 39 | + |
| 40 | +## Documentation |
| 41 | + |
| 42 | +| Command | Description | |
| 43 | +| ----------- | ----------- | |
| 44 | +| [New-CitrixTemplate](Help/New-CitrixTemplate.md) | Creates a new Citrix Optimizer base template | |
| 45 | +| [New-CitrixTemplateGroup](Help/New-CitrixTemplateGroup.md) | Creates a new Group in the Citrix Optimizer template | |
| 46 | +| [New-CitrixTemplateRegistry](Help/New-CitrixTemplateRegistry.md) | Creates a new Windows Registry definition in the Citrix Optimizer template | |
| 47 | +| [New-CitrixTemplateService](Help/New-CitrixTemplateService.md) | Creates a new Windows Service definition in the Citrix Optimizer template | |
| 48 | +| [New-CitrixTemplateTask](Help/New-CitrixTemplateTask.md) | Creates a new Windows Scheduled Task definition in the Citrix Optimizer template | |
| 49 | + |
| 50 | +## Recommended Content |
| 51 | + |
| 52 | +[Citrix Optimizer Tool](https://support.citrix.com/article/CTX224676/citrix-optimizer-tool) (Citrix docs) |
| 53 | +The official Citrix Optimizer tool. |
0 commit comments