Add-CVVirtualMachine

Updated

This commandlet (cmdlet) functions only for VMware, Hyper-V and vCloud.

The Add-CVVirtualMachine cmdlet adds virtual machine content to 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

Add-CVVirtualMachine -ClientName <String> [-SubclientName <String>] -Entity <String> [-EntityType <String>] [-OperationType {ADD | DELETE | OVERWRITE}] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-CVVirtualMachine -ClientObject <Object> [-SubclientName <String>] -Entity <String> [-EntityType <String>] [-OperationType {ADD | DELETE | OVERWRITE}] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Required Parameters

Parameter

Description

Data type

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

–ClientName

The name of the client that the subclient is associated with.

String

No

No

Named

–ClientObject

The object that represents the client that the subclient is associated with.

Object

Yes, by:

  • Value

  • Property name

No

Named

–Entity

The name of entity to add.

You can add 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

–SubclientName

The name of the subclient to add the VM content to.

If you don't include this parameter, the content is added to the default subclient.

String

No

No

Named

–EntityType

The type of entity.

String

Valid values include the following:

  • Cluster

  • Host

  • VMName (default)

No

No

Named

–OperationType

The operation to perform on the subclient virtual machine.

Enumerated

  • Valid values:

  • ADD (default)

  • DELETE

  • OVERWRITE

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 content was added successfully.

Examples

Add VM Content to a Subclient

The following example adds VM content to a subclient.

Add-CVVirtualMachine -ClientName myClient -SubclientName testSubclient -EntityType VM -Entity myVM

Add VM Content to the Default Subclient

The following example adds VM content to the default subclient.

Add-CVVirtualMachine -ClientName myClient -EntityType VM -Entity VM1,VM2,VM3