Citrix Virtual Apps and Desktops SDK

Unpublish-ProvMasterVMImage

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2012

Remove a prepared master image from a provisioning scheme.

Syntax

Unpublish-ProvMasterVMImage
         -VMImageHistoryUid <Guid>
         [-LoggingId <Guid>]
         [<CitrixCommonParameters>]
         [<CommonParameters>]
<!--NeedCopy-->

Unpublish-ProvMasterVMImage
         [-ProvisioningSchemeName] <String>
         [-LoggingId <Guid>]
         [<CitrixCommonParameters>]
         [<CommonParameters>]
<!--NeedCopy-->

Unpublish-ProvMasterVMImage
         -ProvisioningSchemeUid <Guid>
         [-LoggingId <Guid>]
         [<CitrixCommonParameters>]
         [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to remove a master image and its hard disk copies that has been prepared for a provisioning scheme to create virtual machines.

The master image is removed from the image history of the provisioning scheme (see Get-ProvSchemeMasterVMImageHistory).

A background task will be created to remove the old hard disk copies. You can locate and monitor this task using the Get-ProvTask cmdlet.

Examples

EXAMPLE 1

Removes the prepared master images for the provisioning Scheme “MyScheme”.

Unpublish-ProvMasterVMImage -ProvisioningSchemeName MyScheme
<!--NeedCopy-->

EXAMPLE 2

Removes a prepared image identified by its history record.

Unpublish-ProvMasterVMImage -VMImageHistoryUid 7585f0de-192e-4847-a6d8-22713c3a2f42 -Revoke
<!--NeedCopy-->

Parameters

-ProvisioningSchemeUid

Unique identifier of the provisioning scheme from which the specified master image should be removed.

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

-VMImageHistoryUid

Unique identifier of the master image to be removed.

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

-ProvisioningSchemeName

Name of the provisioning scheme from which the specified master image should be removed.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
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

Citrix.MachineCreation.Sdk.ProvisioningScheme

You can pipe an object containing a parameter called ‘ProvisioningSchemeName’ to Unpublish-ProvMasterVMImage.

Outputs

None

By default, this cmdlet returns no output.

Notes

If a VM Image History UID is specified, the cmdlet will remove the image if it is in the prepared state. If the image is the current image of the provisioning scheme, an error will be returned: there must be a current image associated with a provisioning scheme. The Publish-ProvMasterVMImage cmdlet may be used to replace a current image with a new or previously prepared image.

If a provisioning scheme name or UID is specified, the cmdlet will remove the prepared master image associated with that provisioning scheme if it exists. No error will be returned if no prepared image exists. The current image of the scheme will not be removed.

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

Error Codes

ProvisioningSchemeNotFound

The specified provisioning scheme could not be located.

ProvisioningSchemeNotReady

The specified provisioning scheme is not in Ready state.

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

Unpublish-ProvMasterVMImage

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Unpublish-ProvMasterVMImage

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-ProvisioningSchemeUid

-VMImageHistoryUid

-ProvisioningSchemeName

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.MachineCreation.Sdk.ProvisioningScheme

Outputs

None

Notes

Related Links

In this article