# Get-CVVirtualMachine

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

The `Get-CVVirtualMachine` cmdlet returns the virtual machines (VMs) in your CommCell environment.

If you do not provide any parameters, `Get-CVVirtualMachine` returns all the VMs 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

    Get-CVVirtualMachine [-Name $[String]] [-Protected] [-UnProtected] [-IncludeTotalCount] [-Skip $[UInt64]] [-First $[UInt64]] [$[CommonParameters]]

    Get-CVVirtualMachine [-Name $[String]] [-Id $[String]] [-Protected] [-UnProtected] [-IncludeTotalCount] [-Skip $[UInt64]] [-First $[UInt64]] [$[CommonParameters]]

    Get-CVVirtualMachine [-Name $[String]] [-ClientName $[String]] [-Protected] [-UnProtected] [-IncludeTotalCount] [-Skip $[UInt64]] [-First $[UInt64]] [$[CommonParameters]]

    Get-CVVirtualMachine [-Name $[String]] [-ClientId $[int32]] [-Protected] [-UnProtected] [-IncludeTotalCount] [-Skip $[UInt64]] [-First $[UInt64]] [$[CommonParameters]]

    Get-CVVirtualMachine [-Name $[String]] [-ClientObject $[Object]] [-Protected] [-UnProtected] [-IncludeTotalCount] [-Skip $[UInt64]] [-First $[UInt64]] [$[CommonParameters]]

## Optional Parameters

### Commvault Parameters

Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter
--- | --- | --- | --- | --- | --- | ---
`–Name` | The name of the VM. | String |  | No | No | Named
`–Id` | The ID of the VM that represents the VM GUID. | String |  | No | No | Named
`–ClientName` | The name of the client. | String |  | No | No | Named
`–ClientId` | The ID of the client.. | Int32 | The default value is 0. | No | No | Named
`–ClientObject` | The object that represents the client. | Object |  | Yes, by: Value Property name | No | Named
`–Protected` | Gets only protected VMs. | SwitchParameter |  | No | No | Named
`–UnProtected` | Gets only unprotected VMs. | SwitchParameter |  | No | No | Named
`-IncludeTotalCount` | Includes the total count of VMs. | SwitchParameter |  | No | No | Named
`–Skip` | Gets a list of virtual machines with paging support -First 20 -Skip 5 (20 per page, skip first 5 pages) This parameter allows you to skip the first 'x' number of pages from the output and then displays the rest of the pages. | UInt64 |  | No | No | Named
`–First` | Get a list of virtual machines with paging support -First 20 (20 per page). This parameter allows you to display first 'x' number of records in one page and the remaining records in the next page. | UInt64 |  | 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 list of virtual machines.

## Examples

### List All the VMs in the CommCell Environment

The following example returns a list of all the VMs in your CommCell environment.

    Get-CVVirtualMachine

### List All the Unprotected VMs in the CommCell Environment

The following example returns a list of all the unprotected VMs in your CommCell environment.

    Get-CVVirtualMachine -UnProtected

×

Loading...