Enable-VBRTapeLibraryMaintenance

Short Description

Enables the maintenance mode for a tape library or a standalone tape drive.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Enable-VBRTapeLibraryMaintenance -Library <VBRTapeLibrary[]> [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

The cmdlet enables the maintenance mode for a tape library or a standalone tape drive.

You can run this cmdlet if you need to lock a tape library or a standalone tape drive from being used by Veeam Backup & Replication, for example, to provide maintenance services to them.

You can disable the maintenance mode by running Disable-VBRTapeLibraryMaintenance.

Note

Before enabling the maintenance mode for the tape library, mind the following:

  • You cannot enable the maintenance mode for the tape library if the jobs that use this tape library are in the running state.
  • After you enable the maintenance mode for the tape library, all jobs that use it will fail with an error when starting.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Library

Specifies an array of tape libraries. The cmdlet will enable the maintenance mode for this array of tape libraries.

Accepts the VBRTapeLibrary object. To get this object, run the Get-VBRTapeLibrary cmdlet.

True

Named

True (ByValue,
ByPropertyName)

WhatIf

Defines whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

Confirm

Defines whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

None.

Examples

Enabling Maintenance Mode for Tape Library

This example shows how to enable the maintenance mode for the HP MSL G3 Series 5.30 tape library.

$library = Get-VBRTapeLibrary -Name "HP MSL G3 Series 5.30"

Enable-VBRTapeLibraryMaintenance -Library $library

Perform the following steps:

  1. Run the Get-VBRTapeLibrary cmdlet. Specify the Name parameter value. Save the result to the $library variable.
  2. Run the Enable-VBRTapeLibraryMaintenance cmdlet. Set the $library variable as the Library parameter value.

Related Commands

Get-VBRTapeLibrary