Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Remove-Hypmetadata

August 3, 2023
Contributed by: 
C

Removes metadata from a hypervisor connection or hosting unit.

Syntax

Remove-HypMetadata [-LiteralPath] <String> [-Property <String>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Use this command to remove custom data from a specific hosting unit or hypervisor connection. If the Property parameter is not provided, all metadata is removed from the specified item.

Parameters

Name Description Required? Pipeline Input Default Value
LiteralPath Specifies the path within a Host Service provider to the hosting unit or hypervisor connection item from which to remove the metadata. The path specified must be in one of the following formats: :\HostingUnits\ or :\HostingUnits{ or :\Connections\ or :\Connections{} true true (ByValue)  
Property Specifies the property name of the metadata to be removed. false 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  
AdminAddress Specifies the address of a XenDesktop controller that the PowerShell snap-in will connect to. This can be provided as a host name or an IP address. false false LocalHost. Once a value is provided by any cmdlet, this value will become the default.

Input Type

System.String
You Can Pipe A String That Contains A Path To Add-Hypmetadata (Path Parameter).

Return Values

Notes

In the case of failure, the following errors can result.
Error Codes
———–
InvalidPath
The path provided is not in the required format.
HostingUnitMetadataObjectToDeleteDoesNotExist
The hosting unit supplied in the path does not exist.
HypervisorConnectionObjectToDeleteDoesNotExist
The hypervisor connection supplied in the path does not exist.
MetadataContainerUndefined
The specified path does not reference a hosting unit or a hypervisor connection.
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.
DataStoreException
An error occurred in the service while attempting a database operation - communication with the database failed for
various reasons.
CommunicationError
An error occurred while communicating with the service.
PermissionDenied
The user does not have administrative rights to perform this operation.
ExceptionThrown
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.

Examples

Example 1 

C:\PS>Remove-HypMetadata -LiteralPath XDHyp:\Connections\MyConnection -Property MyProperty
<!--NeedCopy-->

Description

The command removes the metadata with the property “MyProperty” from the hypervisor connection called “MyConnection”.

Example 2 

C:\PS>Remove-HypMetadata -LiteralPath XDHyp:\Connections\MyConnection
<!--NeedCopy-->

Description

The command removes all the metadata from the hypervisor connection called “MyConnection”.

Example 3 

C:\PS>dir XDHyp:\connections | Remove-HypMetadata
<!--NeedCopy-->

Description

The command removes all the metadata from all the hypervisor connections.

Remove-Hypmetadata
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.