Share via

Rename-DPMLibrary

  • Article

Rename-DPMLibrary

Renames a DPM library.

Syntax

Parameter Set: Default
Rename-DPMLibrary [-DPMLibrary] <Library> [-NewName] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

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

Parameters

-DPMLibrary<Library>

Specifies a DPM library object that this cmdlet renames. 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, ByPropertyName)

Accept Wildcard Characters?

false

-NewName<String>

Specifies a new name for the library.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

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?

true (ByPropertyName)

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.

  • Library

Examples

Example 1: Rename a library

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.

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

Disable-DPMLibrary

Enable-DPMLibrary

Get-DPMLibrary