Get-ProvMaintenanceCycleVM
Gets the list of Maintenance Cycle Jobs
Syntax
Get-ProvMaintenanceCycleVM
[-MaintenanceCycleId <Guid>]
[-VirtualMachineSid <String>]
[-MaintenanceOperation <MaintenanceCycleOperationType>]
[-MaintenanceStatus <MaintenanceCycleStatus>]
[-MachineName <String>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
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 provisioning maintenance cycle vm objects for the machine sid provided
C:\Windows\system32> Get-ProvMaintenanceCycleVM -VirtualMachineSid "S-1-5-21-1369695582-2951410066-511316603-54729"
JobId : adcfd978-6de1-45c4-b365-a6b65f3cf6bc
MachineName : SERENITY\MCYC23
MaintenanceCycleId : ba111edc-4357-4e31-93c7-c38b2b7f82ea
MaintenanceEndTime : 2/26/2024 10:25:22 AM
MaintenanceInformation : The Maintenance for the virtual machine has been scheduled
MaintenanceStartTime : 2/26/2024 10:25:20 AM
MaintenanceStatus : Completed
Operation : HardwareUpdate
VirtualMachineSid : S-1-5-21-1369695582-2951410066-511316603-54729
JobId : 4917dbc5-85aa-49d9-bba8-ed25c82609a0
MachineName : SERENITY\MCYC23
MaintenanceCycleId : 2042e5a4-c535-4476-867c-fabc02734ffa
MaintenanceEndTime : 2/26/2024 10:35:17 AM
MaintenanceInformation : The Maintenance for the virtual machine has been scheduled
MaintenanceStartTime : 2/26/2024 10:20:17 AM
MaintenanceStatus : NotProcessed
Operation : HardwareUpdate
VirtualMachineSid : S-1-5-21-1369695582-2951410066-511316603-54729
JobId : 71334c3e-dd1d-49ea-9b35-fc47f28595c7
MachineName : SERENITY\MCYC23
MaintenanceCycleId : 2f6582f9-1260-486d-89a9-5786a7056a59
MaintenanceEndTime : 2/26/2024 10:38:39 AM
MaintenanceInformation : The Maintenance for the virtual machine has been scheduled
MaintenanceStartTime : 2/26/2024 10:25:22 AM
MaintenanceStatus : Completed
Operation : ResetOSDisk
VirtualMachineSid : S-1-5-21-1369695582-2951410066-511316603-54729
EXAMPLE 2
Returns all of the available provisioning maintenance cycle vm objects for the machine sid given and the status being completed
C:\Windows\system32> C:\Windows\system32> Get-ProvMaintenanceCycleVM -VirtualMachineSid "S-1-5-21-1369695582-2951410066-511316603-54729" -MaintenanceStatus Completed
JobId : adcfd978-6de1-45c4-b365-a6b65f3cf6bc
MachineName : SERENITY\MCYC23
MaintenanceCycleId : ba111edc-4357-4e31-93c7-c38b2b7f82ea
MaintenanceEndTime : 2/26/2024 10:25:22 AM
MaintenanceInformation : The Maintenance for the virtual machine has been scheduled
MaintenanceStartTime : 2/26/2024 10:25:20 AM
MaintenanceStatus : Completed
Operation : HardwareUpdate
VirtualMachineSid : S-1-5-21-1369695582-2951410066-511316603-54729
JobId : 71334c3e-dd1d-49ea-9b35-fc47f28595c7
MachineName : SERENITY\MCYC23
MaintenanceCycleId : 2f6582f9-1260-486d-89a9-5786a7056a59
MaintenanceEndTime : 2/26/2024 10:38:39 AM
MaintenanceInformation : The Maintenance for the virtual machine has been scheduled
MaintenanceStartTime : 2/26/2024 10:25:22 AM
MaintenanceStatus : Completed
Operation : ResetOSDisk
VirtualMachineSid : S-1-5-21-1369695582-2951410066-511316603-54729
EXAMPLE 3
Returns all of the available provisioning maintenance cycle vm objects for the machine sid given and the operation being HardwareUpdate
C:\Windows\system32> Get-ProvMaintenanceCycleVM -VirtualMachineSid "S-1-5-21-1369695582-2951410066-511316603-54718" -MaintenanceOperation HardwareUpdate
JobId : c33b62bd-dc2c-42e1-9c5c-c6139ebc920b
MachineName : SERENITY\MCYC16
MaintenanceCycleId : ba111edc-4357-4e31-93c7-c38b2b7f82ea
MaintenanceEndTime : 2/26/2024 10:18:29 AM
MaintenanceInformation : The Maintenance for the virtual machine has been scheduled
MaintenanceStartTime : 2/26/2024 10:18:28 AM
MaintenanceStatus : Completed
Operation : HardwareUpdate
VirtualMachineSid : S-1-5-21-1369695582-2951410066-511316603-54718
JobId : de72be2e-71ba-49c8-ad1b-faae7852d3ba
MachineName : SERENITY\MCYC16
MaintenanceCycleId : 2042e5a4-c535-4476-867c-fabc02734ffa
MaintenanceEndTime : 2/26/2024 10:32:20 AM
MaintenanceInformation : The Maintenance for the virtual machine has been scheduled
MaintenanceStartTime : 2/26/2024 10:32:03 AM
MaintenanceStatus : Completed
Operation : HardwareUpdate
VirtualMachineSid : S-1-5-21-1369695582-2951410066-511316603-54718
Parameters
-MaintenanceCycleId
A Filter parameter to filter the maitenancecyclevm objects on Maintenance Cycle Id
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-VirtualMachineSid
A Filter parameter to filter the maitenancecyclevm objects on Virtual Machine Sid
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-MaintenanceOperation
A Filter parameter to filter the maitenancecyclevm objects on Maintenance Operation
| Type: | MaintenanceCycleOperationType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-MaintenanceStatus
A Filter parameter to filter the maitenancecyclevm objects on MaintenanceStatus
| Type: | MaintenanceCycleStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-MachineName
A Filter parameter to filter the maitenancecyclevm objects on Machine 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.MaintenanceCycleVM
This object provides the details of the maintenance cycle vm object and contains the following document
VirtualMachineSid \< string\> The virtual machine sid associated with the maintenance cycle
JobId \< Guid\> Unique identifier to identify the maintenance cycle vm object
MachineName \< string\> The virtual machine name associated with the maintenance cycle
MaintenanceCycleId \< string\> Unique identifier to identify the maintenance cycle
MaintenanceStartTime \< datetime\> The time at which the machine started running the respective maintenance cycle operation
MaintenanceEndTime \< datetime\> The time at which the machine completed running the respective maintenance cycle operation
Operation \< string\> Indicates the operation associated to the maintenance cycle
MaintenanceStatus \< string\> Indicates the status at which the maintenance cycle vm object is currently at
MaintenanceInformation \< string\> Indicates the information about the current status of the maintenance cycle vm operation