Set-ProvImageVersion
Changes the parameter values for an image version.
Syntax
Set-ProvImageVersion
[-ImageDefinitionName] <String>
[-ImageVersionNumber] <Int32>
[-Description <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-ProvImageVersion
-ImageVersionUid <Guid>
[-Description <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to update the parameters of an existing image version.
The following parameters are allowed to be updated:
The description of the image version.
Examples
EXAMPLE 1
Update a image definition description with image definition name "MyImage" and image version number "1".
Set-ProvImageVersion -ImageDefinitionName MyImage -ImageVersionNumber 1 -Description "version with app1"
ImageVersionNumber : 1
ImageVersionUid : b1c7602c-b080-4a63-846b-9d2429d54bd1
ImageDefinitionName : myImage
ImageDefinitionUid : 42bd09f5-3fac-44a6-8b1c-7c09f1079cc0
CreationTime : 4/2/2022 2:57:21 AM
Metadata : {}
Description : version with app1
ImageVersionSpecsCount : 0
Parameters
-ImageDefinitionName
The name of the image definition to be updated.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-ImageVersionUid
The identifier of the image version to be updated.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ImageVersionNumber
The version number of the image version to be updated.
| Type: | Int32 |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-Description
The description of the image version to be updated.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
You can't pipe objects to this cmdlet.
Outputs
Citrix.MachineCreation.Sdk.ImageVersion
This object provides details of the image version and contains the following information:
CreationTime \<DateTime\>
The date and time when the image version was created.
Description \<string\>
The description for this image version.
ImageDefinitionName \<string\>
The name of the image Definition the created image version belongs to.
ImageDefinitionUid \<Guid\>
The unique identifier of the image Definition the created image version belongs to.
ImageVersionUid \<int\>
The unique identifier for this image version.
ImageVersionNumber \<int\>
The version number fot this image version.
ImageVersionSpecsCount \<int\>
The total image version specs count in this image version.
Metadata \<System.Collections.Generic.Dictionary\[string, string\];\>
The metadata to apply to the image version, if specified.
Notes
In the case of failure, the following errors can result.
Error Codes
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.
ServiceStatusInvalidDb
An error occurred in the service while attempting a database operation - communication with the database failed for
for various reasons.
CommunicationError
An error occurred while communicating with the service.
PermissionDenied
The user does not have administrative rights to perform this operation.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error.
ExceptionThrown
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
UnsupportedByServer
The requested operation is not supported by this version of the service.