-
-
-
-
-
Get-BrokerRebootCycle
-
-
-
-
-
-
-
-
-
-
-
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-BrokerRebootCycle
Gets one or more reboot cycles.
Syntax
Get-BrokerRebootCycle
[-CatalogName <String>]
[-CatalogUid <Int32>]
[-DesktopGroupName <String>]
[-DesktopGroupUid <Int32>]
[-EndTime <DateTime>]
[-IgnoreMaintenanceMode <Boolean>]
[-MachinesCompleted <Int32>]
[-MachinesFailed <Int32>]
[-MachinesInProgress <Int32>]
[-MachinesPending <Int32>]
[-MachinesSkipped <Int32>]
[-Metadata <String>]
[-RebootDuration <Int32>]
[-RebootScheduleName <String>]
[-RebootScheduleUid <Int32>]
[-RestrictToTag <String>]
[-StartTime <DateTime>]
[-State <RebootCycleState>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Get-BrokerRebootCycle
-Uid <Int64>
[-Property <String[]>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
The Get-BrokerRebootCycle cmdlet is used to enumerate reboot cycles that match all of the supplied criteria.
See about_Broker_Filtering for information about advanced filtering options.
————————– BrokerRebootCycle Object
The reboot cycle object returned represents a single occurrence of the process of rebooting a portion (or all) of the machines in a desktop group.
-
CatalogName (System.String)
Name of the catalog whose machines are rebooted by this cycle if the cycle is associated with a catalog.
-
CatalogUid (System.Int32?)
Uid of the catalog whose machines are rebooted by this cycle if the cycle is associated with a catalog.
-
DesktopGroupName (System.String)
Name of the desktop group whose machines are rebooted by this cycle.
-
DesktopGroupUid (System.Int32)
Uid of the desktop group whose machines are rebooted by this cycle.
-
EndTime (System.DateTime?)
Time at which this cycle was completed, canceled or abandoned.
-
IgnoreMaintenanceMode (System.Boolean)
Boolean value to optionally reboot machines in maintenance mode
-
MachinesCompleted (System.Int32)
Number of machines successfully rebooted by this cycle.
-
MachinesFailed (System.Int32)
Number of machines issued with reboot requests where either the request failed or the operation did not complete within the allowed time.
-
MachinesInProgress (System.Int32)
Number of machines issued with reboot requests but which have not yet completed the operation.
-
MachinesPending (System.Int32)
Number of outstanding machines to be rebooted during the cycle but on which processing has not yet started.
-
MachinesSkipped (System.Int32)
Number of machines scheduled for reboot during the cycle but which were not processed either because the cycle was canceled or abandoned or because the machine was unavailable for reboot processing throughout the cycle.
-
MetadataMap (System.Collections.Generic.Dictionary<string, string>)
Map of metadata associated with this cycle.
-
RebootDuration (System.Int32)
Approximate maximum number of minutes over which the reboot cycle runs.
-
RebootScheduleName (System.String)
Name of the Reboot Schedule which triggered this cycle if the cycle is associated with a reboot schedule.
-
RebootScheduleUid (System.Int32?)
Uid of the Reboot Schedule which triggered this cycle if the cycle is associated with a reboot schedule.
-
RestrictToTag (System.String)
An optional Tag which limits the reboot cycle to machines within the desktop group with the specified tag.
-
StartTime (System.DateTime)
Time of day at which this reboot cycle was started.
-
State (Citrix.Broker.Admin.SDK.RebootCycleState)
The execution state of this cycle.
-
Uid (System.Int64)
Unique ID of this reboot cycle.
-
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 showing the reboot warning message again.
-
WarningTitle (System.String)
Title of the warning message dialog.
Examples
EXAMPLE 1
Enumerate all reboot cycles.
Get-BrokerRebootCycle
<!--NeedCopy-->
EXAMPLE 2
Enumerates all reboot cycles that have successfully completed.
Get-BrokerRebootCycle -State Completed
<!--NeedCopy-->
EXAMPLE 3
Enumerates all reboot cycles related to the desktop group named CallCenter.
Get-BrokerRebootCycle -DesktopGroupName CallCenter
<!--NeedCopy-->
Parameters
-Uid
Gets reboot cycles that have the specified Uid.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CatalogName
Gets reboot cycles that relate to the named catalog.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-CatalogUid
Gets reboot cycles that relate to the catalog with a particular Uid.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DesktopGroupName
Gets reboot cycles that relate to the named desktop group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-DesktopGroupUid
Gets reboot cycles that relate to the desktop group with a particular Uid.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EndTime
Gets reboot cycles that have the specified time at which the reboot cycle was completed, canceled or abandoned.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IgnoreMaintenanceMode
Boolean value to optionally reboot machines in maintenance mode
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachinesCompleted
Gets reboot cycles that have the specified count of machines successfully rebooted during the cycle.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachinesFailed
Gets reboot cycles that have the specified count of machines issued with reboot requests where either the request failed or the operation did not complete within the allowed time.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachinesInProgress
Gets reboot cycles that have the specified count of machines issued with reboot requests but which have not yet completed the operation.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachinesPending
Gets reboot cycles that have the specified count of outstanding machines to be rebooted during the cycle but on which processing has not yet started.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachinesSkipped
Gets reboot cycles that have the specified count of machines scheduled for reboot during the cycle but which were not processed either because the cycle was canceled or abandoned or because the machine was unavailable for reboot processing throughout the cycle.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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”.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RebootDuration
Gets reboot cycles that have the specified approximate maximum duration in minutes over which the reboot cycle runs.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RebootScheduleName
Gets reboot cycles which were triggered by the named reboot schedule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-RebootScheduleUid
Gets reboot cycles which were triggered by the reboot schedule with aparticular Uid.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RestrictToTag
An optional Tag which limits the reboot cycle to machines within the desktop group with the specified tag.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-StartTime
Gets reboot cycles that have the specified time at which the reboot cycle started.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-State
Gets reboot cycles that have the specified overall state of the reboot cycle. Valid values are Initializing, Active, Completed, Canceled, and Abandoned.
| Type: | RebootCycleState |
| 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.RebootCycle
Returns matching reboot cycles.
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.