-
-
-
-
-
-
-
-
-
-
-
Get-ProvMaintenanceCycle
-
-
-
-
-
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-ProvMaintenanceCycle
Gets the list of Maintenance Cycles
Syntax
Get-ProvMaintenanceCycle
[-MaintenanceCycleId <Guid>]
[-CatalogName <String>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Provides the ability to obtain a list of the Maintenance Cycles that were created using Citrix Machine Creation Services.
Examples
EXAMPLE 1
Returns all of the available maintenance cycles
C:\Windows\system32> Get-ProvMaintenanceCycle -MaintenanceCycleId b96647ed-f7fa-47a8-9a22-434f934f5451 -CatalogName cyc
CatalogName : cyc
MaintenanceCycleDescription : Image Update Going on
MaintenanceCycleId : b96647ed-f7fa-47a8-9a22-434f934f5451
MaintenanceCycleStatus : Completed
MaxDurationInMinutes : 100
Operation : HardwareUpdate
ScheduledStartTime : 2/21/2024 7:53:14 AM
SessionLogOffMessage : Please log off, maintenance going on
SessionWarningTimeInMinutes : 30
<!--NeedCopy-->
Parameters
-MaintenanceCycleId
The unique identifier of the maintenance cycle.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-CatalogName
Gets the maintenance cycle associated to the catalog name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ReturnTotalRecordCount
When specified, the cmdlet outputs 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_Prov_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_Prov_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 |
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
You can’t pipe objects to this cmdlet.
Outputs
Citrix.MachineCreation.Sdk.MaintenanceCycle
This object provides the details of the maintenance cycle and contains the following document
CatalogName < string>
The catalog name associated with the maintenance cycle object
MaintenanceCycleDescription < string>
A brief overview to understand what the maintenance cycle is about
MaintenanceCycleId < Guid>
Unique identifier to identify the maintenance cycle
MaintenanceCycleStatus < string>
Indicates the status at which the maintenance cycle is currently at
Operation < string>
Indicates the operation associated to the maintenance cycle
MaxDurationInMinutes < int>
Max duration in minutes allocated for the maintenance cycle
PurgeDBAfterInDays < int>
Max duration in Days after which maintenance cycle results will be purged from the database
Defaulted to 30
ScheduledStartTimeInUTC < datetime>
Scheduled start time in UTC for the maintenance cycle
ScheduledCompletionTimeInUTC < datetime>
Scheduled Completion time in UTC for the maintenance cycle
SessionLogOffMessage < string>
Message intended to be displayed to the user before powering down the vm
SessionWarningTimeInMinutes < int>
Buffer Time provided to the user to save date before powering down the vm by mcs
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.