Get-BEBackupExecServer Help

Synopsis

Gets servers in Backup Exec.

Syntax

Get-BEBackupExecServer [[-Name] [<String[]>]] [<CommonParameters>]

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

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

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

Description

Gets servers in Backup Exec.

When run on a Backup Exec server that is not a central administration server, Get-BEBackupExecServer returns the local Backup Exec server.

Without parameters, Get-BEBackupExecServer gets all of the managed Backup Exec servers in the CASO environment. You can also specify a managed Backup Exec server by Backup Exec server name or Backup Exec server ID (Guid) or pass a Backup Exec server object through the pipeline to Get-BEBackupExecServer.

Parameters

-Local <SwitchParameter>

Gets the Backup Exec server object for the local computer.

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

-Name <String[]>

Specifies one or more Backup Exec servers by 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

-Id <Guid[]>

Specifies one or more Backup Exec servers by 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 <BEBackupExecServer[]>

Specifies one or more Backup Exec 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

System.Guid

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

BackupExec.Management.CLI.BEBackupExecServer

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

Return Value

BackupExec.Management.CLI.BEBackupExecServer

Get-BEBackupExecServer returns objects that represent Backup Exec servers.

Examples

Example 1

C:\PS> Get-BEBackupExecServer

This command gets all of the Backup Exec servers.

Example 2

C:\PS> Get-BEBackupExecServer -Name "MyManagedServer"

This command gets the Backup Exec server named "MyManagedServer"

Example 3

C:\PS> Get-BEBackupExecServer -Name "*Managed*"

This command gets all of the Backup Exec servers that match the wildcard "*Managed*"

Example 4

C:\PS> Get-BEBackupExecServer -Local

This command gets the local Backup Exec server.

Example 5

C:\PS> Get-BEBackupExecServer -Local | Get-BEStorage

This command gets all of the backup storage accessible to the local Backup Exec server.