Rename-DPMRole

  • Reference
Module:
DataProtectionManager

Changes the name or description of a DPM role.

Syntax

Rename-DPMRole
      [-DpmRole] <DpmRole>
      [[-Name] <String>]
      [[-Description] <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Rename-DPMRole cmdlet changes the name or description of a System Center - Data Protection Manager (DPM) role. DPM roles let Microsoft SQL Server database owners to recover databases without assistance from a DPM administrator. Save your changes by using the Set-DPMRole cmdlet.

Examples

Example 1: Change the name of a role

PS C:\>$DpmRole = Get-DpmRole -Name "OpsMgrSQL" -Editable
PS C:\> Rename-DPMRole -DpmRole $DpmRole -Name "OpsMgrSQL23"
PS C:\> Set-DPMRole -DPMRole $DpmRole

The first command gets the role by using the Get-DpmRole cmdlet, and then stores it in the $DpmRole variable. The command makes the role editable.

The second command renames the role stored in $DpmRole.

The third command saves the change made in the second command for the role stored in $DpmRole by using the Set-DPMRole cmdlet.

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

-Description

Specifies a description for the DPM role.

Type:String
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DpmRole

Specifies a DPM role that this cmdlet modifies. To obtain a DPM role object, use the Get-DPMRole cmdlet.

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

-Name

Specifies a name for the DPM role.

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