Rename-DPMLibrary

  • Reference
Module:
DataProtectionManager

Renames a DPM library.

Syntax

Rename-DPMLibrary
      [-DPMLibrary] <Library>
      [-NewName] <String>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Rename-DPMLibrary cmdlet renames a System Center - Data Protection Manager (DPM) library in the DPM Administrator Console.

Examples

Example 1: Rename a library

PS C:\>$DpmLibrary = Get-DPMLibrary -DPMServerName "DPMServer07"
PS C:\> Rename-DPMLibrary -DPMLibrary $DpmLibrary -NewName "Library Western 03"

The first command uses the Get-DPMLibrary cmdlet to get the tape library for the specified server, and stores that object in the $DpmLibrary variable.

The second command changes the name the library stored in the $DpmLibrary variable to Library Western 03.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DPMLibrary

Specifies a DPM library object that this cmdlet renames. To obtain a DPM library object, use the Get-DPMLibrary cmdlet.

Type:Library
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NewName

Specifies a new name for the library.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Library