Citrix Virtual Apps and Desktops SDK

Get-Provobjectreference

Returns the number of local objects holding references to objects from other services.

Syntax

Get-ProvObjectReference [-HostingUnitUid <Guid[]>] [-IdentityPoolUid <Guid[]>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Returns for each hosting unit or identity pool GUID the number of references by provisioning schemes or by long running task. This check is done without regard for scoping of existing provisioning schemes, references by inaccessible schemes are also checked.

Parameters

Name Description Required? Pipeline Input Default Value
HostingUnitUid The identifiers of the hosting units(s) to be tested. false true (ByPropertyName)  
IdentityPoolUid The identifiers of the identity pool(s) to be tested. false true (ByPropertyName)  
BearerToken Specifies the bearer token assigned to the calling user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a XenDesktop 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

Objectreferencecount

An object which contain the input object identifier, its type, the type of referencing object and the number of references.

Notes

In the case of failure, the following errors can result.
Error Codes
———–
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.
ServiceStatusInvalidDb
An error occurred in the service while attempting a database operation - communication with the database failed for
for various reasons.
CommunicationError
An error occurred while communicating with the service.
PermissionDenied
The user does not have administrative rights to perform this operation.
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

Get-ProvObjectReference -HostingUnitUid 5B66A060-85E1-4DBD-9D1B-BF79881D3BB1

Count         : 1

ObjectId      : 5b66a060-85e1-4dbd-9d1b-bf79881d3bb1

Source        : ProvisioningScheme

Target        : HostingUnit

Count         : 0

ObjectId      : 5b66a060-85e1-4dbd-9d1b-bf79881d3bb1

Source        : Task

Target        : HostingUnit
<!--NeedCopy-->

Description

This checks a single hosting unit for objects that have references to them; in this case we only have a single provisioning scheme that relates to it.

Get-Provobjectreference