Citrix Virtual Apps and Desktops SDK

Get-ProvObjectReference

June 30, 2023

Contributed by:

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

Syntax

Get-ProvObjectReference [-HostingUnitUid <Guid[]>] [-IdentityPoolUid <Guid[]>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <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
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

Citrix.Host.Sdk.Hostingunit

You can pipe an object containing a parameter called ‘HostingUnitUid’ to Get-ProvObjectReference.

Citrix.Adidentity.Sdk.Identitypool

You can pipe an object containing a parameter called ‘IdentityPoolUid’ to Get-ProvObjectReference.

Return Values

Objectreferencecount

An object containing the input object identifier, its type, the types of referencing objects, and the number of references.

Notes

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

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. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops 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 it. The result shows there is only one provisioning scheme relating to it.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-ProvObjectReference

June 30, 2023

Contributed by:

June 30, 2023

Contributed by:

Get-ProvObjectReference

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Host.Sdk.Hostingunit

Citrix.Adidentity.Sdk.Identitypool

Return Values

Objectreferencecount

Notes

Examples

Example 1

Description

In this article