Product Documentation

Remove-BrokerRebootSchedule

Sep 29, 2015

Removes the reboot schedule.

Syntax

Remove-BrokerRebootSchedule [-InputObject] <RebootSchedule[]> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Remove-BrokerRebootSchedule [-DesktopGroupName] <String> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The Remove-BrokerRebootSchedule cmdlet is used to delete an existing reboot schedule.

Parameters

-InputObject<RebootSchedule[]>

The reboot schedule to be deleted.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-DesktopGroupName<String>

The name of the desktop group whose reboot schedule is to be removed.

Required? true
Default Value  
Accept Pipeline Input? true (ByPropertyName)

-LoggingId<Guid>

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.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

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.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

Citrix.Broker.Admin.SDK.RebootSchedule Reboot schedules may be specified through pipeline input.

Return Values

None

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Get-BrokerRebootSchedule | Remove-BrokerRebootSchedule

Deletes every reboot schedule.

-------------------------- EXAMPLE 2 --------------------------

C:\PS> Remove-BrokerRebootSchedule 12

Deletes the reboot schedule for the desktop group having Uid 12.

-------------------------- EXAMPLE 3 --------------------------

C:\PS> Remove-BrokerRebootSchedule -DesktopGroupName Accounting

Deletes the reboot schedule for the desktop group named Accounting.