Citrix AppLayering SDK

Citrix Uploader

Installation

Prerequisites

  • Windows operating system
  • Windows PowerShell 5.1

The Citrix.Image.Uploader module is available on the PowerShell Gallery. To install it, run the following command in an elevated PowerShell session:

Install-Module -Name Citrix.Image.Uploader -Scope CurrentUser
<!--NeedCopy-->

To install for all users (requires administrator privileges):

Install-Module -Name Citrix.Image.Uploader -Scope AllUsers
<!--NeedCopy-->

Verify Installation

After installation, verify the module is available:

Get-Module -Name Citrix.Image.Uploader -ListAvailable
<!--NeedCopy-->

Import the Module

The module will auto-import when you use any of its cmdlets, or you can explicitly import it:

Import-Module Citrix.Image.Uploader
<!--NeedCopy-->

Update the Module

To update to the latest version:

Update-Module -Name Citrix.Image.Uploader
<!--NeedCopy-->

Uninstall the Module

To remove the module:

Uninstall-Module -Name Citrix.Image.Uploader
<!--NeedCopy-->

Examples

Upload to Azure

$UploaderParams = @{
    SubscriptionId = '11111111-2222-3333-4444-555555555555'  # (guid, required) id of the subscription that contains the resource group where the uploaded disk will be created
    Location = 'eastus'  # (string, required) Azure location where the disk will be created
    ResourceGroup = 'MyResourcegroup'  # (string, required) the Azure resource group where the uploaded disk will be created
    ManagedDiskName = 'MyDisk'  # (string, required) the name to give to the Azure managed disk that is the result of the upload
    FileName = "\\smb.example.com\share\folder\disk.vhdx"  # (string, required) Filename of the disk to upload. May be a local path or a UNC path to a SMB file share.
}
Copy-DiskToAzure @UploaderParams [-Force] [-OverwriteLog] [-Install] [-Verbose]
<!--NeedCopy-->
Citrix Uploader