Register-ConfigServiceInstance

Last published : Oct 31, 2026
Allows the registration of a service instance.
Related information
about_ConfigConfigurationSnapIn

Syntax

Register-ConfigServiceInstance
        [-LoggingId <Guid>]
        -ServiceInstance <ServiceInstance[]>
        [<CitrixCommonParameters>]
        [<CommonParameters>]
Register-ConfigServiceInstance
        -ServiceGroupUid <Guid>
        -ServiceGroupName <String>
        -ServiceType <String>
        -Address <String>
        -Binding <String>
        -Version <Int32>
        -ServiceAccount <String>
        -InterfaceType <String>
        [-LoggingId <Guid>]
        [<CitrixCommonParameters>]
        [<CommonParameters>]
Register-ConfigServiceInstance
        -ServiceGroupUid <Guid>
        -ServiceGroupName <String>
        -ServiceType <String>
        -Address <String>
        -Binding <String>
        -Version <Int32>
        -ServiceAccountSid <String>
        -InterfaceType <String>
        [-LoggingId <Guid>]
        [<CitrixCommonParameters>]
        [<CommonParameters>]

Description

Use this cmdlet to register service instance items in the Configuration Service. Service instances can be registered either by retrieving the data directly from other services or by manually entering the details into this command.
If the service group specified by the service instance already exists, the service is added to the service group, otherwise a new service group is created to hold the service instance.

Examples

EXAMPLE 1

Gets the service instances for the Configuration Service and registers them.
Get-ConfigServiceInstance | Register-ConfigServiceInstance

Parameters

-ServiceGroupUid

The Service Group Unique Identifier
Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ServiceGroupName

The name of the service group
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ServiceType

The type of the service group
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Address

The address that is used to access the service instance.
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Binding

The binding type that must be used to access the service instance.
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Version

The version of the service instance.
Type: Int32
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ServiceAccount

The AD computer account name (domain qualified) for the computer on which the service instance is hosted.
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-InterfaceType

The type of interface that the service provides (i.e. SDK, InterService, Peer).
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ServiceAccountSid

The AD computer account Sid for the computer on which the service instance is hosted.
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ServiceInstance

The service instances to register.
Type: ServiceInstance[]
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-LoggingId

Specifies the logging id of the high-level operation that this cmdlet is part of.
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
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

Citrix.Configuration.Sdk.ServiceInstance

An object with the following parameters can be used to register a service instance:
  • Address
  • ServiceGroupUid
  • ServiceGroupName
  • ServiceType
  • Binding
  • Version
  • InterfaceType

Outputs

Citrix.Configuration.Sdk.ServiceInstance

This represents a service instance and has the following parameters:
  • ServiceGroupUid \&lt;Guid\>
    The unique identifier for the service group to which the service instance belongs.
  • ServiceGroupName \&lt;string\>
    The name of the service group to which the service instance belongs.
  • ServiceInstanceUid \&lt;Guid\>
    The unique identifier for the service instance.
  • ServiceType \&lt;string\>
    The type of the service group.
  • Address \&lt;string\>
    The contact address for the service instance.
  • Binding \&lt;string\>
    The binding to use for connections to the service instance.
  • Version \&lt;int\>
    The version of the service instance.
  • ServiceAccount \&lt;string\>
    The AD computer account for the computer that is providing the service instance.
  • ServiceAccountSid \&lt;string\>
    The AD computer account SID for the computer that is providing the service instance.
  • InterfaceType \&lt;string\>
    The interface type for the service instance.
  • Metadata \&lt;Citrix.Configuration.Sdk.Metadata\[\]\>
    The metadata for the service instance.

Notes

In the case of failure, the following errors can result.
Error Codes ----------- ActiveDirectoryAccountResolutionFailed
The account name provided could not be found in Active Directory.
ServiceGroupWithSameUidExistsForDifferentServiceGroupNameOrSameUidExistsForDifferentServiceGroupNameOrServiceType
The service group name or service type do not match the service group found with the specified uid.
TypeAlreadyExists
A different service group with the same type is registered already in the Configuration Service.
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.