Set-BELogonAccount Help

Synopsis

Sets the properties for a Backup Exec logon account.

Syntax

Set-BELogonAccount -InputObject [<BELogonAccount[]>] [-AccountType {Restricted | Common}] [-Description [<String>]] [-CurrentPassword [<SecureString>]] [-UserName [<String>]] [-NewPassword [<SecureString>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Set-BELogonAccount -InputObject [<BELogonAccount[]>] -Credential [<PSCredential>] [-AccountType {Restricted | Common}] [-CurrentPassword [<SecureString>]] [-Description [<String>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Sets the properties for a Backup Exec logon account.

If the logon account is a restricted account and you are not the owner of the account, use the -CurrentPassword parameter to modify the logon account.

Parameters

-InputObject <BELogonAccount[]>

Specifies one or more logon account objects. Enter a variable that contains the objects, or type a command or expression that gets the objects.

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

-CurrentPassword <SecureString>

Specifies the current password assigned to this account. This must be specified if you are logged in as a user that is not the owner of the logon account, and the logon account is restricted.

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

-Credential <PSCredential>

Specifies the credentials of the logon account.

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

-UserName <String>

Specifies the user name of the logon account.

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

-NewPassword <SecureString>

Specifies the new password of the logon account.

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

-Description <String>

Specifies the description for the logon account.

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

-AccountType

Specifies if this is a common or restricted account.

The valid values are:
Restricted
Common

Required	false
Position	Named
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

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 Set-BELogonAccount.

Return Value

BackupExec.Management.CLI.BELogonAccount

Set-BELogonAccount returns an object that represents the changed logon account.

Example

C:\PS> Get-BELogonAccount "LogonAccount 0001" | Set-BELogonAccount -AccountType Common

These commands change the logon account named "LogonAccount 0001" to a common logon account.