Citrix Daas SDK

Restore-ProvVMToBackupOperation

Schedules the Restoration of the persistent VM to one of its specified provisioned backups.

Syntax

Restore-ProvVMToBackupOperation
       -ScheduledStartTimeInUTC <DateTime>
       -BackupUid <Guid>
       [-DiskOnly]
       [-MaintenanceCycleDescription <String>]
       -MaxDurationInMinutes <Int32>
       [-PurgeDBAfterInDays <Int32>]
       [-SessionWarningTimeInMinutes <Int32>]
       [-SessionWarningLogOffTitle <String>]
       [-SessionWarningLogOffMessage <String>]
       [-LoggingId <Guid>]
       [<CitrixCommonParameters>]
       [<CommonParameters>]
<!--NeedCopy-->
Restore-ProvVMToBackupOperation
       [-StartsNow]
       -BackupUid <Guid>
       [-DiskOnly]
       [-MaintenanceCycleDescription <String>]
       -MaxDurationInMinutes <Int32>
       [-PurgeDBAfterInDays <Int32>]
       [-SessionWarningTimeInMinutes <Int32>]
       [-SessionWarningLogOffTitle <String>]
       [-SessionWarningLogOffMessage <String>]
       [-LoggingId <Guid>]
       [<CitrixCommonParameters>]
       [<CommonParameters>]
<!--NeedCopy-->

Description

Schedules the persistent VM’s hardware and boot disk to be restored to a previous state via a maintenance cycle operation.

Examples

Parameters

-ScheduledStartTimeInUTC

Scheduled a time for the operation to run.

Type: DateTime
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-StartsNow

Run the operation now.

Type: SwitchParameter
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-BackupUid

The unique identifiers of the provisioned backups to be used as the basis of restoring.

Type: Guid
Position: Named
Default value: None
Required: True
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: True
Accept pipeline input: False
Accept wildcard characters: False

-DiskOnly

Indicates only the boot disk of the VM should be restored. The hardware configuration of the VM will be untouched

Type: SwitchParameter
Position: Named
Default value: None
Required: False
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

-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

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.

Restore-ProvVMToBackupOperation