Citrix Daas SDK


Adds metadata on the given image version scheme.


Add-ProvImageVersionMetadata [-PreparedImageVersionUid] <Guid> -Name <String> -Value <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Add-ProvImageVersionMetadata [-PreparedImageVersionUid] <Guid> -Map <PSObject> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Add-ProvImageVersionMetadata [-PreparedImageDefinitionName] <String> [-PreparedImageVersionNumber] <String> -Name <String> -Value <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Add-ProvImageVersionMetadata [-PreparedImageDefinitionName] <String> [-PreparedImageVersionNumber] <String> -Map <PSObject> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Add-ProvImageVersionMetadata [-InputObject] <ImageVersion[]> -Name <String> -Value <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Add-ProvImageVersionMetadata [-InputObject] <ImageVersion[]> -Map <PSObject> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Provides the ability for additional custom data to be stored against given image version objects. This cmdlet will not overwrite existing metadata on an object - use the Set-ImageVersionMetadata cmdlet instead.


Name Description Required? Pipeline Input Default Value  
PreparedImageVersionUid Id of the image verison true true (ByValue, ByPropertyName)    
PreparedImageDefinitionName Name of the image definition true true (ByValue, ByPropertyName)    
PreparedImageVersionNumber Version number of the image version true true (ByValue, ByPropertyName)    
InputObject ImageVersion objects to which the metadata is to be added. true true (ByValue)    
Name Specifies the property name of the metadata to be added. The property must be unique for the image version specified. The property cannot contain any of the following characters \/;:#.*?=<> []()”’ true false  
Value Specifies the value for the property. true false    
Map Specifies a dictionary of (name, value)-pairs for the properties. This can either be a hashtable (created with @{“name1” = “val1”; “name2” = “val2”}) or a string dictionary (created with new-object “System.Collections.Generic.Dictionary[string, string];”). true true (ByValue)    
LoggingId Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and 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. false false    
BearerToken Specifies the bearer token assigned to the calling user false false    
AdminClientIP Specifies the Client IP of the calling user false false    
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false    
TraceState Specifies the trace state assigned for internal diagnostic tracing user false false    
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false    
AdminAddress The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.  

Input Type


You can pipe a ImageVersion object or any object containing a parameter called ‘ImageDefinitionName’ and ‘ImageVersionNumber’ or ‘ImageVersionUid’ to Add-ImageVersionMetadata.


A metadata map object can be piped to the Add-ImageVersionMetadata command.

Return Values


Add-ProvImageVersionMetadata returns an array of objects containing the newly added metadata.
Property <string> Name of the property. Value <string> Value for the property.


If the command fails, the following errors can be returned.
Error Codes ———– InvalidParameterCombination The cmdlet parameters are inconsistent.
ImageVersionNotFound One of the specified image version was not found.
DuplicateObject One of the specified metadata already exists.
DatabaseError An error occurred in the service while attempting a database operation.
DatabaseNotConfigured The operation could not be completed because the database for the service is not configured.
DataStoreException An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
PermissionDenied You do not have permission to execute this command.
AuthorizationError There was a problem communicating with the Citrix Delegated Administration Service.
ConfigurationLoggingError The operation could not be performed because of a configuration logging error.
CommunicationError There was a problem communicating with the remote service.
ExceptionThrown An unexpected error occurred. For more details, see the Windows event logs on the controller or the Citrix Virtual Apps and Desktops logs.


Example 1

c:\PS>Add-ProvImageVersionMetadata -PreparedImageVersionUid 4CECC26E-48E1-423F-A1F0-2A06DDD0805C -Name property -Value value<br /><br />          Property                                  Value<br /><br />          --------                                  -----<br /><br />          property                                  value


Add metadata with a name of ‘property’ and a value of ‘value’ to the image version with the identifier ‘4CECC26E-48E1-423F-A1F0-2A06DDD0805C’.