-
-
-
-
-
-
-
-
-
-
-
New-ProvVMBackupOperation
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
New-ProvVMBackupOperation
Creates new provisioned backups for a virtual machine.
Syntax
New-ProvVMBackupOperation
[-BackupName <String>]
[-BackupDescription <String>]
[-UserVisible]
[-MaintenanceCycleDescription <String>]
-VMName <String[]>
-ProvisioningSchemeUid <Guid>
-ScheduledStartTimeInUTC <DateTime>
-MaxDurationInMinutes <Int32>
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
New-ProvVMBackupOperation
[-BackupName <String>]
[-BackupDescription <String>]
[-UserVisible]
[-MaintenanceCycleDescription <String>]
-VMName <String[]>
-ProvisioningSchemeName <String>
[-StartsNow]
-MaxDurationInMinutes <Int32>
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
New-ProvVMBackupOperation
[-BackupName <String>]
[-BackupDescription <String>]
[-UserVisible]
[-MaintenanceCycleDescription <String>]
-VMName <String[]>
-ProvisioningSchemeName <String>
-ScheduledStartTimeInUTC <DateTime>
-MaxDurationInMinutes <Int32>
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
New-ProvVMBackupOperation
[-BackupName <String>]
[-BackupDescription <String>]
[-UserVisible]
[-MaintenanceCycleDescription <String>]
-VMName <String[]>
-ProvisioningSchemeUid <Guid>
[-StartsNow]
-MaxDurationInMinutes <Int32>
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
New-ProvVMBackupOperation
[-BackupName <String>]
[-BackupDescription <String>]
[-UserVisible]
[-MaintenanceCycleDescription <String>]
[-AllVMs]
-ProvisioningSchemeUid <Guid>
-ScheduledStartTimeInUTC <DateTime>
-MaxDurationInMinutes <Int32>
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
New-ProvVMBackupOperation
[-BackupName <String>]
[-BackupDescription <String>]
[-UserVisible]
[-MaintenanceCycleDescription <String>]
[-AllVMs]
-ProvisioningSchemeName <String>
[-StartsNow]
-MaxDurationInMinutes <Int32>
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
New-ProvVMBackupOperation
[-BackupName <String>]
[-BackupDescription <String>]
[-UserVisible]
[-MaintenanceCycleDescription <String>]
[-AllVMs]
-ProvisioningSchemeName <String>
-ScheduledStartTimeInUTC <DateTime>
-MaxDurationInMinutes <Int32>
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
New-ProvVMBackupOperation
[-BackupName <String>]
[-BackupDescription <String>]
[-UserVisible]
[-MaintenanceCycleDescription <String>]
[-AllVMs]
-ProvisioningSchemeUid <Guid>
[-StartsNow]
-MaxDurationInMinutes <Int32>
[-PurgeDBAfterInDays <Int32>]
[-SessionWarningTimeInMinutes <Int32>]
[-SessionWarningLogOffTitle <String>]
[-SessionWarningLogOffMessage <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Lets you create new backups of virtual machines, including the boot disk and hardware attributes. The machine must be created by MCS and persistent.
Examples
EXAMPLE 1
Creates backups based on the virtual machines in the provisioning scheme “MyScheme”.
New-ProvVMBackupOperation -ProvisioningSchemeName MyScheme -StartsNow
<!--NeedCopy-->
EXAMPLE 2
Creates backups from virtual machines “vm01”, “vm02”, and “vm03” in the provisioning scheme “MyScheme”.
New-ProvVMBackupOperation -ProvisioningSchemeName MyScheme -VMNames vm01,vm02,vm03 -StartsNow
<!--NeedCopy-->
Parameters
-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 |
-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: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProvisioningSchemeUid
Indicates the Uid of the provisioning scheme
| Type: | Guid |
| 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 |
-ProvisioningSchemeName
Indicates the Name of the provisioning scheme
| Type: | String |
| 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 |
-AllVMs
Indicate that all virtual machines in the prov scheme has to be considered by the maintenance cycle
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BackupName
The name to use for each of the backups. The name must be unique relative to other provisioned backups for the targeted virtual machine. Certain backup and machine properties can be specified in using the form ‘{PropertyName}’. These properties include:
-
For the Provisioned Backup:
- CreationUTCDateTime
- BackupVersion
- BackupStatus
- BackupUid
-
For the Provisioned Virtual Machine:
- VMId
- VMName
- ProvisioningSchemeVersion
| Type: | String |
| Position: | Named |
| Default value: | {VMName}-{BackupUid} |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BackupDescription
Description to use for each of the backups.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserVisible
Sets whether the backup is visible to users.
| 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
Guid
Maintenance cycle associated with creating backups.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.