Citrix.AppLayering PowerShell module
This document goes over basic steps to install, update, and uninstall the Citrix.AppLayering Powershell module. When working with Image Portability, this module provides functionality to perform export, prepare, and diagnostic tasks.
For more information on the associated cmdlets and examples on how to use them, refer to the following documentation.
Install libraries and modules
Image Portability uses libraries from the Microsoft PowerShell Gallery to drive portability operations.
Run the following PowerShell command to install the latest version of the Citrix.AppLayering module:
Install-Module -Name "Citrix.AppLayering" -Scope CurrentUser
<!--NeedCopy-->
Run the following PowerShell command to install a specific version of the Citrix.AppLayering module:
Install-Module -Name "Citrix.AppLayering" -RequiredVersion 1.0.0 -Scope CurrentUser
<!--NeedCopy-->
Confirm the module was successfully installed by running the command:
Get-InstalledModule -Name "Citrix.AppLayering"
<!--NeedCopy-->
This command returns an output similar to the following:
| Name | Repository | Description |
|---|---|---|
| Citrix.AppLayering | PSGallery | Commands to Export and Prepare an image, and additional ways to interact with the App Layering appliance |
Update modules to latest version
Run the following command to update the module to the latest version:
Update-Module -Name "Citrix.AppLayering" -Force
<!--NeedCopy-->
Run the following command to update to a specific version of the Citrix.AppLayering module:
Update-Module -Name "Citrix.AppLayering" -RequiredVersion 1.0.0
<!--NeedCopy-->
Note:
If the Citrix.AppLayering PowerShell module is updated to a version that is not supported by your current App Layering appliance some cmdlets may not function correctly. This will require one of the following:
- Install or update your Citrix.AppLayering Powershell module to the version specified by the failed Image Portability task
- Upgrade your App Layering appliance
Uninstall libraries and modules
Run the following command to uninstall the Citrix.AppLayering module:
Get-InstalledModule -Name "Citrix.AppLayering" | Uninstall-Module
<!--NeedCopy-->
Run the following command to uninstall a specific version of the Citrix.AppLayering module:
Uninstall-Module -Name "Citrix.AppLayering" -RequiredVersion 1.0.0
<!--NeedCopy-->
Basic usage and examples
Once the module is installed, you can view the available commands in the Citrix.AppLayering PowerShell module by running:
Get-Command -Module "Citrix.AppLayering"
<!--NeedCopy-->
To get detailed information about a specific command, including its description and usage examples, use:
Get-Help <Command-Name> -Full
<!--NeedCopy-->
For a complete list of current commands and example use cases, refer to the following documentation.