Product Documentation

Get-ConfigRegisteredServiceInstance

Oct 12, 2015

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>] [-AdminAddress <String>] [<CommonParameters>]

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

-ServiceInstanceUid<Guid>

The unique identifier for the service instance.

Required? false
Default Value  
Accept Pipeline Input? false

-ServiceGroupUid<Guid>

The unique identifier for the service group to which the service instance belongs.

Required? false
Default Value  
Accept Pipeline Input? false

-ServiceGroupName<String>

The name for the service group to which the service instance belongs.

Required? false
Default Value  
Accept Pipeline Input? false

-ServiceType<String>

The service type for the service instance.

Required? false
Default Value  
Accept Pipeline Input? false

-Address<String>

The connection address for the service instance.

Required? false
Default Value  
Accept Pipeline Input? false

-Binding<String>

The binding for the service instance.

Required? false
Default Value  
Accept Pipeline Input? false

-Version<Int32>

The service instance version.

Required? false
Default Value  
Accept Pipeline Input? false

-ServiceAccountSid<String>

The AD account SID for the computer account that the computer hosting the service instance is running as.

Required? false
Default Value  
Accept Pipeline Input? false

-InterfaceType<String>

The interface type for the service instance.

Required? false
Default Value  
Accept Pipeline Input? false

-Metadata<String>

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

Required? false
Default Value  
Accept Pipeline Input? false

-Property<String[]>

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.

Required? false
Default Value  
Accept Pipeline Input? false

-ReturnTotalRecordCount<SwitchParameter>

See about_Configfiltering for details.

Required? false
Default Value false
Accept Pipeline Input? false

-MaxRecordCount<Int32>

See about_Configfiltering for details.

Required? false
Default Value 250
Accept Pipeline Input? false

-Skip<Int32>

See about_Configfiltering for details.

Required? false
Default Value 0
Accept Pipeline Input? false

-SortBy<String>

See about_Configfiltering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-Filter<String>

See about_Configfiltering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

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.

Required? false
Default Value LocalHost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

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

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

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