Citrix Virtual Apps and Desktops SDK

Get-BrokerRebootScheduleV2

August 3, 2023

Contributed by:

Gets one or more reboot schedules.

Syntax

Get-BrokerRebootScheduleV2 [-Uid] <Int32> [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

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>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

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

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Uid	Gets the reboot schedule with the specified Uid.	true	false
Name	Gets the reboot schedule with the specified name.	false	false
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.	false	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).	false	false
DayInMonth	Gets the reboot schedules set to run on the specified day in month.	false	false
DesktopGroupName	Gets the reboot schedules for the desktop group having this name.	false	false
DesktopGroupUid	Gets the reboot schedules for the desktop group having this Uid.	false	false
Enabled	Gets the reboot schedules with the specified Enabled value.	false	false
Frequency	Gets the reboot schedules with the specified frequency (either Weekly or Daily or Monthly).	false	false
FrequencyFactor	Gets the reboot schedules with the specified frequency factor.	false	false
IgnoreMaintenanceMode	Boolean value to reboot machines in maintenance mode	false	false
MaxOvertimeStartMins	Maximum delay in minutes after which the scheduled reboot will not take place	false	false
MetadataKey	All key names of metadata items associated with this application.	false	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”.	false	false
RebootDuration	Gets the reboot schedules with the specified duration.	false	false
RestrictToTag	Gets the reboot schedules with the specified tag.	false	false
StartDate	Gets the reboot schedules with the specified start date (YYY-MM-DD).	false	false
StartTime	Gets the reboot schedules with the specified start time (HH:MM).	false	false
UseNaturalReboot	Gets the reboot schedules with the specified UseNaturalReboot value.	false	false
WarningRepeatInterval	Gets the reboot schedules with the specified warning repeat interval.	false	false
WeekInMonth	Gets the reboot schedules with the specified week in a month.	false	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.	false	false	False
MaxRecordCount	Specifies the maximum number of records to return.	false	false	250
Skip	Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.	false	false	0
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.	false	false	The default sort order is by name or unique identifier.
Filter	Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.	false	false
FilterScope	Gets only results allowed by the specified scope id.	false	false
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.	false	false
AdminAddress	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.	false	false	Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken	Specifies the bearer token assigned to the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false

Input Type

None

Input cannot be piped to this cmdlet.

Return Values

Citrix.Broker.Admin.Sdk.Rebootschedulev2

Returns matching reboot schedules.

Examples

Example 1

C:\PS> Get-BrokerRebootScheduleV2

<!--NeedCopy-->

Description

Enumerates all of the reboot schedules.

Example 2

C:\PS> Get-BrokerRebootScheduleV2 -Enabled $false -Frequency Daily

<!--NeedCopy-->

Description

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

Example 3

C:\PS> Get-BrokerRebootScheduleV2 -DesktopGroupUid 11

<!--NeedCopy-->

Description

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-BrokerRebootScheduleV2

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Get-BrokerRebootScheduleV2

Syntax

Detailed Description

Brokerrebootschedulev2 Object

Related Commands

Parameters

Input Type

None

Return Values

Citrix.Broker.Admin.Sdk.Rebootschedulev2

Examples

Example 1

Description

Example 2

Description

Example 3

Description

In this article