Start-DPMLibraryInventory
Start-DPMLibraryInventory
Starts an inventory of tapes in a DPM library.
Syntax
Parameter Set: FastInventory
Start-DPMLibraryInventory [-DPMLibrary] <Library> [-FastInventory] [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: DetailedInventory
Start-DPMLibraryInventory [-DPMLibrary] <Library> -DetailedInventory [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-Tape <Media[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-DPMLibraryInventory cmdlet starts an inventory of the tapes in a System Center 2012 – 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.
Parameters
-DetailedInventory
Indicates that DPM performs a detailed inventory on the specified library.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DPMLibrary<Library>
Specifies a DPM library object for which this cmdlet start an inventory. To obtain a DPM library object, use the Get-DPMLibrary cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-FastInventory
Indicates that DPM performs a fast inventory on the specified library.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobStateChangedEventHandler<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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Tape<Media[]>
Specifies an array of tape on which this cmdlet operates. To obtain a Tape object, use the Get-DPMTape cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
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 (https://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.
- Job
Examples
Example 1: Perform a fast inventory
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.
PS C:\> $DpmLibrary = Get-DPMLibrary -DPMServerName "DPMServer07"
PS C:\> Start-DPMLibraryInventory -DPMLibrary $DpmLibrary -FastInventory
Example 2: Perform a detailed inventory
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.
PS C:\> $DpmLibrary = Get-DPMLibrary -DPMServerName "DPMServer07"
PS C:\> Start-DPMLibraryInventory -DPMLibrary $DpmLibrary -DetailedInventory