Share via


Start-DPMLibraryInventory

Starts an inventory of tapes in a DPM library.

Syntax

FastInventory (Default)

Start-DPMLibraryInventory
    [-DPMLibrary] <Library>
    [-FastInventory]
    [-JobStateChangedEventHandler <JobStateChangedEventHandler>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DetailedInventory

Start-DPMLibraryInventory
    [-DPMLibrary] <Library>
    [-DetailedInventory]
    [-Tape <Media[]>]
    [-JobStateChangedEventHandler <JobStateChangedEventHandler>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Start-DPMLibraryInventory cmdlet starts an inventory of the tapes in a System Center - Data Protection Manager (DPM) library. DPM detects any tape, with or without a bar code, in a library. You can choose either a detailed inventory or a fast inventory.

For a detailed inventory, DPM reads the header area of the tapes in a library to identify the on-media identifier (OMID) on each tape.

For a fast inventory of a library that has a bar code reader, DPM reads the bar code of each tape in the library. If a library does not have a bar code reader or a tape does not have a bar code, DPM reads the header area of the tapes to identify the OMID.

Examples

Example 1: Perform a fast inventory

PS C:\>$DpmLibrary = Get-DPMLibrary -DPMServerName "DPMServer07"
PS C:\> Start-DPMLibraryInventory -DPMLibrary $DpmLibrary -FastInventory

The first command uses the Get-DPMLibrary cmdlet to get the library associated with the server, and then stores that object in the $DpmLibrary variable.

The second command starts an inventory on the library object stored in $DpmLibrary. The command specifies the FastInventory parameter, so the command starts a fast inventory.

Example 2: Perform a detailed inventory

PS C:\>$DpmLibrary = Get-DPMLibrary -DPMServerName "DPMServer07"
PS C:\> Start-DPMLibraryInventory -DPMLibrary $DpmLibrary -DetailedInventory

The first command uses the Get-DPMLibrary cmdlet to get the library associated with the server, and then stores that object in the $DpmLibrary variable.

The second command starts an inventory on the library object stored in $DpmLibrary. The command uses the DetailedInventory parameter, so the command starts a detailed inventory.

Parameters

-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

-DetailedInventory

Indicates that DPM performs a detailed inventory on the specified library.

Parameter properties

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

Parameter sets

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

-DPMLibrary

Specifies a DPM library object for which this cmdlet start an inventory. To obtain a DPM library object, use the Get-DPMLibrary cmdlet.

Parameter properties

Type:Library
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

-FastInventory

Indicates that DPM performs a fast inventory on the specified library.

Parameter properties

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

Parameter sets

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

-JobStateChangedEventHandler

Specifies an event handler for Job.StateChanged events. Use this parameter to build a graphical user interface based on cmdlets. Do not use this parameter in the DPM Management Shell.

Parameter properties

Type:JobStateChangedEventHandler
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 tape 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

DetailedInventory
Position:Named
Mandatory:False
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

Job