Backup Exec Management Command Line Interface Help
Set-BETapeDriveDevice Cmdlet
Synopsis

Sets the properties for a tape drive device in Backup Exec.

Syntax
Set-BETapeDriveDevice -InputObject [<BETapeDriveDevice[]>] [-ReadSingleBlockModeEnabled [<Boolean>]] [-WriteSingleBlockModeEnabled [<Boolean>]] [-BufferCount [<Int32>]] [-HighWaterCount [<Int32>]] [-ReadScsiPassThruModeEnabled [<Boolean>]] [-WriteScsiPassThruModeEnabled [<Boolean>]] [-Description [<String>]] [-Disabled [<Boolean>]] [-ReadableMediaType [<BEMediaType[]>]] [-WritableMediaType [<BEMediaType[]>]] [-BlockSizeBytes [<Int32>]] [-BufferSizeBytes [<Int32>]] [-Paused [<Boolean>]] [-CompressionEnabled [<Boolean>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]
Description

Sets the properties for a tape drive device in Backup Exec.

Parameters

-ReadableMediaType <BEMediaType[]>

Specifies the readable media type.


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


-WritableMediaType <BEMediaType[]>

Specifies the writeable media type.


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


-Description <String>

Specifies the description for the tape drive device.


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


-Disabled <Boolean>

Specifies if the tape drive device is disabled.

The valid values are:
$true
$false


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


-Paused <Boolean>

Specifies if the tape drive device is paused.

The valid values are:
$true
$false


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


-CompressionEnabled <Boolean>

Enables compression on this device.

The valid values are:
$true
$false


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


-BlockSizeBytes <Int32>

Specifies the size in bytes of blocks of data that can be written to new media.


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


-BufferSizeBytes <Int32>

Specifies the amount of data sent to the disk cartridge on each read or write request.


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


-BufferCount <Int32>

Specifies the number of buffers allocated for this tape device.


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


-HighWaterCount <Int32>

Specifies the number of buffers to be filled before data is first sent to the tape drive, and any time after that if the tape drive under runs.


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


-ReadSingleBlockModeEnabled <Boolean>

Specifies if this tape drive reads only one block of data at a time, regardless of the size of the buffer block.

The valid values are:
$true
$false


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


-WriteSingleBlockModeEnabled <Boolean>

Specifies if this tape drive writes only one block of data at a time. This parameter provides greater control over the handling of data write errors.

The valid values are:
$true
$false


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


-ReadScsiPassThruModeEnabled <Boolean>

Specifies if this tape drive reads data without going through a Microsoft tape device API. This parameter allows the data to pass directly through the tape drive and allows more detailed information if device errors occur.

The valid values are:
$true
$false


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


-WriteScsiPassThruModeEnabled <Boolean>

Specifies if this tape drive writes data without going through the Microsoft tape device API. This parameter allows data to pass directly through the device driver and allows more detailed information if device errors occur.

The valid values are:
$true
$false


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


-InputObject <BETapeDriveDevice[]>

Specifies one or more tape drive 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


-WhatIf <SwitchParameter>

Describes what happens if you execute the command without actually executing the command.


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


-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.


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


<CommonParameters>

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

Input Type
BackupExec.Management.CLI.BETapeDriveDevice

You can pipe a Backup Exec tape drive device object to Set-BETapeDriveDevice.

Return Value
BackupExec.Management.CLI.BETapeDriveDevice

Set-BETapeDriveDevice returns an object that represents the changed tape drive device.

Example
C:\PS> Get-BETapeDriveDevice "Device 0001" | Set-BETapeDriveDevice -Paused $true

These commands pause the tape drive device named "Device 0001".

Related Link

Get-BETapeDriveDevice