Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-BrokerRebootCycle

August 9, 2024
Contributed by: 
C

Gets one or more reboot cycles.

Syntax

Get-BrokerRebootCycle
   [-CatalogName <String>]
   [-CatalogUid <Int32>]
   [-DesktopGroupName <String>]
   [-DesktopGroupUid <Int32>]
   [-EndTime <DateTime>]
   [-IgnoreMaintenanceMode <Boolean>]
   [-MachinesCompleted <Int32>]
   [-MachinesFailed <Int32>]
   [-MachinesInProgress <Int32>]
   [-MachinesPending <Int32>]
   [-MachinesSkipped <Int32>]
   [-Metadata <String>]
   [-RebootDuration <Int32>]
   [-RebootScheduleName <String>]
   [-RebootScheduleUid <Int32>]
   [-RestrictToTag <String>]
   [-StartTime <DateTime>]
   [-State <RebootCycleState>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Get-BrokerRebootCycle
   -Uid <Int64>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Get-BrokerRebootCycle cmdlet is used to enumerate reboot cycles that match all of the supplied criteria.

See about_Broker_Filtering for information about advanced filtering options.

————————– BrokerRebootCycle Object

The reboot cycle object returned represents a single occurrence of the process of rebooting a portion (or all) of the machines in a desktop group.

  • CatalogName (System.String)

    Name of the catalog whose machines are rebooted by this cycle if the cycle is associated with a catalog.

  • CatalogUid (System.Int32?)

    Uid of the catalog whose machines are rebooted by this cycle if the cycle is associated with a catalog.

  • DesktopGroupName (System.String)

    Name of the desktop group whose machines are rebooted by this cycle.

  • DesktopGroupUid (System.Int32)

    Uid of the desktop group whose machines are rebooted by this cycle.

  • EndTime (System.DateTime?)

    Time at which this cycle was completed, canceled or abandoned.

  • IgnoreMaintenanceMode (System.Boolean)

    Boolean value to optionally reboot machines in maintenance mode

  • MachinesCompleted (System.Int32)

    Number of machines successfully rebooted by this cycle.

  • MachinesFailed (System.Int32)

    Number of machines issued with reboot requests where either the request failed or the operation did not complete within the allowed time.

  • MachinesInProgress (System.Int32)

    Number of machines issued with reboot requests but which have not yet completed the operation.

  • MachinesPending (System.Int32)

    Number of outstanding machines to be rebooted during the cycle but on which processing has not yet started.

  • MachinesSkipped (System.Int32)

    Number of machines scheduled for reboot during the cycle but which were not processed either because the cycle was canceled or abandoned or because the machine was unavailable for reboot processing throughout the cycle.

  • MetadataMap (System.Collections.Generic.Dictionary<string, string>)

    Map of metadata associated with this cycle.

  • RebootDuration (System.Int32)

    Approximate maximum number of minutes over which the reboot cycle runs.

  • RebootScheduleName (System.String)

    Name of the Reboot Schedule which triggered this cycle if the cycle is associated with a reboot schedule.

  • RebootScheduleUid (System.Int32?)

    Uid of the Reboot Schedule which triggered this cycle if the cycle is associated with a reboot schedule.

  • RestrictToTag (System.String)

    An optional Tag which limits the reboot cycle to machines within the desktop group with the specified tag.

  • StartTime (System.DateTime)

    Time of day at which this reboot cycle was started.

  • State (Citrix.Broker.Admin.SDK.RebootCycleState)

    The execution state of this cycle.

  • Uid (System.Int64)

    Unique ID of this reboot cycle.

  • WarningDuration (System.Int32)

    Number of minutes to display the warning message for.

  • WarningMessage (System.String)

    Warning message to display to users in active sessions prior to rebooting the machine.

  • WarningRepeatInterval (System.Int32)

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

  • WarningTitle (System.String)

    Title of the warning message dialog.

Examples

EXAMPLE 1

Enumerate all reboot cycles.

Get-BrokerRebootCycle
<!--NeedCopy-->

EXAMPLE 2

Enumerates all reboot cycles that have successfully completed.

Get-BrokerRebootCycle -State Completed
<!--NeedCopy-->

EXAMPLE 3

Enumerates all reboot cycles related to the desktop group named CallCenter.

Get-BrokerRebootCycle -DesktopGroupName CallCenter
<!--NeedCopy-->

Parameters

-Uid

Gets reboot cycles that have the specified Uid.

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

-CatalogName

Gets reboot cycles that relate to the named catalog.

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

-CatalogUid

Gets reboot cycles that relate to the catalog with a particular Uid.

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

-DesktopGroupName

Gets reboot cycles that relate to the named desktop group.

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

-DesktopGroupUid

Gets reboot cycles that relate to the desktop group with a particular Uid.

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

-EndTime

Gets reboot cycles that have the specified time at which the reboot cycle was completed, canceled or abandoned.

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

-IgnoreMaintenanceMode

Boolean value to optionally reboot machines in maintenance mode

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2003

-MachinesCompleted

Gets reboot cycles that have the specified count of machines successfully rebooted during the cycle.

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

-MachinesFailed

Gets reboot cycles that have the specified count of machines issued with reboot requests where either the request failed or the operation did not complete within the allowed time.

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

-MachinesInProgress

Gets reboot cycles that have the specified count of machines issued with reboot requests but which have not yet completed the operation.

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

-MachinesPending

Gets reboot cycles that have the specified count of outstanding machines to be rebooted during the cycle but on which processing has not yet started.

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

-MachinesSkipped

Gets reboot cycles that have the specified count of machines scheduled for reboot during the cycle but which were not processed either because the cycle was canceled or abandoned or because the machine was unavailable for reboot processing throughout the cycle.

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

-Metadata

Gets records with matching metadata entries.

The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.

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

-RebootDuration

Gets reboot cycles that have the specified approximate maximum duration in minutes over which the reboot cycle runs.

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

-RebootScheduleName

Gets reboot cycles which were triggered by the named reboot schedule.

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

-RebootScheduleUid

Gets reboot cycles which were triggered by the reboot schedule with aparticular Uid.

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

-RestrictToTag

An optional Tag which limits the reboot cycle to machines within the desktop group with the specified tag.

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

-StartTime

Gets reboot cycles that have the specified time at which the reboot cycle started.

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

-State

Gets reboot cycles that have the specified overall state of the reboot cycle. Valid values are Initializing, Active, Completed, Canceled, and Abandoned.

Type: RebootCycleState
Accepted values: Initializing, Active, Completed, PendingCancel, Canceled, Abandoned
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ReturnTotalRecordCount

When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.

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

-MaxRecordCount

Specifies the maximum number of records to return.

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

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

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

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.

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

-FilterScope

Gets only results allowed by the specified scope id.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2106

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

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

None

Input cannot be piped to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.RebootCycle

Returns matching reboot cycles.

Get-BrokerRebootCycle
August 9, 2024
Contributed by: 
C
August 9, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.