Get-BENetworkInterface Help

Synopsis

Gets the network interfaces of the local Backup Exec server.

Syntax

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

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

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

Description

Gets the network interfaces of the local Backup Exec server.

Without parameters, Get-BENetworkInterface gets all of the Backup Exec network interfaces. You can also specify a particular network interface by network interface name or network interface ID (Guid) or pass a Backup Exec network interface object through the pipeline to Get-BENetworkInterface.

The objects returned from Get-BENetworkInterface are used to set the NetworkInterface parameter of the Net-BEBackupDefiniton, Set-BEBackupDefinition, Set-BEbackupJobDefault, and Submit-BEOnetimeBackupJob commands.

Parameters

-Name <String[]>

Specifies one or more network interfaces by network interface 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 network interfaces by network interface 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 <BENetworkInterface[]>

Specifies one or more network interface 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 network interface object to Get-BENetworkInterface.

BackupExec.Management.CLI.BENetworkInterface

You can pipe a Backup Exec network interface object to Get-BENetworkInterface.

Return Value

BackupExec.Management.CLI.BENetworkInterface

Get-BENetworkInterface returns objects that represent Backup Exec network interfaces.

Examples

Example 1

C:\PS> Get-BENetworkInterface

This command gets all of the network interfaces attached to the local Backup Exec server.

Example 2

C:\PS> Get-BENetworkInterface -Name "Local Area Connection"

This command gets the network interfaces named "Local Area Connection".

Example 3

C:\PS> $networkInterface = Get-BENetworkInterface -Name "Local Area Connection"
C:\PS> Get-BEAgentServer server01 | Submit-BEOnetimeBackupJob -NetworkInterface $networInterface

These commands submit a one-time backup job of a server named "server01" using the network interface named "Local Area Connection".