Citrix Virtual Apps and Desktops SDK

Set-ProvImageDefinition

March 11, 2024

Contributed by:

Changes the parameter values for a image definition.

Syntax

Set-ProvImageDefinition [-PreparedImageDefinitionUid] <Guid> -Description <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-ProvImageDefinition -PreparedImageDefinitionName <String> -Description <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed 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.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
PreparedImageDefinitionUid	The identifier of the image definition to be updated.	true	false
PreparedImageDefinitionName	The name of the image definition to be updated.	true	false
Description	A value indicating the image definition description.	true	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.	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

Return Values

Citrix.Machinecreation.Sdk.Imagedefinition

This object provides details of the image definitions and contains the following information:

CreateTime <DateTime> The date and time when the image definition was created. CustomProperties <string> Properties of the image definition which that are specific to the target hosting infrastructure. (See about_ProvCustomProperties) Description <string> The description for this image definition. HostingUnitName <string> The name of the hosting unit being used by this image definition. HostingUnitUid <Guid> The unique identifier of the hosting unit being used by this image definition. OsType <string> The OS type for this image definition. PreparedImageDefinitionName <string> The name of this image definition. PreparedImageDefinitionUid <Guid> The unique identifier for this image definition. UseWriteBackCache <bool> Whether to use WriteBackCache of this image definition.

Notes

In the case of failure, the following errors can result.

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.

Examples

Example 1

c:\PS>Set-ProvImageDefinition -PreparedImageDefinitionUid 7585f0de-192e-4847-a6d8-22713c3a2f42 -Description 'Windows image'

                    CreateTime                     : 1/1/2022 12:00:00

                    CustomProperties               :

                    Description                    : Windows image

                    HostingUnitName                : Hu

                    HostingUnitUid                 : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501

                    OsType                         : Windows

                    PreparedImageDefinitionName    : MyImage

                    PreparedImageDefinitionUid     : 7585f0de-192e-4847-a6d8-22713c3a2f42

                    UseWriteBackCache              : False

<!--NeedCopy-->

Description

Update a image definition name with uid “7585f0de-192e-4847-a6d8-22713c3a2f42”.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-ProvImageDefinition

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Set-ProvImageDefinition

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Machinecreation.Sdk.Imagedefinition

Notes

Examples

Example 1

Description

In this article