Skip to content
Was this article helpful?

Get-BrokerCatalogRebootSchedule

Gets one or more catalog reboot schedules.

Syntax

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

Get-BrokerCatalogRebootSchedule [[-Name] <String>] [-Active <Boolean>] [-CatalogName <String>] [-CatalogUid <Int32>] [-Enabled <Boolean>] [-MaxOvertimeStartMins <Int32>] [-RebootDuration <Int32>] [-StartDate <String>] [-StartTime <TimeSpan>] [-WarningRepeatInterval <Int32>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Detailed Description

The Get-BrokerCatalogRebootSchedule cmdlet is used to enumerate catalog reboot schedules that match all of the supplied criteria.

A catalog reboot schedule can be configured to cause all of the machines in a catalog to be rebooted once at a particular time and day, 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.

Brokercatalogrebootschedule Object

The catalog reboot schedule object returned represents a scheduled reboot of machines in a catalog.

  • Active (System.Boolean) True if there is an active reboot cycle for this schedule, false otherwise.

  • CatalogName (System.String) Name of the catalog rebooted by this schedule.

  • CatalogUid (System.Int32) Uid of the catalog rebooted by this schedule.

  • Description (System.String) An optional description for the reboot schedule.

  • Enabled (System.Boolean) True if this schedule is currently enabled, false otherwise.

  • MaxOvertimeStartMins (System.Int32) Maximum delay in minutes after which the scheduled reboot will not take place

  • Name (System.String) Name of the reboot schedule.

  • RebootDuration (System.Int32) Approximate maximum number of minutes over which the scheduled reboot cycle runs.

  • StartDate (System.String) The date on which the 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.

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

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
CatalogName Gets the reboot schedules for the catalog having this name. false false
CatalogUid Gets the reboot schedules for the catalog having this Uid. false false
Enabled Gets the reboot schedules with the specified Enabled value. false false
MaxOvertimeStartMins Maximum delay in minutes after which the scheduled reboot will not take place false false
RebootDuration Gets the reboot schedules with the specified duration. 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
WarningRepeatInterval Gets the reboot schedules with the specified warning repeat interval. 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
AdminClientIP Internal use only. 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.Catalogrebootschedule

Returns matching catalog reboot schedules.

Examples

Example 1

C:\PS> Get-BrokerCatalogRebootSchedule

Description

Enumerates all of the catalog reboot schedules.

Example 2

C:\PS> Get-BrokerCatalogRebootSchedule -Enabled $false

Description

Enumerates all disabled catalog reboot schedules.

Example 3

C:\PS> Get-BrokerCatalogRebootSchedule -CatalogUid 11

Description

Returns the catalog reboot schedules for the catalog having the Uid 11.

Was this article helpful?