Set-DPMTape

Set-DPMTape

Marks a tape as Archive, Cleaner, Free or Not Free.

Syntax

Parameter Set: Archive
Set-DPMTape [-Tape] <Media[]> -Archive [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Cleaner
Set-DPMTape [-Tape] <Media[]> -Cleaner [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Free
Set-DPMTape [-Tape] <Media[]> -Free [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Unfree
Set-DPMTape [-Tape] <Media[]> -NotFree [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-DPMTape cmdlet marks a tape as Archive, Cleaner, Free, or Not Free.

Parameters

-Archive

Indicates that the media is an archive tape.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Cleaner

Indicates that the media is a cleaning tape.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Free

Indicates that the media is free for use.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NotFree

Indicates that the media is not free for use.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Tape<Media[]>

Specifies an array of tapes on which this cmdlet operates. To obtain a Tape object, use the Get-DPMTape cmdlet.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Tape

Examples

Example 1: Mark a tape as free

The first command uses the Get-DPMLibrary cmdlet to retrieve the library for the server, and then stores it in the $DpmLibrary variable.

The second command uses the Get-DPMTape cmdlet to retrieve the tape object, and then stores it in the $DpmTape variable.

The third command sets the second tape as Free.

PS C:\> $DpmLibrary = Get-DPMLibrary -DPMServerName "Contoso-DPMServer"
PS C:\> $DpmTape = Get-Tape -DPMLibrary $DpmLibrary
PS C:\> Set-DPMTape -Tape $DpmTape[1] -Free

Add-DPMTape

Get-DPMLibrary

Get-DPMTape

Remove-DPMTape