Citrix Virtual Apps and Desktops SDK

Stop-BrokerRebootCycle

Cancels the specified reboot cycle.

Syntax

Stop-BrokerRebootCycle
    [-InputObject] <RebootCycle[]>
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Description

The Stop-BrokerRebootCycle cmdlet is used to cancel the specified reboot cycle.

Examples

EXAMPLE 1

Cancels every reboot cycle for the catalog that has the Uid of 7.

Get-BrokerRebootCycle -CatalogUid 7 | Stop-BrokerRebootCycle
<!--NeedCopy-->

Parameters

-InputObject

Cancels this reboot cycle.

Type: RebootCycle[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
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

Citrix.Broker.Admin.SDK.RebootCycle

Reboot cycles may be specified through pipeline input.

Outputs

None

By default, this cmdlet returns no output.

Stop-BrokerRebootCycle