-
-
-
-
-
-
Get-ConfigRegisteredServiceInstance
-
-
-
-
-
-
-
-
-
-
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!
Get-ConfigRegisteredServiceInstance
Gets the service instances that are registered in the directory.
Syntax
Get-ConfigRegisteredServiceInstance
[-ServiceInstanceUid <Guid>]
[-ServiceGroupUid <Guid>]
[-ServiceGroupName <String>]
[-ServiceType <String>]
[-Address <String>]
[-Binding <String>]
[-Version <Int32>]
[-ServiceAccountSid <String>]
[-InterfaceType <String>]
[-Metadata <String>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Use this cmdlet to retrieve the service instances currently registered with the Configuration Service that match the parameters supplied. If no parameters are supplied, all the service instances are returned.
Examples
EXAMPLE 1
Return all the service instances that are registered in the Configuration Service.
C:\>Get-ConfigRegisteredServiceInstance
Address : http://MyServer.com:80/Citrix/MyContract/v1
Binding : wcf_HTTP_kerb
InterfaceType : SDK
Metadata : {}
MetadataMap : {}
ServiceAccount : ENG\MyAccount$
ServiceAccountSid : S-1-5-21-1155438255-2213498043-2452000591-1104
ServiceGroupName : MyService
ServiceGroupUid : 2b990d5a-bba9-413b-aa08-e104e67f89bc
ServiceInstanceUid : 8dc38b5a-3fbb-457c-b326-6c41c94c18d5
ServiceType : MySnapIn
Version : 1
Address : http://MyServer.com:80/Citrix/MyContract/PeerAPI/v1
Binding : wcf_HTTP_kerb
InterfaceType : Peer
Metadata : {}
MetadataMap : {}
ServiceAccount : ENG\MyAccount$
ServiceAccountSid : S-1-5-21-1155438255-2213498043-2452000591-1104
ServiceGroupName : MyService
ServiceGroupUid : 2b990d5a-bba9-413b-aa08-e104e67f89bc
ServiceInstanceUid : 8f822ed6-42f3-4a26-911a-a4a6a87c0ef2
ServiceType : MySnapIn
Version : 1
Address : http://MyServer.com:80/Citrix/MyContract/MyServiceEnvTestAPI/v1
Binding : wcf_HTTP_kerb
InterfaceType : EnvironmentTest
Metadata : {}
MetadataMap : {}
ServiceAccount : ENG\MyAccount$
ServiceAccountSid : S-1-5-21-1155438255-2213498043-2452000591-1104
ServiceGroupName : MyService
ServiceGroupUid : 2b990d5a-bba9-413b-aa08-e104e67f89bc
ServiceInstanceUid : d2d40d9b-2a5d-4c5a-b9ca-a7f73cffe4f2
ServiceType : MySnapIn
Version : 1
Address : http://MyServer.com:80/Citrix/MyContract/MyServiceAPI/v1
Binding : wcf_HTTP_kerb
InterfaceType : InterService
Metadata : {}
MetadataMap : {}
ServiceAccount : ENG\MyAccount$
ServiceAccountSid : S-1-5-21-1155438255-2213498043-2452000591-1104
ServiceGroupName : MyService
ServiceGroupUid : 2b990d5a-bba9-413b-aa08-e104e67f89bc
ServiceInstanceUid : 5d428970-2ba1-4336-b8d0-f3aa961b8983
ServiceType : MySnapIn
Version : 1
<!--NeedCopy-->
EXAMPLE 2
Return all the service instances that are registered in the Configuration Service and are of type ‘SDK’.
C:\>Get-ConfigRegisteredServiceInstance -InterfaceType "SDK"
Address : http://MyServer.com:80/Citrix/MyContract/v1
Binding : wcf_HTTP_kerb
InterfaceType : SDK
Metadata : {}
MetadataMap : {}
ServiceAccount : ENG\MyAccount$
ServiceAccountSid : S-1-5-21-1155438255-2213498043-2452000591-1104
ServiceGroupName : MyService
ServiceGroupUid : 2b990d5a-bba9-413b-aa08-e104e67f89bc
ServiceInstanceUid : 8dc38b5a-3fbb-457c-b326-6c41c94c18d5
ServiceType : MySnapIn
Version : 1
<!--NeedCopy-->
Parameters
-ServiceInstanceUid
The unique identifier for the service instance.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-ServiceGroupUid
The unique identifier for the service group to which the service instance belongs.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-ServiceGroupName
The name for the service group to which the service instance belongs.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-ServiceType
The service type for the service instance.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Address
The connection address for the service instance.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Binding
The binding for the service instance.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Version
The service instance version.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-ServiceAccountSid
The AD account SID for the computer account that the computer hosting the service instance is running as.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-InterfaceType
The interface type for the service instance.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Metadata
Gets records with matching metadata entries.
The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Property
Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReturnTotalRecordCount
See about_Config_Filtering for details.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MaxRecordCount
See about_Config_Filtering for details.
Type: | Int32 |
Position: | Named |
Default value: | 250 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Skip
See about_Config_Filtering for details.
Type: | Int32 |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SortBy
See about_Config_Filtering for details.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Filter
See about_Config_Filtering for details.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FilterScope
Gets only results allowed by the specified scope id.
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 ———– PartialData
Only a subset of the available data was returned.
CouldNotQuueryDatabase
The query required to get the database was not defined.
CommunicationError
An error occurred while communicating with the service.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
InvalidFilter
A filtering expression was supplied that could not be interpreted for this cmdlet.
ExceptionThrown
An unexpected error occurred. To locate more details see the Windows event logs on the controller being used, or examine the XenDesktop logs.
Related Links
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.