Product Documentation


Oct 21, 2016

Creates a new icon.


New-BrokerIcon [-EncodedIconData] <String> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Accepts Base64 encoded .ICO format icon data, stores it in the database and returns an Icon object containing the Uid assigned to it.

New-BrokerIcon can be used with the Get-CtxIcon cmdlet from Citrix.Common.Commands, to obtain the Base64 icon. See Examples for a demonstration.

Related topics






Specifies the Base64 encoded .ICO format icon data.

Required? true
Default Value  
Accept Pipeline Input? true (ByPropertyName)


Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Required? false
Default Value  
Accept Pipeline Input? false


Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

None Input cannot be piped to this cmdlet.

Return Values


Returns an Icon object.


-------------------------- EXAMPLE 1 --------------------------

C:\PS> Add-PSSnapin Citrix.Common.Commands 
C:\PS> $ctxIcon = Get-CtxIcon -FileName C:\Windows\System32\notepad.exe -index 0 
C:\PS> $brokerIcon = New-BrokerIcon -EncodedIconData $ctxIcon.EncodedIconData 
C:\PS> $desktopGroup = Get-BrokerDesktopGroup -Name 'MyDesktopGroup' 
C:\PS> Set-BrokerDesktopGroup $desktopGroup -IconUid $brokerIcon.Uid

Extracts the first icon resource from notepad.exe, and sets this as the icon for a desktop group.