-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
Register-ConfigServiceInstance
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Register-ConfigServiceInstance
Allows the registration of a service instance.
Syntax
Register-ConfigServiceInstance
[-LoggingId <Guid>]
-ServiceInstance <ServiceInstance[]>
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Register-ConfigServiceInstance
-ServiceGroupUid <Guid>
-ServiceGroupName <String>
-ServiceType <String>
-Address <String>
-Binding <String>
-Version <Int32>
-ServiceAccount <String>
-InterfaceType <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Register-ConfigServiceInstance
-ServiceGroupUid <Guid>
-ServiceGroupName <String>
-ServiceType <String>
-Address <String>
-Binding <String>
-Version <Int32>
-ServiceAccountSid <String>
-InterfaceType <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
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
<!--NeedCopy-->
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 <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 ———– 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.
Related Links
- about_ConfigConfigurationSnapin
- Unregister-ConfigRegisteredServiceInstance
- Add-ConfigRegisteredServiceInstanceMetadata
- Set-ConfigRegisteredServiceInstanceMetadata
- Remove-ConfigRegisteredServiceInstanceMetadata
- Add-ConfigServiceGroupMetadata
- Set-ConfigServiceGroupMetadata
- Remove-ConfigServiceGroupMetadata
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.