Search-BECatalog Help

Synopsis

Searches the Backup Exec catalog for files and folders.

Syntax

Search-BECatalog [-AgentServer [<BEAgentServer[]>]] [-Path] [<String>] [-FromLastWriteTime [<DateTime>]] [-Recurse [<SwitchParameter>]] [-ToLastWriteTime [<DateTime>]] [-ToLength [<UInt64>]] [-FromLength [<UInt64>]] [-PathIsDirectory [<SwitchParameter>]] [-ToCreationTime [<DateTime>]] [-FromBackupTime [<DateTime>]] [-FromCreationTime [<DateTime>]] [-ToBackupTime [<DateTime>]] [<CommonParameters>]

Description

Searches the Backup Exec catalog for files and folders.

Parameters

-AgentServer <BEAgentServer[]>

Specifies one or more agent server objects to filter search results. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEAgentServer.

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

-Path <String>

Specifies the path of the file system folder or file taht you want to search (wildcards accepted).

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

-PathIsDirectory <SwitchParameter>

Specifies that the value of the Path parameter is a directory instead of a file.

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

-FromBackupTime <DateTime>

Filters the search results to items that have been backed up since the specified time.

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

-ToBackupTime <DateTime>

Filters the search results to items that have been backed up before the specified time.

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

-FromCreationTime <DateTime>

Filters the search results to items that have been created since the specified time.

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

-ToCreationTime <DateTime>

Filters the search results to items that have been created before the specified time.

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

-FromLastWriteTime <DateTime>

Filters the search results to items that have been modified since the specified time.

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

-ToLastWriteTime <DateTime>

Filters the search results to items that have been modified before the specified time.

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

-FromLength <UInt64>

Filters the search results to items that are greater than the specified file size in bytes.

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

-ToLength <UInt64>

Filters the search results to items that are less than the specified file size in bytes.

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

-Recurse <SwitchParameter>

Specifies that you want to search the subfolders.

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 filter search results returned by Search-BECatalog.

Return Value

BackupExec.Management.CLI.BEFileSystemCatalogSearchResult

Search-BECatalog returns object that represent Backup Exec catalog search results.

Examples

Example 1

C:\PS> Get-BEAgentServer server01 | Search-BECatalog *.txt

These commands search for all of the text files backed up for a server named "server01".

Example 2

C:\PS> Get-BEAgentServer server01 | Search-BECatalog C:\Windows\*.dll -Recurse

These commands search for all of the DLL files in the C:\Windows directory and all of its subdirectories backed up for a server named "server01".

Example 3

C:\PS> Get-BEAgentServer server01 | Search-BECatalog C:\Users -PathIsDirectory

These commands search for all backups of the C:\Users directory backed up for a server named "server01".