Get-BEVirtualDiskDevice Help

Synopsis

Gets virtual disk devices in Backup Exec.

Syntax

Get-BEVirtualDiskDevice [[-Name] [<String[]>]] [-Unconfigured [<SwitchParameter>]] [<CommonParameters>]

Get-BEVirtualDiskDevice -BackupExecServer [<BEBackupExecServer[]>] [[-Name] [<String[]>]] [-Unconfigured [<SwitchParameter>]] [<CommonParameters>]

Get-BEVirtualDiskDevice -StorageArrayDevice [<BEStorageArrayDevice[]>] [[-Name] [<String[]>]] [-Unconfigured [<SwitchParameter>]] [<CommonParameters>]

Get-BEVirtualDiskDevice [-Id] [<Guid[]>] [-Unconfigured [<SwitchParameter>]] [<CommonParameters>]

Get-BEVirtualDiskDevice -InputObject [<BEVirtualDiskDevice[]>] [-Unconfigured [<SwitchParameter>]] [<CommonParameters>]

Description

Gets virtual disk devices in Backup Exec.

Without parameters, Get-BEVirtualDiskDevice gets all of the Backup Exec virtual disk devices. You can also specify a virtual disk device by virtual disk device name or virtual disk device ID (Guid) or pass a Backup Exec virtual disk device object through the pipeline to Get-BEVirtualDiskDevice.

By default, Get-BEVirtualDiskDevice does not return unconfigured virtual disk devices. Specify the -Unconfigured parameter to get unconfigured virtual disk devices.

Parameters

-Unconfigured <SwitchParameter>

Returns unconfigured virtual disk devices.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-BackupExecServer <BEBackupExecServer[]>

Specifies one or more Backup Exec server objects to filter the virtual machines. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEBackupExecServer.

Required	true
Position	Named
Accepts pipeline input	true (ByValue)
Accepts wildcard characters	false

-StorageArrayDevice <BEStorageArrayDevice[]>

Specifies one or more storage array objects to filter the virtual machines. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEStorageArrayDevice.

Required	true
Position	Named
Accepts pipeline input	true (ByValue)
Accepts wildcard characters	false

-Name <String[]>

Specifies one or more virtual disk devices by virtual disk device name (wildcards accepted). To specify multiple names, use commas to separate the names.

Required	false
Position	0
Accepts pipeline input	false
Accepts wildcard characters	true

-Id <Guid[]>

Specifies one or more virtual disk devices by virtual disk device ID (Guid). To specify multiple IDs, use commas to separate the IDs.

Required	true
Position	0
Accepts pipeline input	true (ByValue)
Accepts wildcard characters	false

-InputObject <BEVirtualDiskDevice[]>

Specifies one or more virtual disk device objects. Enter a variable that contains the objects, or type a command or expression that gets the objects.

Required	true
Position	Named
Accepts pipeline input	true (ByValue)
Accepts wildcard characters	false

For more information about common parameters, type "Get-Help about_commonparameters".

Input Types

BackupExec.Management.CLI.BEBackupExecServer

You can pipe a Backup Exec server object to filter virtual disk devices returned by Get-BEVirtualDiskDevice.

BackupExec.Management.CLI.BEStorageArrayDevice

You can pipe a Backup Exec storage array object to filter virtual machines returned by Get-BEVirtualDiskDevice.

System.Guid

You can pipe a System.Guid that contains the ID of a Backup Exec virtual disk device object to Get-BEVirtualDiskDevice.

BackupExec.Management.CLI.BEVirtualDiskDevice

You can pipe a Backup Exec virtual disk device object to Get-BEVirtualDiskDevice.

Return Value

BackupExec.Management.CLI.BEVirtualDiskDevice

Get-BEVirtualDiskDevice returns objects that represent Backup Exec virtual disk devices.

Examples

Example 1

C:\PS> Get-BEVirtualDiskDevice

This command gets all of the virtual disk devices.

Example 2

C:\PS> Get-BEVirtualDiskDevice -Name "Device 01"

This command gets the virtual disk device named "Device 01".

Example 3

C:\PS> Get-BEVirtualDiskDevice -Name "Device*"

This command gets all of the virtual disk devices that match the wildcard "Device*".

Example 4

C:\PS> Get-BEBackupExecServer -Local | Get-BEVirtualDiskDevice

This command gets all of the virtual disk devices attached to the local Backup Exec server.