Get-VBODataRetrievalSession
Short Description
Returns data retrieval sessions.
Syntax
Get-VBODataRetrievalSession [-Retrieval <VBODataRetrieval>] [-Status <VBOJobStatus>] [-Last] [<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 |
|---|---|---|---|---|---|
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) |
Status | Specifies the retrieval job status. The cmdlet will return data retrieval sessions for the retrieval jobs with the specified status:
| VBOJobStatus | False | Named | 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. Default: False | SwitchParameter | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Examples
Example 1. Getting All Data Retrieval Sessions
Example 2. Getting Data Retrieval Sessions by Backup Repository and Data Status
Example 3. Getting Latest Data Retrieval Session
Example 4. Getting Latest Data Retrieval Session by Retrieval Job Status
Related Commands
