-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
Get-BrokerCatalogRebootSchedule
-
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
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.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.