Set-ConfigRegisteredServiceInstance¶

Updates a service instance.

Syntax¶

Set-ConfigRegisteredServiceInstance -ServiceInstanceUid <Guid> -Address <String> [-PassThru] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description¶

Use this cmdlet to change the address property of an existing service instance that is registered in the Configuration Service.

Parameters¶

Name	Description	Required?	Pipeline Input	Default Value
ServiceInstanceUid	The unique identifier for the service instance to be updated.	true	true (ByPropertyName)
Address	The new address for the service instance.	true	false
PassThru	Defines whether or not the command returns a result showing the new state of the updated service instance.	false	false	true
LoggingId	Specifies the logging id of the high-level operation this cmdlet invocation is part of.	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 use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	Specifies the address of a XenDesktop controller that the PowerShell snap-in connects 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¶

Citrix.Configuration.Sdk.Serviceinstance¶

This represents a service instance and has the following parameters:

ServiceGroupUid <Guid> The unique identifier for the service group to which the service instance belongs.
ServiceGroupName <string> The name of the service group to which the service instance belongs.
ServiceInstanceUid <Guid> The unique identifier for the service instance.
ServiceType <string> The type of the service group.
Address <string> The contact address for the service instance.
Binding <string> The binding to use for connections to the service instance.
Version <int> The version of the service instance.
ServiceAccount <string> The AD computer account for the computer that is providing the service instance.
ServiceAccountSid <string> The AD computer account SID for the computer that is providing the service instance.
InterfaceType <string> The interface type for the service instance.
Metadata <Citrix.Configuration.Sdk.Metadata[]> The metadata for the service instance.

Notes¶

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

ObjectToUpdateDoesNotExist: The service instance specified could not be located.
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.
ExceptionThrown: An unexpected error occurred.

For more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.

Examples¶

Example 1¶

C:\PS>Set-ConfigRegisteredServiceInstance -ServiceInstanceUid "9805f39d-99eb-44f0-8f63-9d8e3f1228e0" -Address "http://myServer.com/Citrix/sdkHostingUnitService"

Description¶

Update the service instance with the unique identifier of '9805f39d-99eb-44f0-8f63-9d8e3f1228e0' to use the new address.