Get-BEAgentServerBackupSource Help

Synopsis

Gets agent server backup sources in Backup Exec.

Syntax

Get-BEAgentServerBackupSource -AgentServer [<BEAgentServer>] [[-Name] [<String[]>]] [<CommonParameters>]

Get-BEAgentServerBackupSource -InputObject [<BEAgentServerBackupSource[]>] [-Children [<SwitchParameter>]] [<CommonParameters>]

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

Description

Gets agent server backup sources in Backup Exec.

Agent server backup sources represent resources of an agent server that can be backed up and associated with logon accounts.

To get the top-level agent server backup sources associated with an agent server, Get-BEAgentServerBackupSource requires an agent server object. See Get-BEAgentServer.

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

Parameters

-AgentServer <BEAgentServer>

Specifies the agent server that you want to get the agent server backup sources.

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

-Children <SwitchParameter>

Gets the children agent server backups sources associated with the agent server backup source object specified by the -InputObject parameter.

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

-InputObject <BEAgentServerBackupSource[]>

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

-Name <String[]>

Specifies one or more agent server backup sources by agent server backup source 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

-Id <Guid[]>

Specifies one or more agent server backup sources by agent server backup source 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

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

Input Types

BackupExec.Management.CLI.BEAgentServer

You an pipe a Backup Exec agent server object to Get-BEAgentServerBackupSource.

BackupExec.Management.CLI.BEAgentServerBackupSource

You can pipe a Backup Exec agent server backup source object to Get-BEAgentServerBackupSource.

System.Guid

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

Return Value

BackupExec.Management.CLI.BEAgentServerBackupSource

Get-BEAgentServerBackupSource returns objects that represent Backup Exec agent server backup sources.

Examples

Example 1

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

These commands get the top-level agent server backup sources associated with the local computer.

Example 2

C:\PS> Get-BEAgentServer -Local | Get-BEAgentServerBackupSource "Microsoft SQL Server Instances" | Get-BEAgentServerBackupSource -Children

These commands get the Microsoft SQL instance backup sources associated with the local computer.

Example 3

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

These commands set the logon account associated with the C: volume of the local computer.

Example 4

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

These commands test the logon account associated with the C: volume of the local computer.