This commandlet (cmdlet) functions only for VMware, Hyper-V and vCloud.
The Backup-CVVirtualMachine cmdlet initiates a backup of a specified virtual machine.
Before you can use this cmdlet, you must log on to your CommCell environment using the Connect-CVServer cmdlet. For more information, see Connecting to a CommCell Environment with PowerShell.
Syntax
Backup-CVVirtualMachine -Name String -ClientName String [-SubclientName String] [-BackupType {full | incremental | synthfull}] [-Protected] [-Force] [-WhatIf] [-Confirm] [CommonParameters]Backup-CVVirtualMachine -Id String [-SubclientName String] [-BackupType {full | incremental | synthfull}] [-Protected] [-Force] [-WhatIf] [-Confirm] [CommonParameters]Backup-CVVirtualMachine -ClientObject Object [-SubclientName String] [-BackupType {full | incremental |synthfull}] [-Protected] [-Force] [-WhatIf] [-Confirm] [CommonParameters]Required Parameters
|
Parameter |
Description |
Data type |
Accepts pipeline input? |
Accepts wildcard characters? |
Type of parameter |
|---|---|---|---|---|---|
|
|
The ID of the VM that represents the VM GUID. |
String |
No |
No |
Named |
|
|
The name of the VM. |
String |
No |
No |
Named |
|
|
The name of the client that the VM is associated with. |
String |
No |
No |
Named |
|
|
The object that represents the client that the VM is associated with. |
Object |
Yes, by:
|
No |
Named |
Optional Parameters
Commvault Parameters
|
Parameter |
Description |
Data type |
Accepts pipeline input? |
Accepts wildcard characters? |
Type of parameter |
|---|---|---|---|---|---|
|
|
Filters legacy, unprotected VMs. |
SwitchParameter |
No |
No |
Named |
Microsoft PowerShell Parameters
You can use the following Microsoft PowerShell parameters:
-
Debug
-
ErrorAction
-
ErrorVariable
-
OutBuffer
-
OutVariable
-
PipelineVariable
-
Verbose
-
WarningAction
-
WarningVariable
-
Force
-
Confirm
-
WhatIf
Note
Only a few cmdlets support Force, Confirm, and WhatIf parameters.
For more information, see "About Common Parameters" in the Microsoft PowerShell documentation.
Input
This cmdlet does not support input.
Output
A message that indicates whether the backup completed successfully.
Examples
Initiate a Backup of a Specific Virtual Machine
This example initiates a backup of a VM named autocs-winvm2.
Backup-CVVirtualMachine -ClientName Openstack-V2-client -Name autocs-winvm2
Initiate a Full Backup of a Specific Virtual Machine
This example initiates a full backup of a VM named autocs-winvm2.
Backup-CVVirtualMachine -ClientName Openstack-V2-client -Name autocs-winvm2 -BackupLevel Full