Developer Documentation
Citrix Daas SDK

Add-HypMetadata

August 9, 2024
Contributed by: 
C C

Adds metadata to a hypervisor connection or a hosting unit.

Syntax

Add-HypMetadata
   [-Property] <String>
   [-Value] <String>
   [-LiteralPath] <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Use this command to store additional custom data against a hosting unit or hypervisor connection. This data is not used by the Machine Creation Service, and is provided only for consumers of the services to store any data that may be required for their operations. The metadata is returned along with the hypervisor connection or hosting unit that it is assigned to.

Examples

EXAMPLE 1

The command adds the metadata with the property name of “MyProperty” and value of “MyValue” to the hypervisor connection item called “MyConnection”.

Add-HypMetadata -LiteralPath XDHyp:\Connections\MyConnection -Property MyProperty -Value MyValue

Property                                                    Value
--------                                                    -----
MyProperty                                                  MyValue
<!--NeedCopy-->

EXAMPLE 2

The command adds the metadata with the property name of “MyProperty” and value of “MyValue” to all the hypervisor connection items that begin with the string “Citrix”.

dir xdhyp\connections\Citrix* | Add-HypMetadata -Property MyProperty -Value MyValue

Property                                                    Value
--------                                                    -----
MyProperty                                                  MyValue
MyProperty                                                  MyValue
MyProperty                                                  MyValue
<!--NeedCopy-->

Parameters

-LiteralPath

Specifies the path within a hosting unit provider to the hosting unit or hypervisor connection item to which to add the metadata. The path specified must be in one of the following formats:

<drive>:\HostingUnits\<HostingUnitName>

or <drive>:\HostingUnits{<HostingUnit Uid>}

or <drive>:\Connections\<Connection Name>

or <drive>:\Connections{<Connection Uid>}

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

-Property

Specifies the property name of the metadata to be added. The property must be unique for the item specified by the path.

The property cannot contain any of the following characters \/;:#.*?=<>|[]()””’

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

-Value

Specifies the value for the property.

Type: String
Position: 3
Default value: None
Required: True
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

String

You can pipe a string the contains a path to Add-HypMetadata (Path parameter).

Outputs

Citrix.Host.Sdk.Metadata

Add-HypMetadata returns an array of objects containing the new definition of the metadata.

  • Property <string>

    Specifies the name of the property.

  • Value <string>

    Specifies the value for the property.

Notes

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

Error Codes

InvalidPath

The path provided is not in the required format.

HostingUnitMetadataForeignKeyObjectDoesNotExist

The hosting unit supplied in the path does not exist.

HypervisorConnectionMetadataForeignKeyObjectDoesNotExist

The hypervisor connection supplied in the path does not exist.

HostingUnitMetadataDuplicateObjectExists

Metadata for the specified hosting unit item already exists with the same property name.

HypervisorConnectionMetadataDuplicateObjectExists

Metadata for the specified hypervisor connection item already exists with the same property name.

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.

Add-HypMetadata
August 9, 2024
Contributed by: 
C C
August 9, 2024
Contributed by: 
C 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.