Get-VBODataRetrievalSession

Short Description

Returns data retrieval sessions.

Syntax

Get-VBODataRetrievalSession [-Retrieval <VBODataRetrieval>] [-Status {Stopped | Running | Success | Failed |  Warning | NotConfigured | Disconnected | Queued}] [-Last [<switchparameter>]]  [<CommonParameters>]

Detailed Description

This cmdlet returns data retrieval sessions.

Data retrieval session record contains the following information:

  • Id — specifies the system ID of the data retrieval session.
  • RetrievalId — specifies the system ID of the retrieval job.
  • Name — specifies the retrieval job name.
  • CreationTime — specifies date and time when the data retrieval session was created.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Retrieval

Specifies a retrieval job. The cmdlet will return the data retrieval session that includes this retrieval job.

Accepts the VBODataRetrieval object.

To get this object, run the Get-VBODataRetrieval cmdlet.

False

Named

True (ByValue)

False

Status

Specifies the retrieval job status. The cmdlet will return data retrieval sessions for the retrieval jobs with the specified status:

  • Stopped
  • Running
  • Success
  • Failed
  • Warning
  • NotConfigured
  • Disconnected
  • Queued

VBOJobStatus

False

Named

False

False

Last

Defines that the cmdlet will return the latest data retrieval session.

If the Retrieval parameter is used, the cmdlet will return the latest data retrieval session for the specified retrieval job.

If the Status parameter is used, the cmdlet will return the latest data retrieval session for the retrieval jobs with the specified status.

SwitchParameter

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Examples

Get-VBODataRetrievalSessionExample 1. Getting All Data Retrieval Sessions

This command returns the list of all data retrieval sessions:

Get-VBODataRetrievalSession

Get-VBODataRetrievalSessionExample 2. Getting Data Retrieval Sessions by Backup Repository and Archived Data Status

This example shows how to get all data retrieval sessions for retrieval jobs in which archived data is stored in the backup repository with the name Azure Archive repository and has the Retrieved status.

$repository = Get-VBORepository -Name "Azure Archive repository"

$retrievaljob = Get-VBODataRetrieval -Repository $repository -DataState Retrieved

Get-VBODataRetrievalSession -Retrieval $retrievaljob

Perform the following steps:

  1. Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
  2. Run the Get-VBODataRetrieval cmdlet. Set the $repository variable as the Repository parameter value. Specify the DataState parameter value. Save the result to the $retrievaljob variable.
  3. Run the Get-VBODataRetrievalSession cmdlet with the $retrievaljob variable.

Get-VBODataRetrievalSessionExample 3. Getting Latest Data Retrieval Session

This command returns the latest data retrieval session stored in Veeam Backup for Microsoft 365:

Get-VBODataRetrievalSession -Last

Get-VBODataRetrievalSessionExample 4. Getting Latest Data Retrieval Session by Retrieval Job Status

This command returns the latest data retrieval session for the retrieval jobs with the Failed status:

Get-VBODataRetrievalSession -Status Failed -Last

Related Commands