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[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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.

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-->

EXAMPLE 2

This iterates all available identity pools for objects that have references to them, using specification by property name. The result shows that for each identity pool there is one provisioning scheme relating to it.

Get-AcctIdentityPool | Get-ProvObjectReference

Count         : 1
ObjectId      : 7a63cd15-8a6f-450e-9c09-72fb9f211898
Source        : ProvisioningScheme
Target        : IdentityPool

Count         : 0
ObjectId      : 7a63cd15-8a6f-450e-9c09-72fb9f211898
Source        : Task
Target        : IdentityPool
<!--NeedCopy-->

Parameters

-HostingUnitUid

The identifiers of the hosting units(s) to be tested.

Type: Guid[]
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IdentityPoolUid

The identifiers of the identity pool(s) to be tested.

Type: Guid[]
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

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

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.

Outputs

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.

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. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops logs.

Get-ProvObjectReference