New-ProvSchemeImageUpdate
Introduced in: Citrix Virtual Apps and Desktop 7 2511
\[Experimental Command\]
Creates a new Maintenance Cycle for Image Update
Syntax
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeUid <Guid>
-ScheduledStartTimeInUTC <DateTime>
[-MasterImageVM <String>]
[-DataDisk <String>]
[-DoNotStoreOldImage]
[-UpdateAssignedImagesToVMsDuringServiceWindow]
[-UpdateVmsOnNaturalReboot]
[-KeepPreparationVMOnFailure]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeUid <Guid>
-ScheduledStartTimeInUTC <DateTime>
-ImageVersionSpecUid <Guid>
[-DoNotStoreOldImage]
[-UpdateAssignedImagesToVMsDuringServiceWindow]
[-UpdateVmsOnNaturalReboot]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeUid <Guid>
-ScheduledStartTimeInUTC <DateTime>
[-UpdateVmsToLatestProvSchemeImage]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeUid <Guid>
[-StartsNow]
[-MasterImageVM <String>]
[-DataDisk <String>]
[-DoNotStoreOldImage]
[-UpdateAssignedImagesToVMsDuringServiceWindow]
[-UpdateVmsOnNaturalReboot]
[-KeepPreparationVMOnFailure]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeUid <Guid>
[-StartsNow]
-ImageVersionSpecUid <Guid>
[-DoNotStoreOldImage]
[-UpdateAssignedImagesToVMsDuringServiceWindow]
[-UpdateVmsOnNaturalReboot]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeUid <Guid>
[-StartsNow]
[-UpdateVmsToLatestProvSchemeImage]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeName <String>
-ScheduledStartTimeInUTC <DateTime>
[-MasterImageVM <String>]
[-DataDisk <String>]
[-DoNotStoreOldImage]
[-UpdateAssignedImagesToVMsDuringServiceWindow]
[-UpdateVmsOnNaturalReboot]
[-KeepPreparationVMOnFailure]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeName <String>
-ScheduledStartTimeInUTC <DateTime>
-ImageVersionSpecUid <Guid>
[-DoNotStoreOldImage]
[-UpdateAssignedImagesToVMsDuringServiceWindow]
[-UpdateVmsOnNaturalReboot]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeName <String>
-ScheduledStartTimeInUTC <DateTime>
[-UpdateVmsToLatestProvSchemeImage]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeName <String>
[-StartsNow]
[-MasterImageVM <String>]
[-DataDisk <String>]
[-DoNotStoreOldImage]
[-UpdateAssignedImagesToVMsDuringServiceWindow]
[-UpdateVmsOnNaturalReboot]
[-KeepPreparationVMOnFailure]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeName <String>
[-StartsNow]
-ImageVersionSpecUid <Guid>
[-DoNotStoreOldImage]
[-UpdateAssignedImagesToVMsDuringServiceWindow]
[-UpdateVmsOnNaturalReboot]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-ProvSchemeImageUpdate
[-MaintenanceCycleDescription <String>]
-ProvisioningSchemeName <String>
[-StartsNow]
[-UpdateVmsToLatestProvSchemeImage]
[-ProvisioningSchemeVersion <Int32>]
[-MaxDurationInMinutes <Int32>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Schedules a maintenance cycle either for a provisioning scheme or for a list of vms as specified by the user to enforce a hardware update
Examples
Parameters
-ProvisioningSchemeName
Indicates the Name of the provisioningscheme
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScheduledStartTimeInUTC
Indicates the time in UTC at which the maintenance cycle will be started This must be a date time powershell object and user is expected to supply it as a parameter to the cmdlet
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartsNow
Indicates that the maintenance cycle has to be started immediately
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ImageVersionSpecUid
Specifies the respective image version spec uid
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UpdateVmsToLatestProvSchemeImage
Updates the booted image and assigned image of all VMs in the provisioning scheme to the latest image version
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProvisioningSchemeUid
Indicates the Uid of the provisioningscheme
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaintenanceCycleDescription
A brief overview to understand what the maintenance cycle is about
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProvisioningSchemeVersion
Specifies the provisioning scheme version to be updated to for image update
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxDurationInMinutes
Indicates the total allocated duration in minutes to the maintenance cycle
| Type: | Int32 |
| Position: | Named |
| Default value: | 30 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PurgeDBAfterInDays
The duration of time in days for mcs to have the data in database after maintenance cycles goes into completed states, once the time expires the data will be purged
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionWarningTimeInMinutes
Buffer Time provided to the user to save date before powering down the vm by mcs
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionWarningLogOffTitle
Short Heading for the message to be displayed to the user
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionWarningLogOffMessage
Brief Message intended to be displayed to the user before powering down the vm
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MasterImageVM
The path in the hosting unit provider to the VM snapshot or template that will be used. This identifies the hard disk to be used and the default values for the memory and processors. This must be a path to a Snapshot or Template item in the same hosting unit used by the provisioning scheme specified by ProvisioningSchemeName or ProvisioningSchemeUid. Valid paths are of the format:
XDHyp:\HostingUnits\\\<HostingUnitName\>\\\<path\>\\\<VMName\>.vm\\\<SnapshotName\>.snapshot XDHyp:\HostingUnits\\\<HostingUnitName\>\\\<path\>\\\<TemplateName\>.template
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DataDisk
The path in the hosting unit provider to the data disk that will be used. This identifies the hard disk to be used. This must be a path to a disk item in the same hosting unit used by the provisioning scheme specified by ProvisioningSchemeName or ProvisioningSchemeUid. Valid paths are of the format:
XDHyp:\HostingUnits\\\<HostingUnitName\>\\\<path\>\\\<VMName\>.vm\\\<MyDataDisk\>.disk
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DoNotStoreOldImage
Indicates that the current image should not be added to the image history list for the provisioning scheme. This is useful when rolling back to a previous image.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UpdateAssignedImagesToVMsDuringServiceWindow
Specifies if the image has to be updated only in the service window
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UpdateVmsOnNaturalReboot
Specifies if the image has to be assigned to vms on natural reboot
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-KeepPreparationVMOnFailure
If specified, the image preparation VM will not be deleted in case of image preparation failure. The image preparation VM can be used for troubleshooting purposes and can be removed on the hypervisor manually or will be removed automatically on the next Publish-ProvMasterVMImage operation for the same provisioning scheme.
| Type: | SwitchParameter |
| 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
None
By default, this cmdlet returns no output.