Backup Exec Management Command Line Interface Help
Rename-BELogonAccount Cmdlet
Synopsis

Renames a Backup Exec logon account.

Syntax
Rename-BELogonAccount [-InputObject] [<BELogonAccount>] [[-NewName] [<String>]] [[-CurrentPassword] [<SecureString>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]
Description

Renames a Backup Exec logon account.

The System Logon Account cannot be renamed.

Parameters

-CurrentPassword <SecureString>

Specifies the current account password of the logon account. This is required when you rename a restricted logon account that was created by different user.


Required false
Position 2
Accepts pipeline input false
Accepts wildcard characters false


-InputObject <BELogonAccount>

Specifies the logon account object to rename.


Required true
Position 0
Accepts pipeline input true (ByValue)
Accepts wildcard characters false


-NewName <String>

Specifies the new name to assign to the logon account object.


Required false
Position 1
Accepts pipeline input false
Accepts wildcard characters false


-WhatIf <SwitchParameter>

Describes what happens if you execute the command without actually executing the command.


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


<CommonParameters>

For more information about common parameters, type "Get-Help about_commonparameters".

Input Type
BackupExec.Management.CLI.BELogonAccount

You can pipe a Backup Exec logon account object to Rename-BELogonAccount.

Return Value
BackupExec.Management.CLI.BELogonAccount

Rename-BELogonAccount returns an object that represents the logon account that was renamed.

Example
C:\PS> Get-BELogonAccount "LogonAccount 0001" | Rename-BELogonAccount -NewName "LogonAccount 0002"

These commands rename a logon account named "LogonAccount 0001" to "LogonAccount 0002".

Related Link

Get-BELogonAccount