Citrix Virtual Apps and Desktops SDK

Get-BrokerCatalogRebootSchedule

Introduced in: Citrix Virtual Apps and Desktop 7 2209

Gets one or more catalog reboot schedules.

Syntax

Get-BrokerCatalogRebootSchedule
   [[-Name] <String>]
   [-Active <Boolean>]
   [-CatalogName <String>]
   [-CatalogUid <Int32>]
   [-Enabled <Boolean>]
   [-MaxOvertimeStartMins <Int32>]
   [-RebootDuration <Int32>]
   [-StartDate <String>]
   [-StartTime <TimeSpan>]
   [-WarningRepeatInterval <Int32>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerCatalogRebootSchedule
   [-Uid] <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

Enumerates all of the catalog reboot schedules.

Get-BrokerCatalogRebootSchedule
<!--NeedCopy-->

EXAMPLE 2

Enumerates all disabled catalog reboot schedules.

Get-BrokerCatalogRebootSchedule -Enabled $false
<!--NeedCopy-->

EXAMPLE 3

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

Get-BrokerCatalogRebootSchedule -CatalogUid 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

-CatalogName

Gets the reboot schedules for the catalog having this name.

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

-CatalogUid

Gets the reboot schedules for the catalog 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

-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

-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

-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

-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

-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

-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

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

Returns matching catalog reboot schedules.

Get-BrokerCatalogRebootSchedule