Citrix Virtual Apps and Desktops SDK

Add-ProvImageVersionSpec

April 19, 2024

Contributed by:

Add a master image version spec.

Syntax

Add-ProvImageVersionSpec
   -ImageVersionUid <Guid>
   -HostingUnitUid <Guid>
   -MasterImagePath <String>
   [-Metadata <Hashtable>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Add-ProvImageVersionSpec
   -ImageDefinitionName <String>
   -ImageVersionNumber <Int32>
   -HostingUnitName <String>
   -MasterImagePath <String>
   [-Metadata <Hashtable>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to add a master image version spec.

Examples

EXAMPLE 1

Add an image version spec.

Add-ProvImageVersionSpec -ImageVersionUid f6ab733f-b5f5-4399-8e86-8a1e6e35b500 -HostingUnitUid dbd46d48-e65e-4bae-bd24-59713654cd10 -MasterImagePath XDHyp:\HostingUnits\hu\image.folder\snapshot.snapshot

Context                   :
CreationTime              : 9/27/2023 1:11:26 AM
DiskSize                  : 0
Errors                    :
HostingUnitName           : azure
HostingUnitUid            : 0f0d18cf-bbdf-4741-9c3a-452fbaa6bcef
ImageDefinitionName       : imagedef1
ImageDefinitionUid        : 6e16c751-0170-4cb2-be5a-8325ba396549
ImageVersionSpecStatus    : None
ImageRuntimeInfo          :
ImageScheme               :
ImageVersionNumber        : 1
ImageVersionSpecUid       : f80ede4d-4c43-4acc-8181-468af5f014f7
ImageVersionUid           : 22c1f813-0496-4bf5-9f25-ea9cf0b8b82e
ImportType                : Customer
IsCitrixManaged           : False
IsPrepared                : False
MasterImagePath           : /image.folder/snapshot.snapshot
Metadata                  : {}
PreparationType           : None
ImageInstances    :
SourceImageVersionSpecUid : 00000000-0000-0000-0000-000000000000
Warnings                  : {}
<!--NeedCopy-->

Parameters

-ImageVersionUid

The identifier for the image version used for the image version spec.

Type:	Guid
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-HostingUnitUid

The identifier for the hosting unit used for the image version spec.

Type:	Guid
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-MasterImagePath

The path in the hosting unit provider to the virtual machine snapshot that will be used. This identifies the hard disk to be used and the default values for the memory and processors. This must be a path to a Snapshot item in the same hosting unit that the hosting unit name or hosting unit Uid refers to.

Valid paths are of the format; XDHyp:\HostingUnits\<HostingUnitName>\<path>\<VMName>.vm\<SnapshotName>.snapshot

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ImageDefinitionName

The name of image definition used for the image version spec.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-ImageVersionNumber

The version number used for the image version spec.

Type:	Int32
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-HostingUnitName

The name of the hosting unit to be used for the image version spec.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Metadata

Gets or sets metadata of the image version.

Type:	Hashtable
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.Host.DataModel.ImageVersionSpec

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

ImageVersionSpecUid <Guid>

The unique identifier of the image version spec.

ImageVersionNumber <string>

The version number of the image versions.

ImageVersionUid <Guid>

The unique identifier of the image versions.

ImageDefinitionName <string>

The name of the image definition.

HostingUnitName <string>

The name of the hosting unit being used by this image version spec.

HostingUnitUid <Guid>

The unique identifier of the hosting unit being used by this image version spec.

Context <string>

The context of the image version spec.

CreationTime <DateTime>

The creation time of the image version spec.

Error <Citrix.Fma.Sdk.ServiceCore.CommonCmdlets.TaskTerminatingError>

Errors that have occurred with this image version spec.

ImageInstances <Citrix.MachineCreation.DataModel.ImageInstance[]>

Image replication information for this image version.

ImageRuntimeInfo <string>

The image runtime information like operating system info, VDA components, etc.

ImageVersionSpecStatus <string>

The status of this image version spec.

ImportType <string>

Indicate if this image version spec is imported by user.

PreparationType <string>

The preparation type of the image version spec

IsCitrixManaged <bool>

Indicate if this image version spec is managed by Citrix.

MasterImagePath <string>

The inventory path to the VM snapshot copy used in this image version spec.

Metadata <IDictionary<string,string>>

The metadata associated with this image version spec.

Warnings <Citrix.MachineCreation.DataModel.ProvSchemeWarning[]>

Warning states that have occurred with this image version spec.

ZoneUid <Guid>

The unique identifier of the zone.

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.

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

Add-ProvImageVersionSpec

April 19, 2024

Contributed by:

April 19, 2024

Contributed by:

Add-ProvImageVersionSpec

Syntax

Description

Examples

EXAMPLE 1

Parameters

-ImageVersionUid

-HostingUnitUid

-MasterImagePath

-ImageDefinitionName

-ImageVersionNumber

-HostingUnitName

-Metadata

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Host.DataModel.ImageVersionSpec

Notes

Related Links

In this article