This commandlet (cmdlet) functions only for VMware, Hyper-V and vCloud.
The Remove-CVVirtualMachine cmdlet removes virtual machines (VMs) from your CommCell environment.
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
Remove-CVVirtualMachine -ClientObject <Object> [-SubclientName <String>] -Entity <String> [-EntityType <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]Remove-CVVirtualMachine -ClientObject <Object> [-SubclientName <String>] -Entity <String> [-EntityType <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]Required Parameters
Parameter | Description | Data type | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
|---|---|---|---|---|---|
| The name of the client that the subclient is associated with. | String | No | No | Named |
| The object that represents the client that the subclient is associated with. | Object | Yes, by:
| No | Named |
| The name of the entity to remove. You can remove multiple entities using a comma-separated list. | String | No | No | Named |
Optional Parameters
Commvault Parameters
Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
|---|---|---|---|---|---|---|
| The name of the subclient to remove the VM content from. If you don't include this parameter, the content is removed from the default subclient. | String | No | No | Named | |
| The type of entity. | String | Valid values include the following:
| 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.
Inputs
This cmdlet does not support input.
Output
A message that indicates whether the VM content was removed successfully.
Examples
Remove a VM from the CommCell Environment
The following example removes a VM from your CommCell environment.
Remove-CVVirtualMachine -ClientName myClient -SubclientName testSubclient -EntityType VM -Entity VMRemove Multiple VMs from the CommCell Environment
The following example removes multiple VMs from your CommCell environment. The VMs are in a comma-separated list.
Remove-CVVirtualMachine -ClientName myClient -EntityType VM -Entity VM1, VM2, VM3