Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-ProvServiceInstance

August 3, 2023
Contributed by: 
C

Gets the service instance entries for the Machine Creation Service.

Syntax


Get-ProvServiceInstance [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Returns service interfaces published by instances of the Machine Creation 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 the Central Configuration service so that other services can locate the service interface and invoke the functionality.

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

Parameters

Name Description Required? Pipeline Input Default Value
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 user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect 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.Machinecreation.Sdk.Serviceinstance

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

  • ServiceGroupUid &lt;Guid&gt; Unique identifier for the service group of which the service is a member.

  • ServiceGroupName &lt;string&gt; Name of the service group of which the service is a member.

  • ServiceInstanceUID &lt;Guid&gt; 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 &lt;string&gt; Service instance type. For this service, the service instance type is always Prov.

  • Address 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 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 Version of the service instance. The version number is used to ensure that the correct versions of the services are used for communications.

  • ServiceAccount &lt;string&gt; 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 &lt;string&gt; The Active Directory account security identifier for the machine on which the service instance is running.

  • InterfaceType &lt;string&gt; 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 RestApi - for HTTP RESTful operations

  • Metadata &lt;Citrix.MachineCreation.Sdk.Metadata[]&gt; 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.

Examples

Example 1 


c:\PS>Get-ProvServiceInstance

Address            : http://MyServer.com:80/Citrix/MachineCreation/MachineCreationService

Binding            : wcf_HTTP_kerb

InterfaceType      : SDK

Metadata           :

MetadataMap        :

ServiceAccount     : ENG\MyAccount$

ServiceAccountSid  : S-1-5-21-2406005612-3133289213-1653143164

ServiceGroupName   : MyServiceGroup

ServiceGroupUid    : a88d2f6b-c00a-4f76-9c38-e8330093b54d

ServiceInstanceUid : 00000000-0000-0000-0000-000000000000

ServiceType        : Prov

Version            : 1

Address            : http://MyServer.com:80/Citrix/MachineCreation/MachineCreationApi

Binding            : wcf_HTTP_kerb

InterfaceType      : InterService

Metadata           :

MetadataMap        :

ServiceAccount     : ENG\MyAccount

ServiceAccountSid  : S-1-5-21-2406005612-3133289213-1653143164

ServiceGroupName   : MyServiceGroup

ServiceGroupUid    : a88d2f6b-c00a-4f76-9c38-e8330093b54d

ServiceInstanceUid : 00000000-0000-0000-0000-000000000000

ServiceType        : Prov

Version            : 1

<!--NeedCopy-->

Description

Get all instances of the Machine Creation 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 is not specified for the runspace, service instances running on the local machine are returned.

Get-ProvServiceInstance
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
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.