Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Schedule-ProvVMUpdate

March 11, 2024
Contributed by: 
C

(DEPRECATED) Schedules a property update on provisioned virtual machines.

Syntax


Schedule-ProvVMUpdate -ProvisioningSchemeName <String> [-StartTimeInUTC <String>] [-StartsNow] [-DurationInMinutes <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Schedule-ProvVMUpdate -ProvisioningSchemeName <String> -VMName <String[]> [-StartTimeInUTC <String>] [-StartsNow] [-DurationInMinutes <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Schedule-ProvVMUpdate -ProvisioningSchemeUid <Guid> [-StartTimeInUTC <String>] [-StartsNow] [-DurationInMinutes <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Schedule-ProvVMUpdate -ProvisioningSchemeUid <Guid> -VMName <String[]> [-StartTimeInUTC <String>] [-StartsNow] [-DurationInMinutes <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

This cmdlet has been deprecated and replaced by Set-ProvVMUpdateTimeWindow. Set-ProvVMUpdateTimeWindow is the new name for Schedule-ProvVMUpdate and provides all the same functionality, please use it going foward in place of Schedule-ProvVMUpdate.

Provides the ability to synchronize the properties of existing virtual machines with any changes occurred on the provisioning scheme.

This cmdlet defines a time window where a provisioning scheme update will take place against either specific machines in a catalog or an entire catalog. The update will take place when the machine is next booted within the time window. On each VM an update is scheduled, ProvisioningSchemeUpdateRequested defines the start of the time window and ProvisioningSchemeUpdateUntil defines the end of the time window. These fields will be cleared upon a successful provisioning scheme update or if the time window has expired when the machine has booted

Parameters

Name Description Required? Pipeline Input Default Value
ProvisioningSchemeName The name of the provisioning scheme true true (ByValue, ByPropertyName)  
VMName List of VM names to schedule an update for. If not specified, all VMs in the machine catalog associated with the specified provisioning scheme will be scheduled for a property update true true (ByValue, ByPropertyName)  
ProvisioningSchemeUid The unique identifier of the provisioning scheme true false  
StartTimeInUTC The start time in UTC format of the time window the schedule is active for. Mutually exclusive with StartsNow switch. Must be no more than 5 seconds in the past. The string will be converted into a DateTime using parsing rules defined by the DateTime.Parse method, which allows for a timezone offset to specify time in any timezone. If no timezone offset is specified, UTC will be assumed. See the example usages of Schedule-ProvVMupdate or this link for more details https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?view=net-6.0#the-string-to-parse false false  
StartsNow Whether this schedule should start right away. Mutually exclusive with specific StartTimeInUTC. Implied to be set if StartTimeInUTC is not specified false false  
DurationInMinutes The duration in minutes of the time window the schedule is active for. If less than 0, indicates the schedule has no end time false false 120 minutes
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. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the Client IP of the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Citrix.Machinecreation.Sdk.Provisionedvirtualmachine

You can pipe an object containing parameters called ‘VMId’ and ‘ProvisioningSchemeName’ to Schedule-ProvVMUpdate.

Return Values

Notes

Running Set-ProvScheme to update provisioning scheme properties will only affect future provisioned machines. To schedule existing VMs in a catalog to be brought up to date upon the next power on, use this cmdlet to schedule certain or all VMs created from the provisioning scheme associated with the catalog to be updated.

Schedule-ProvVMUpdate
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.