Update-ProvVMBackupSchedule
Introduced in: Citrix Virtual Apps and Desktop 7 2407
Updates a specific schedule
Syntax
Update-ProvVMBackupSchedule
[-MaxNumberOfBackups <Int32>]
-ScheduleId <Guid>
[-MaxDurationInMinutes <Int32>]
[-NextScheduledStartTimeInUTC <DateTime>]
[-RecurringSchedule <String>]
[-VMName <String[]>]
[-ProvisioningSchemeUid <Guid>]
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Updates specific parameters on a schedule via the schedule Id
Examples
Parameters
-ScheduleId
The Id of the schedule
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxNumberOfBackups
The maximum number of backups that can exist, per virtual machine as part of the provisioning schedule
| 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 provisioning schedule
| Type: | Int32 |
| Position: | Named |
| Default value: | 30 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-NextScheduledStartTimeInUTC
Indicates the next scheduled time for the provisioning schedule
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RecurringSchedule
Indicates how frequently the operation needs to be run, can be daily, weekly or monthly
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMName
An array of virtual machine names to which the maintenance cycle operation need to be executed
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-ProvisioningSchemeUid
Provisioning Scheme Uid for the provisioning schedule to be serviced
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-PurgeDBAfterInDays
The duration of time in days for mcs to wait before purging relevant info from the database upon completion
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-SessionWarningLogOffTitle
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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-SessionWarningLogOffMessage
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 |
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.
Removed Parameters
Parameters in this section were available in older releases, and have been removed or replaced due to changes in functionality.
-MaxAllocatedDurationInMinutes
Indicates the total allocated duration in minutes to the provisioning schedule
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Removed in: | Citrix Virtual Apps and Desktop 7 2411 |
-SessionWarningInMinutes
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 |
| Removed in: | Citrix Virtual Apps and Desktop 7 2411 |
-PurgeMaintenanceCycleInfoAfterInDays
The duration of time in days for mcs to wait before purging relevant info from the database upon completion
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Removed in: | Citrix Virtual Apps and Desktop 7 2411 |
Inputs
None
You can't pipe objects to this cmdlet.
Outputs
None
By default, this cmdlet returns no output.