Set-ProvImageDefinition
Changes the parameter values for a image definition.
Syntax
Set-ProvImageDefinition
-ImageDefinitionUid <Guid>
[[-Description] <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-ProvImageDefinition
[-ImageDefinitionName] <String>
[[-Description] <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to update the parameters of an existing image definition.
The following parameters are allowed to be updated:
The description of the image definition.
Examples
EXAMPLE 1
Update a image definition name with uid "7585f0de-192e-4847-a6d8-22713c3a2f42".
Set-ProvImageDefinition -ImageDefinitionUid 7585f0de-192e-4847-a6d8-22713c3a2f42 -Description 'Windows image'
CreationTime : 1/1/2022 12:00:00
Description : Windows image
OsType : Windows
VDASessionSupport : MultiSession
ImageDefinitionName : Image1
ImageDefinitionUid : 7585f0de-192e-4847-a6d8-22713c3a2f42
Metadata :
LatestVersion : 2
VersionsCount : 2
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 |
-ImageDefinitionUid
The identifier of the image definition to be updated.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
-Description
A value indicating the image definition description.
| Type: | String |
| Position: | 3 |
| 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.ImageDefinition
This object provides details of the image definition and contains the following information:
CreationTime \<DateTime\>
The date and time when the image definition was created.
Description \<string\>
The description of the image definition.
OsType \<string\>
The OS type for the image versions in this image definition.
VDASessionSupport \<string\>
The Session support of VDA for this image definition.
ImageDefinitionName \<string\>
The name of the image definition.
ImageDefinitionUid \<Guid\>
The unique identifier for the image definition.
Metadata \<System.Collections.Generic.Dictionary\[string, string\];\>
The metadata to apply to the image definition, if specified.
LatestVersion \<int\>
The latest version number in this definition.
VersionsCount \<int\>
The total versions count in this definition.
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.