Set-ConfigRegisteredServiceInstance
Updates a service instance.
Syntax
Set-ConfigRegisteredServiceInstance
-ServiceInstanceUid <Guid>
-Address <String>
[-PassThru]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Use this cmdlet to change the address property of an existing service instance that is registered in the Configuration Service.
Examples
EXAMPLE 1
Update the service instance with the unique identifier of '9805f39d-99eb-44f0-8f63-9d8e3f1228e0' to use the new address.
Set-ConfigRegisteredServiceInstance -ServiceInstanceUid "9805f39d-99eb-44f0-8f63-9d8e3f1228e0" -Address "http://myServer.com/Citrix/sdkHostingUnitService"
Parameters
-ServiceInstanceUid
The unique identifier for the service instance to be updated.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-Address
The new address for the service instance.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 500 |
-PassThru
Defines whether or not the command returns a result showing the new state of the updated service instance.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | True |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoggingId
Specifies the logging id of the high-level operation this cmdlet invocation is part of.
| 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
None
You can't pipe objects to this cmdlet.
Outputs
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.
Error Codes ----------- 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.