Product Documentation

Get-ConfigServiceGroup

Oct 12, 2015

Gets the service groups that match the parameters supplied.

Syntax

Get-ConfigServiceGroup [-ServiceGroupUid <Guid>] [-ServiceGroupName <String>] [-ServiceType <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Use this cmdlet to retrieve existing service groups that match the parameters supplied. If no parameters are supplied, all the service groups are returned.

Related topics

Parameters

-ServiceGroupUid<Guid>

The unique identifier for the service group.

Required? false
Default Value  
Accept Pipeline Input? false

-ServiceGroupName<String>

Required? false
Default Value  
Accept Pipeline Input? false

-ServiceType<String>

The service type for the service group.

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_Acctfiltering for details.

Required? false
Default Value 250
Accept Pipeline Input? false

-Skip<Int32>

See about_Acctfiltering for details.

Required? false
Default Value 0
Accept Pipeline Input? false

-SortBy<String>

See about_Acctfiltering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-Filter<String>

See about_Acctfiltering 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.ServiceGroup

This represents a service instance and has the following parameters;

ServiceGroupUid <Guid>

The unique identifier for the service group.

ServiceGroupName <string>

The name of the service group.

ServiceType <string>

The type of the service group.

Metadata <Citrix.Configuration.Sdk.Metadata[]>

The metadata for the service group.

Notes

In the case of failure, the following errors can result.

Error Codes -----------

DatabaseNotConfigured The operation could not be completed because the database for the service is not configured. 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. 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-ConfigServiceGroup

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

-------------------------- EXAMPLE 2 --------------------------

C:\>Get-ConfigRegisteredServiceInstance -ServiceType "config"

Return all the service groups that are registered in the Configuration Service and are of type 'config' (i.e. the service groups for the Configuration Service).