Citrix.Image.Uploader PowerShell module
This document goes over basic steps to install, update, and uninstall the Citrix.Image.Uploader Powershell module. This module provides functionality to upload a VHD(x) from the SMB file share to a designated target environment.
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.Image.Uploader module:
Install-Module -Name "Citrix.Image.Uploader" -Scope CurrentUser
<!--NeedCopy-->
Run the following PowerShell command to install a specific version of the Citrix.Image.Uploader module:
Install-Module -Name "Citrix.Image.Uploader" -RequiredVersion 1.0.0 -Scope CurrentUser
<!--NeedCopy-->
Confirm the module was successfully installed by running the command:
Get-InstalledModule -Name "Citrix.Image.Uploader"
<!--NeedCopy-->
This command returns an output similar to the following:
| Name | Repository | Description |
|---|---|---|
| Citrix.Image.Uploader | PSGallery | Commands to Upload a VHD(x) to an Azure Storage Account, AWS, or GCP and Get information about a VHD(x) |
Update modules to latest version
Run the following command to update the module to the latest version:
Update-Module -Name "Citrix.Image.Uploader" -Force
<!--NeedCopy-->
Run the following command to update to a specific version of the Citrix.Image.Uploader module:
Update-Module -Name "Citrix.Image.Uploader" -RequiredVersion 1.0.0
<!--NeedCopy-->
Install platform-specific third-party components
The Image Portability PowerShell module does not install third-party dependencies. Hence, you can limit installation to only the platforms you’re targeting. If you’re using one of the following platforms, follow the relevant instructions for the installation of platform dependencies.
Note:
Installing third-party components is only required for use with our Citrix.Image.Uploader PowerShell module. These are not required for running export or prepare tasks.
Azure
If you’re uploading images to Azure, download and install the Azure command-line utilities, then run these commands to install the required Azure PowerShell modules:
Install-Module -Name Az.Accounts -Scope CurrentUser -AllowClobber -Force
Install-Module -Name Az.Compute -Scope CurrentUser -AllowClobber –Force
<!--NeedCopy-->
Uninstall libraries and modules
Run the following command to uninstall the module:
Get-InstalledModule -Name "Citrix.Image.Uploader" | Uninstall-Module
<!--NeedCopy-->
Run the following command to uninstall a specific version of the Citrix.Image.Uploader module:
Uninstall-Module -Name "Citrix.Image.Uploader" -RequiredVersion 1.0.0
<!--NeedCopy-->
Note:
Third-party scripts and components aren’t automatically removed when uninstalling IPS modules.
Basic usage and examples
Once the module is installed, you can view the available commands in the Citrix.Image.Uploader PowerShell module by running:
Get-Command -Module "Citrix.Image.Uploader"
<!--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.