Citrix Virtual Apps and Desktops SDK

Set-Configregisteredserviceinstancemetadata

August 3, 2023

Contributed by:

Adds or updates metadata on the given ServiceInstance.

Syntax

Set-ConfigRegisteredServiceInstanceMetadata [-ServiceInstanceUid] <Guid> -Name <String> -Value <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-ConfigRegisteredServiceInstanceMetadata [-ServiceInstanceUid] <Guid> -Map <PSObject> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-ConfigRegisteredServiceInstanceMetadata [-InputObject] <ServiceInstance[]> -Name <String> -Value <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-ConfigRegisteredServiceInstanceMetadata [-InputObject] <ServiceInstance[]> -Map <PSObject> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Provides the ability for additional custom data to be stored against given ServiceInstance objects.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ServiceInstanceUid	Id of the ServiceInstance	true	true (ByValue, ByPropertyName)
InputObject	Objects to which the metadata is to be added.	true	true (ByValue)
Name	Specifies the property name of the metadata to be added. The property must be unique for the ServiceInstance specified. The property cannot contain any of the following characters \/;:#.*?=<>	“’	true	false
Value	Specifies the value for the property.	true	false
Map	Specifies a dictionary of (name, value)-pairs for the properties. This can either be a hashtable (created with @{“name1” = “val1”; “name2” = “val2”}) or a string dictionary (created with new-object “System.Collections.Generic.Dictionary[String,String]”).	true	true (ByValue)
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 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

System.Collections.Generic.Dictionary[String,String]
Set-Configregisteredserviceinstancemetadata Returns A Dictionary Containing The New (Name, Value)-Pairs.
Key <String>
Specifies The Name Of The Property.
Value <String>
Specifies The Value For The Property.

Notes

If the command fails, the following errors can be returned.
Error Codes
———–
InvalidParameterCombination
The cmdlet parameters are inconsistent.
UnknownObject
One of the specified objects was not found.
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.
PermissionDenied
You do not have permission to execute this command.
AuthorizationError
There was a problem communicating with the Citrix Delegated Administration Service.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error.
CommunicationError
There was a problem communicating with the remote service.
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs on the controller or the XenDesktop logs.

Examples

Example 1

c:\PS>Set-ConfigRegisteredServiceInstanceMetadata -ServiceInstanceUid 4CECC26E-48E1-423F-A1F0-2A06DDD0805C -Name property -Value value

          Key                                       Value

          ---                                       -----

          property                                  value
<!--NeedCopy-->

Description

Add metadata with a name of ‘property’ and a value of ‘value’ to the ServiceInstance with the identifier ‘4CECC26E-48E1-423F-A1F0-2A06DDD0805C’.

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

Set-Configregisteredserviceinstancemetadata

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Set-Configregisteredserviceinstancemetadata

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

System.Collections.Generic.Dictionary[String,String] Set-Configregisteredserviceinstancemetadata Returns A Dictionary Containing The New (Name, Value)-Pairs. Key <String> Specifies The Name Of The Property. Value <String> Specifies The Value For The Property.

Notes

Examples

Example 1

Description

In this article

System.Collections.Generic.Dictionary[String,String]
Set-Configregisteredserviceinstancemetadata Returns A Dictionary Containing The New (Name, Value)-Pairs.
Key <String>
Specifies The Name Of The Property.
Value <String>
Specifies The Value For The Property.