Developer Documentation
Citrix Daas SDK

Get-HypServiceInstance

August 9, 2024
Contributed by: 
C C

Gets the service instance entries for the Host Service.

Syntax

Get-HypServiceInstance
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Returns service interfaces published by instances of the Host Service. Each instance of a service publishes multiple interfaces with distinct interface types, and each of these interfaces is represented as a ServiceInstance object. Service instances can be used to register the service with a Central Configuration Service so that other services can locate the functionality.

You do not need to configure a database connection to use this command.

Examples

EXAMPLE 1

Get all instances of the Host Service running on the specified machine. For remote services, use the AdminAddress parameter to define the service for which the interfaces are required. If the AdminAddress parameter has not been specified for the runspace, service instances running on the local machine are returned.

Get-HypServiceInstance
<!--NeedCopy-->

Parameters

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.Host.Sdk.ServiceInstance

The Get-HypServiceInstance command returns an object containing the following properties.

  • ServiceGroupUid <Guid>

    Specifies the unique identifier for the service group of which the service is a member.

  • ServiceGroupName <String>

    Specifies the name of the service group of which the service is a member.

  • ServiceInstanceUID <Guid>

    Specifies the unique identifier for registered service instances, which are service instances held by and obtained from a Central Configuration Service. Unregistered service instances do not have unique identifiers.

  • ServiceType <String>

    Specifies the service instance type. For this service, the service instance type is always <#= CmdletPrefix #>.

  • Address

    Specifies the address of the service instance. The address can be used to access the service and, when registered in the Central Configuration Service, can be used by other services to access the service.

  • Binding

    Specifies the binding type that must be used to communicate with the service instance. In this release of Citrix Virtual Apps and Desktops, the binding type is always ‘wcf_HTTP_kerb’. This indicates that the service provides a Windows Communication Foundation endpoint that uses HTTP binding with integrated authentication.

  • Version

    Specifies the version of the service instance. The version number is used to ensure that the correct versions of the services are used for communications.

  • ServiceAccount <String>

    Specifies the Active Directory account name for the machine on which the service instance is running. The account name is used to provide information about the permissions required for interservice communications.

  • ServiceAccountSid <String>

    Specifies the Active Directory account security identifier for the machine on which the service instance is running.

  • InterfaceType <String>

    Specifies the interface type. Each service can provide multiple service instances, each for a different purpose, and the interface defines the purpose. Available interfaces are:

    • SDK - for PowerShell operations
    • InterService - for operations between different services
    • Peer - for communications between services of the same type

  • Metadata <Citrix.Host.Sdk.Metadata[]>

    The collection of metadata associated with registered service instances, which are service instances held by and obtained from a Central Configuration Service. Metadata is not stored for unregistered service instances.

Notes

If the command fails, the following errors can be returned:

  • DatabaseError

    An error occurred in the service while attempting a database operation.

  • DatabaseNotConfigured

    The operation could not be completed because the database for the service is not configured.

  • DataStoreException

    An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.

  • PermissionDenied

    You do not have permission to execute this command.

  • AuthorizationError

    There was a problem communicating with the Citrix Delegated Administration Service.

  • CommunicationError

    There was a problem communicating with the remote service.

  • ExceptionThrown

    An unexpected error occurred. For more details, see the Windows event logs on the controller or the Citrix Virtual Apps and Desktops logs.

Get-HypServiceInstance
August 9, 2024
Contributed by: 
C C
August 9, 2024
Contributed by: 
C C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.