Dismount-CVVirtualMachine

Updated

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

The Dismount-CVVirtualMachine cmdlet initiates the live dismount of a specified VM from 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

Dismount-CVVirtualMachine -Id <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Dismount-CVVirtualMachine -ActiveMountObject <Object> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Required Parameters

Parameter

Description

Data type

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

–Id

The ID of the live mounted VM GUID.

String

No

No

Named

–ActiveMountObject

The object that contains the live mounted VM GUID.

Object

Yes, by:

  • Value

  • Property name

No

Named

Optional Parameters

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 dismount completed successfully.