Set-BEAgentServer Help

Synopsis

Sets the properties for a Backup Exec agent server.

Syntax

Set-BEAgentServer -InputObject [<BEAgentServer[]>] [-LogonAccount [<BELogonAccount>]] [-Description [<String>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Sets the properties for a Backup Exec agent server.

Parameters

-LogonAccount <BELogonAccount>

Specifies the Backup Exec logon account used to browse the agent server.

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

-Description <String>

Specifies the description for the agent server.

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

-InputObject <BEAgentServer[]>

Specifies one or more agent server 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

-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.BEAgentServer

You can pipe a Backup Exec agent server object to Set-BEAgentServer.

Return Value

BackupExec.Management.CLI.BEAgentServer

Set-BEAgentServer returns an object that represents the changed Backup Exec agent server.

Example

C:\PS> Get-BEAgentServer server01 | Set-BEAgentServer -LogonAccount "System Logon Account"

These commands set the logon account for a server named "server01" to the System Logon Account.

Internal Server Error