Citrix Virtual Apps and Desktops SDK

Reset-BrokerAutoscaleCatalogFailover

January 13, 2026

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2511

Resets the desktop group’s catalog failover state and switch back to using the primary catalogs for autoscaling.

Syntax

Reset-BrokerAutoscaleCatalogFailover
     [[-DesktopGroupUid] <Int32>]
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Reset-BrokerAutoscaleCatalogFailover
     [-InputObject] <DesktopGroup>
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Description

The Reset-BrokerAutoscaleCatalogFailover cmdlet resets the desktop group’s autoscale catalog failover state and switch back to using the primary catalogs for autoscaling.

Examples

EXAMPLE 1

This command resets the autoscale catalog failover for the specified desktop group by internal Uid

Reset-BrokerAutoscaleCatalogFailover -DesktopGroupUid 2
<!--NeedCopy-->

EXAMPLE 2

This command resets the autoscale catalog failover for the piped in desktop group

Get-BrokerDesktopGroup -uid 2 | Reset-BrokerAutoscaleCatalogFailover
<!--NeedCopy-->

Parameters

-InputObject

Specifies the desktop group object whose autoscale catalog failover should be reset.

Type:	DesktopGroup
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-DesktopGroupUid

Specifies the desktop group Uid

Type:	Int32
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -SkipCertificateValidation, -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.Broker.Admin.SDK.DesktopGroup

You can pipe the desktop group whose autoscale catalog failover needs resetting to Reset-BrokerAutoscaleCatalogFailover.

Outputs

None

By default, this cmdlet returns no output.

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

Reset-BrokerAutoscaleCatalogFailover

January 13, 2026

Contributed by:

January 13, 2026

Contributed by:

Reset-BrokerAutoscaleCatalogFailover

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-InputObject

-DesktopGroupUid

CitrixCommonParameters

CommonParameters

Inputs

Citrix.Broker.Admin.SDK.DesktopGroup

Outputs

None

Related Links

In this article