Citrix Virtual Apps and Desktops SDK

Get-ConfigRegisteredServiceInstance

August 9, 2024

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>]
   [<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
Introduced in:	Citrix Virtual Apps and Desktop 7 2106

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.

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 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-ConfigRegisteredServiceInstance

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-ServiceInstanceUid

-ServiceGroupUid

-ServiceGroupName

-ServiceType

-Address

-Binding

-Version

-ServiceAccountSid

-InterfaceType

-Metadata

-Property

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Configuration.Sdk.ServiceInstance

Notes

Related Links

In this article