Citrix Virtual Apps and Desktops SDK

Get-Configregisteredserviceinstance

August 3, 2023

Contributed by:

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>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed 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.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ServiceInstanceUid	The unique identifier for the service instance.	false	false
ServiceGroupUid	The unique identifier for the service group to which the service instance belongs.	false	false
ServiceGroupName	The name for the service group to which the service instance belongs.	false	false
ServiceType	The service type for the service instance.	false	false
Address	The connection address for the service instance.	false	false
Binding	The binding for the service instance.	false	false
Version	The service instance version.	false	false
ServiceAccountSid	The AD account SID for the computer account that the computer hosting the service instance is running as.	false	false
InterfaceType	The interface type for the service instance.	false	false
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”.	false	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.	false	false
ReturnTotalRecordCount	See about_Config_Filtering for details.	false	false	false
MaxRecordCount	See about_Config_Filtering for details.	false	false	250
Skip	See about_Config_Filtering for details.	false	false	0
SortBy	See about_Config_Filtering for details.	false	false
Filter	See about_Config_Filtering for details.	false	false
FilterScope	Gets only results allowed by the specified scope id.	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.
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.

Examples

Example 1

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-->

Description

Return all the service instances that are registered in the Configuration Service.

Example 2

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-->

Description

Return all the service instances that are registered in the Configuration Service and are of type ‘SDK’.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-Configregisteredserviceinstance

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Get-Configregisteredserviceinstance

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Configuration.Sdk.Serviceinstance

Notes

Examples

Example 1

Description

Example 2

Description

In this article