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-BrokerRebootScheduleV2

August 9, 2024
Contributed by: 
C

Gets one or more reboot schedules.

Syntax

Get-BrokerRebootScheduleV2
   [[-Name] <String>]
   [-Active <Boolean>]
   [-Day <RebootScheduleDays>]
   [-DayInMonth <RebootScheduleDays>]
   [-DesktopGroupName <String>]
   [-DesktopGroupUid <Int32>]
   [-Enabled <Boolean>]
   [-Frequency <RebootScheduleFrequency>]
   [-FrequencyFactor <Int32>]
   [-IgnoreMaintenanceMode <Boolean>]
   [-MaxOvertimeStartMins <Int32>]
   [-MetadataKey <String>]
   [-Metadata <String>]
   [-RebootDuration <Int32>]
   [-RestrictToTag <String>]
   [-StartDate <String>]
   [-StartTime <TimeSpan>]
   [-UseNaturalReboot <Boolean>]
   [-WarningRepeatInterval <Int32>]
   [-WeekInMonth <RebootScheduleWeeks>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Get-BrokerRebootScheduleV2
   [-Uid] <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Get-BrokerRebootScheduleV2 cmdlet is used to enumerate desktop group reboot schedules that match all of the supplied criteria.

A reboot schedule can be configured to cause all of the machines in a desktop group to be rebooted at a particular time each day or each week, with the reboot of the individual machines spread out over the duration of the whole reboot cycle. A specific warning message can be configured to be displayed to users who are running sessions on the machines being rebooted.

See about_Broker_Filtering for information about advanced filtering options.

————————– BrokerRebootScheduleV2 Object

The reboot schedule object returned represents a regularly scheduled reboot of machines in a desktop group.

  • Active (System.Boolean)

    True if there is an active reboot cycle for this schedule, false otherwise.

  • Day (Citrix.Broker.Admin.SDK.RebootScheduleDays?)

    When the frequency is weekly, days of the week on which the schedule reboot starts.

  • DayInMonth (Citrix.Broker.Admin.SDK.RebootScheduleDays?)

    When the frequency is monthly, day in the month on which the schedule reboot starts.

  • Description (System.String)

    An optional description for the reboot schedule.

  • DesktopGroupName (System.String)

    Name of the desktop group rebooted by this schedule.

  • DesktopGroupUid (System.Int32)

    Uid of the desktop group rebooted by this schedule.

  • Enabled (System.Boolean)

    True if this schedule is currently enabled, false otherwise.

  • Frequency (Citrix.Broker.Admin.SDK.RebootScheduleFrequency)

    Whether the schedule runs daily or weekly or monthly.

  • FrequencyFactor (System.Int32)

    The frequency factor for the reboot schedule. It indicates how often the schedule should run with respect to the frequency. For example, if the FrequencyFactor is set to 2, it means every two days from the StartDate when the Frequency is Daily, every two weeks from the StartDate when the Frequency is Weekly, and similarly for monthly.

  • IgnoreMaintenanceMode (System.Boolean)

    Boolean value to reboot machines in maintenance mode

  • MaxOvertimeStartMins (System.Int32)

    Maximum delay in minutes after which the scheduled reboot will not take place

  • MetadataKeys (System.String[])

    All key names of metadata items associated with this application.

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

    Metadata for this application.

  • Name (System.String)

    Name of the reboot schedule.

  • RebootDuration (System.Int32)

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

  • RestrictToTag (System.String)

    If set the reboot schedule only applies to machines in the desktop group with the specified tag.

  • StartDate (System.String)

    The date on which the first schedule is expected to run, date is in ISO 8601 Format (YYYY-MM-DD).

  • StartTime (System.TimeSpan)

    Time of day at which the scheduled reboot cycle starts.

  • Uid (System.Int32)

    Uid of the reboot schedule.

  • UseNaturalReboot (System.Boolean)

    Boolean value indicating whether the machines should reboot whenever they happen to have no sessions, rather than at equally spaced times within the cycle duration.

  • 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 displaying the warning message again.

  • WarningTitle (System.String)

    Title of the warning message dialog.

  • WeekInMonth (Citrix.Broker.Admin.SDK.RebootScheduleWeeks?)

    When the frequency is monthly, week in the month on which the schedule reboot starts.

Examples

EXAMPLE 1

Enumerates all of the reboot schedules.

Get-BrokerRebootScheduleV2
<!--NeedCopy-->

EXAMPLE 2

Enumerates all disabled reboot schedules that are scheduled to run daily.

Get-BrokerRebootScheduleV2 -Enabled $false -Frequency Daily
<!--NeedCopy-->

EXAMPLE 3

Returns the reboot schedules for the desktop group having the Uid 11.

Get-BrokerRebootScheduleV2 -DesktopGroupUid 11
<!--NeedCopy-->

Parameters

-Uid

Gets the reboot schedule with the specified Uid.

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

-Name

Gets the reboot schedule with the specified name.

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

-Active

Gets desktop group reboot schedules according to whether they are currently active or not. A schedule is active if there is a reboot cycle currently running that was started as a result of the schedule.

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

-Day

Gets the reboot schedules set to run on the specific days of week (one or more of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday).

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

-DayInMonth

Gets the reboot schedules set to run on the specified day in month.

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

-DesktopGroupName

Gets the reboot schedules for the desktop group having this name.

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

-DesktopGroupUid

Gets the reboot schedules for the desktop group having this Uid.

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

-Enabled

Gets the reboot schedules with the specified Enabled value.

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

-Frequency

Gets the reboot schedules with the specified frequency (either Weekly or Daily or Monthly).

Type: RebootScheduleFrequency
Accepted values: Daily, Weekly, Monthly, Once
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-FrequencyFactor

Gets the reboot schedules with the specified frequency factor.

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

-IgnoreMaintenanceMode

Boolean value to 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

-MaxOvertimeStartMins

Maximum delay in minutes after which the scheduled reboot will not take place

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

-MetadataKey

All key names of metadata items associated with this application.

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

-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 the reboot schedules with the specified duration.

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

-RestrictToTag

Gets the reboot schedules with the specified tag.

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

-StartDate

Gets the reboot schedules with the specified start date (YYY-MM-DD).

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

-StartTime

Gets the reboot schedules with the specified start time (HH:MM).

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

-UseNaturalReboot

Gets the reboot schedules with the specified UseNaturalReboot value.

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 2009

-WarningRepeatInterval

Gets the reboot schedules with the specified warning repeat interval.

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

-WeekInMonth

Gets the reboot schedules with the specified week in a month.

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

-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.RebootScheduleV2

Returns matching reboot schedules.

Get-BrokerRebootScheduleV2
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.