Set-BEDiskCartridgeDevice Help

Synopsis

Sets the properties for a disk cartridge device in Backup Exec.

Syntax

Set-BEDiskCartridgeDevice -InputObject [<BEDiskCartridgeDevice[]>] [[-BackupExecServer] [<BEBackupExecServer>]] [-BlockSizeBytes [<Int32>]] [-BlockAndBufferSizeAutoDetectEnabled [<Boolean>]] [-BufferedReadsWritesAutoDetectEnabled [<Boolean>]] [-BufferSizeBytes [<Int32>]] [-Disabled [<Boolean>]] [-Description [<String>]] [-PreallocationIncrementBytes [<Int64>]] [-PreallocationEnabled [<Boolean>]] [-MaximumFileSizeBytes [<Int64>]] [-Paused [<Boolean>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Description

Sets the properties for a disk cartridge device in Backup Exec.

Parameters

-BackupExecServer <BEBackupExecServer>

Specifies which Backup Exec server the device is attached to in a CASO environment.

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

-Description <String>

Specifies the description for the disk cartridge device.

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

-Disabled <Boolean>

Specifies if the disk cartridge 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 disk cartridge device is paused.

The valid values are:
$true
$false

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

-MaximumFileSizeBytes <Int64>

Specifies the maximum file size on the disk storage.

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

-PreallocationEnabled <Boolean>

Enables proallocation to occur.

The valid values are:
$true
$false

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

-PreallocationIncrementBytes <Int64>

Specifies the size of preallocating space to increment at a time.

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

-BlockAndBufferSizeAutoDetectEnabled <Boolean>

Specifies if Backup Exec automatically detects the preferred settings for the block and buffer size for the disk storage.

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

-BufferedReadsWritesAutoDetectEnabled <Boolean>

Specifies that you do not want Backup Exec to automatically detect settings for this disk and enables buffered reads and writes. Buffered reads and writes is the reading and writing of large blocks of data.

The valid values are:
$true
$false

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

-InputObject <BEDiskCartridgeDevice[]>

Specifies one or more disk cartridge 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

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

Input Type

BackupExec.Management.CLI.BEDiskCartridgeDevice

You can pipe a Backup Exec disk cartridge device object to Set-BEDiskCartridgeDevice.

Return Value

BackupExec.Management.CLI.BEDiskCartridgeDevice

Set-BEDiskCartridgeDevice returns an object that represents the changed disk cartridge device.

Example

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

These commands pause the disk cartridge device named "Device 0001".