Get-OBRecoverableItem

  • Article

Get-OBRecoverableItem

Gets the array of OBRecoverableItem objects associated with the server.

Syntax

Parameter Set: RecoveryBrowse
Get-OBRecoverableItem [-ParentItem] <CBRecoverableItem> [[-PagingContext] <CBPagingContext> ] [ <CommonParameters>]

Parameter Set: RecoverySearch
Get-OBRecoverableItem [[-SearchString] <String> ] [-Location] <String> [-RecoveryPoint] <CBRecoverableItem> [[-PagingContext] <CBPagingContext> ] [ <CommonParameters>]

Parameter Set: RecoverySource
Get-OBRecoverableItem [-Source] <CBRecoverableSource> [ <CommonParameters>]

Detailed Description

The Get-OBRecoverableItem cmdlet gets the list of OBRecoverableItem[] objects associated with the specified online backup server (OBServer object). The OBRecoverableItem[] objects define what items will be recovered from the list of backup items.

Parameters

-Location<String>

Specifies the path of the root folder to start searching the OBRecoverableItem[] object.

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PagingContext<CBPagingContext>

Specifies the OBPagingContext object which contains pagination options to retrieve the OBRecoverableItem[] object as part of search, browse, or search and browse.

Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-ParentItem<CBRecoverableItem>

Specifies the parent OBRecoverableItem[] object from which to obtain the list of one or more child OBRecoverableItem[] objects as part of Recovery.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-RecoveryPoint<CBRecoverableItem>

Specifies the RecoveryPoint to get the OBRecoverableItem[] object.

Aliases

none

Required?

true

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-SearchString<String>

Specifies the file name or pattern to be matched, while searching through the OBRecoverableItem[] objects.

Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Source<CBRecoverableSource>

Lists all root level OBRecoverableItem[] objects of the specified OBRecoverableSource object.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Internal.CloudBackup.Commands.OBRecoverableItem[]

Examples

EXAMPLE 1

This example returns a recoverable item from source.

PS C:\> Get-OBRecoverableSource | Where-Object –FilterScript {$_.FriendlyName -like "C*"} | Get-OBRecoverableItemPS C:\> For($i = 0; $i -Lt $sources.Length; $i++) { Get-OBRecoverableItem –Source $sources[$i] }

EXAMPLE 2

This example returns a recoverable item based on a search criteria.

PS C:\> $parents = Get-OBRecoverableSource | Where-Object –FilterScript {$_.FriendlyName -like "C*"} | Get-OBRecoverableItemPS C:\> Get-OBRecoverableItem -SearchString stringToSearch* -Location R:\ -RecoveryPoint $parents[0]

EXAMPLE 3

This example returns a recoverable item based on browse.

PS C:\> $pc = New-OBPagingContextPS C:\>$parents = Get-OBRecoverableSource | Where-Object –FilterScript {$_.FriendlyName -like "C*"} | Get-OBRecoverableItemPS C:\> New-OBPagingContext | Get-OBRecoverableItem -ParentItem $parents[0] -Type FileOnly

Get-OBRecoverableSource

New-OBPagingContext

Where-Object