Citrix Daas SDK

Start-BrokerNaturalDesktopGroupRebootCycle

Reboots all machines from the specified desktop group when they are not in use.

Syntax

Start-BrokerNaturalDesktopGroupRebootCycle
     [-InputObject] <DesktopGroup[]>
     [-LoggingId <Guid>]
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Description

Creating a natural reboot cycle for a desktop group ensures that all machines in the group are running the most recent image for the group.

The machines are rebooted in a non-disruptive manner, allowing machines that are in use to continue working and be restarted only after they become idle.

Examples

EXAMPLE 1

The above code applies a natural reboot cycle on desktop group with Id 1

$dg = Get-BrokerDesktopGroup -Uid 1
Start-BrokerNaturalDesktopGroupRebootCycle -InputObject $dg
<!--NeedCopy-->

Parameters

-InputObject

Reboots all machines from this input desktop group. The desktop groups can be specified using UID values, name values (including wildcards) or desktop group objects.

Type: DesktopGroup[]
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.DesktopGroup

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

Outputs

None

By default, this cmdlet returns no output.

Notes

Natural reboot cycles do not apply to non-power managed machines or multi-session desktop groups

Start-BrokerNaturalDesktopGroupRebootCycle