Citrix Virtual Apps and Desktops SDK

Update-Brokerlocalleasecache

August 3, 2023

Contributed by:

Flushes the local lease cache.

Syntax

Update-BrokerLocalLeaseCache [-Workers] [-Applications] [-Icons] [-Desktops] [-Leases] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Removes all local cached lease data and any state information stored in the registry.

Remove-BrokerLease

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Workers	Removes all locally cached workers on the controller. The worker cache will be repopulated from the current site database contents after a short delay.	false	false	false
Applications	Removes all locally cached applications on the controller. The application cache will be repopulated from the current site database contents after a short delay.	false	false	false
Icons	Removes all locally cached icons on the controller. The icon cache will be repopulated from the current site database contents after a short delay.	false	false	false
Desktops	Removes all locally cached desktops on the controller. The desktop cache will be repopulated from the current site database contents after a short delay.	false	false	false
Leases	Removes all locally cached leases on the controller. The lease cache will be repopulated from the current site database contents after a short delay.	false	false	false
LoggingId	Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.	false	false
AdminAddress	Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken	Specifies the bearer token assigned to the calling user	false	false

Input Type

None

Return Values

None

Notes

The local cache for lease and other data like worker, desktop, application and icon information is removed and will be repopulated from the current site database contents after a short delay.

Examples

Example 1

C:\PS> Update-BrokerLocalLeaseCache
<!--NeedCopy-->

Description

Flushes the local lease cache for all objects and deletes any state information stored in the registry.

Example 2

C:\PS> Update-BrokerLocalLeaseCache -Workers
<!--NeedCopy-->

Description

Flushes the local lease cache for all workers and deletes any state information stored in the registry.

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

Update-Brokerlocalleasecache

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Update-Brokerlocalleasecache

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

None

Notes

Examples

Example 1

Description

Example 2

Description

In this article