Citrix Virtual Apps and Desktops SDK

Start-BrokerDesktopGroupRebootCycle

Creates and starts a reboot cycle for each specified desktop group.

Syntax

Start-BrokerDesktopGroupRebootCycle
     [-InputObject] <DesktopGroup[]>
     -RebootDuration <Int32>
     [-RestrictToTagUid <Int32>]
     [-WarningDuration <Int32>]
     [-WarningTitle <String>]
     [-WarningMessage <String>]
     [-WarningRepeatInterval <Int32>]
     [-IgnoreMaintenanceMode <Boolean>]
     [-LoggingId <Guid>]
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Description

The Start-BrokerDesktopGroupRebootCycle cmdlet is used to create and start a reboot cycle for specified desktop groups.

The functionality offered is similar to that of New-BrokerRebootSchedule but the resulting reboot cycles execute once as defined by the command parameters rather than on a repeating schedule.

Examples

EXAMPLE 1

Starts a new reboot cycle for the desktop group called “SampleGroup”. Each reboot cycle has a duration of six hours. Fifteen minutes prior to rebooting a machine, the message “Save your work” is displayed in each active user session. Only machines tagged with the tag having UID 2 will be rebooted.

Get-BrokerDesktopGroup "SampleGroup" | Start-BrokerDesktopGroupRebootCycle -RebootDuration 240 -WarningMessage "Save your work" -WarningDuration 15 -RestrictToTagUid 2
<!--NeedCopy-->

Parameters

-InputObject

Creates a reboot cycle for the specified desktop groups. Groups can be specified using UID values, name values (including wildcards) or desktop group SDK objects.

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

-RebootDuration

Approximate maximum duration in minutes over which the reboot cycle runs.

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

-RestrictToTagUid

If set to a Tag UID, only machines that have this tag will be rebooted.

Type: Int32
Position: Named
Default value: Null
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-WarningDuration

Time in minutes prior to a machine reboot at which a warning message is displayed in all user sessions on that machine. If the warning duration value is zero then no message is displayed.

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

-WarningTitle

The window title used when showing the warning message in user sessions on a machine scheduled for reboot.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-WarningMessage

Warning message displayed in user sessions on a machine scheduled for reboot. If the message is blank then no message is displayed.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-WarningRepeatInterval

Number of minutes to wait before showing the reboot warning message again.

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

-IgnoreMaintenanceMode

Option to reboot machines in maintenance mode.

Type: Boolean
Position: Named
Default value: None
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

Citrix.Broker.Admin.SDK.DesktopGroup

Desktop groups may be specified through pipeline input. The groups can be specified using UID values, name values (including wildcards) or desktop group objects

Outputs

None

By default, this cmdlet returns no output.

Start-BrokerDesktopGroupRebootCycle