Share via


Set-DPMTape

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

Syntax

Archive

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

Cleaner

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

Free

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

Unfree

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

Description

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

Examples

Example 1: Mark a 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

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.

Parameters

-Archive

Indicates that the media is an archive tape.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Archive
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Cleaner

Indicates that the media is a cleaning tape.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Cleaner
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Free

Indicates that the media is free for use.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Free
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NotFree

Indicates that the media is not free for use.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Unfree
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Tape

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

Parameter properties

Type:

Media[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Tape