> CommCell Console > Tools & Utilities > Developer Tools > Commvault PowerShell Module > Commvault PowerShell Module Reference > Virtualization

Mount-CVVirtualMachine

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

The Mount-CVVirtualMachine cmdlet initiates the live mount of a specified VM to a client in 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

Mount-CVVirtualMachine -Name String -ClientName String [-SubclientName String] [-NetworkName String] [-PolicyName String] [-JobId String] [-LiveMountVMName String] [-ExpirationInHours String] [-Force] [-WhatIf] [-Confirm] [CommonParameters]
Mount-CVVirtualMachine -Id String [-SubclientName String] [-NetworkName String] [-PolicyName String] [-JobId String] [-LiveMountVMName String] [-ExpirationInHours String] [-Force] [-WhatIf] [-Confirm] [CommonParameters]
Mount-CVVirtualMachine -ClientObject Object [-SubclientName String] [-NetworkName String] [-PolicyName String] [-JobId String] [-LiveMountVMName String] [-ExpirationInHours String] [-Force] [-WhatIf] [-Confirm] [CommonParameters]

Required Parameters

Parameter

Description

Data type

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

–Id

The ID of the source VM that represents the VM GUID.

String

No

No

Named

–Name

The name of the source VM.

String

No

No

Named

–ClientName

The name of the client that the source VM is associated with.

String

No

No

Named

–ClientObject

The object that represents the client that the source VM is associated with.

Object

Yes, by:

  • Value

  • Property name

No

Named

Optional Parameters

Commvault Parameters

Parameter

Description

Data type

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

–SubclientName

The name of the subclient.

This parameter overrides the default behavior.

String

No

No

Named

–NetworkName

The name of the network to use for the live mount operation.

String

No

No

Named

–PolicyName

The name of the policy to use for the live mount operation.

String

No

No

Named

–JobId

The ID of the backup job to use for the live mount operation.

String

No

No

Named

–LivemountVMName

The name to assign to the live mount.

String

No

No

Named

–ExpirationInHours

The number of hours after which the in-place live mount expires.

String

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 live mount completed successfully.

×

Loading...