Get-BEAgentServer Help

Synopsis

Gets agent servers in Backup Exec.

Syntax

Get-BEAgentServer [[-Name] [<String[]>]] [-BackupStatus {Unknown | BackupSucceeded | BackupSucceededWithExceptions | NeverBackedUp | FirstBackupScheduled | BackupCanceled | BackupFailed}] [<CommonParameters>]

Get-BEAgentServer [-Local [<SwitchParameter>]] [<CommonParameters>]

Get-BEAgentServer -LogonAccount [<BELogonAccount[]>] [[-Name] [<String[]>]] [-BackupStatus {Unknown | BackupSucceeded | BackupSucceededWithExceptions | NeverBackedUp | FirstBackupScheduled | BackupCanceled | BackupFailed}] [<CommonParameters>]

Get-BEAgentServer [-Id] [<Guid[]>] [<CommonParameters>]

Get-BEAgentServer -InputObject [<BEAgentServer[]>] [<CommonParameters>]

Description

Gets agent servers in Backup Exec.

Agent server objects represent servers that can be backed up or restored and associated with logon accounts.

Without parameters, Get-BEAgentServer gets all of the Backup Exec agent servers. You can also specify an agent server by agent server name or agent server ID (Guid) or pass a Backup Exec agent server object through the pipeline to Get-BEAgentServer.

To get the agent server object that represents the local computer, specify the -Local parameter.

Parameters

-Local <SwitchParameter>

Gets the agent server object for the local computer.

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

-LogonAccount <BELogonAccount[]>

Specifies one or more logon account objects to filter the agent servers. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BELogonAccount.

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

-Name <String[]>

Specifies one or more agent servers by agent server name (wildcards accepted). To specify multiple names, use commas to separate the names.

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

-BackupStatus

Specifies one or more backup status objects to filter the agent servers. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEBackupStatus.

The valid values are:
Unknown
BackupSucceeded
BackupSucceededWithExceptions
NeverBackedUp
FirstBackupScheduled
BackupCanceled
BackupFailed

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

-Id <Guid[]>

Specifies one or more agent servers by agent server ID (Guid). To specify multiple IDs, use commas to separate the IDs.

Required	true
Position	0
Accepts pipeline input	true (ByValue)
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

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

Input Types

BackupExec.Management.CLI.BELogonAccount

You can pipe a Backup Exec logon account object to filter agent servers returned by Get-BEAgentServer.

System.Guid

You can pipe a System.Guid that contains the ID of a Backup Exec agent server object to Get-BEAgentServer.

BackupExec.Management.CLI.BEAgentServer

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

Return Value

BackupExec.Management.CLI.BEAgentServer

Get-BEAgentServer returns objects that represent Backup Exec agent servers.

Examples

Example 1

C:\PS> Get-BEAgentServer

This command gets all of the agent servers.

Example 2

C:\PS> Get-BEAgentServer -Name "myserver.mycompany.com"

This command gets the agent server named "myserver.mycompany.com".

Example 3

C:\PS> Get-BEAgentServer -Name "*.mycompany.com"

This command gets all of the agent servers that match the wildcard "*.mycompany.com".

Example 4

C:\PS> Get-BEAgentServer -Local

This command gets the agent server for the local computer.

Example 5

C:\PS> Get-BEAgentServer -Local | Set-BEAgentServerBackupSource

These commands get the backup sources for the local computer.

Example 6

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

These commands set the logon account for the agent server representing the local computer.

Example 7

C:\PS> Get-BEAgentServer -Local | Test-BELogonAccount

These commands test the logon account for the agent server representing the local computer.

Example 8

C:\PS> Get-BEAgentServer -Local | Submit-BEOnetimeBackup

These commands submit a one-time backup that backs up the entire local computer.

Example 9

C:\PS> Get-BEAgentServer -Local | New-BEBackupDefinition BackupToDisk | Save-BEBackupDefinition

These commands submit a backup definition that backs up the entire local computer.