Citrix Virtual Apps and Desktops SDK

Unpublish-ProvMasterVMImage

August 3, 2023

Contributed by:

Remove a prepared master image from the provisioning scheme.

Syntax

Unpublish-ProvMasterVMImage [-ProvisioningSchemeName] <String> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Unpublish-ProvMasterVMImage -ProvisioningSchemeUid <Guid> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Unpublish-ProvMasterVMImage -VMImageHistoryUid <Guid> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to remove a hard disk image that has been prepared to provision virtual machines.

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.

The affected hard disk image is removed from the history (see Get-ProvSchemeMasterVMImageHistory).

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ProvisioningSchemeName	The provisioning scheme from which the surplus hard disk images should be removed.	true	true (ByPropertyName)
ProvisioningSchemeUid	The provisioning scheme identifier from which the surplus hard disk images should be removed.	true	false
VMImageHistoryUid	The specific master image for which hard disk images should be removed.	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
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	Specifies the address of a XenDesktop 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

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.

Examples

Example 1

c:\PS>Unpublish-ProvMasterVMImage -ProvisioningSchemeName MyScheme

<!--NeedCopy-->

Description

Removes the prepared master hard disk image for the provisioning Scheme “MyScheme”.

Example 2

c:\PS>Unpublish-ProvMasterVMImage -VMImageHistoryUid 7585f0de-192e-4847-a6d8-22713c3a2f42 -Revoke

<!--NeedCopy-->

Description

Removes a prepared image identified by its history record.

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 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Unpublish-ProvMasterVMImage

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Notes

Examples

Example 1

Description

Example 2

Description

In this article