Developer Documentation
Citrix Daas SDK

Update-BrokerLocalLeaseCache

August 9, 2024
Contributed by: 
C C

Flushes the local lease cache.

Syntax

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

Description

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

Examples

EXAMPLE 1

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

Update-BrokerLocalLeaseCache
<!--NeedCopy-->

EXAMPLE 2

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

Update-BrokerLocalLeaseCache -Workers
<!--NeedCopy-->

Parameters

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

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: 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.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: 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.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: 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.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: 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.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: 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.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
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

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

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.

Update-BrokerLocalLeaseCache
August 9, 2024
Contributed by: 
C C
August 9, 2024
Contributed by: 
C 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.