Get-VBRTaskSession
Short Description
Returns tasks performed during job sessions.
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
|
Get-VBRTaskSession [-Session] <VBRSession> [-Name <String[]>] [<CommonParameters>] |
Detailed Description
This cmdlet returns tasks performed during the specified session. The tasks are VMs processed during one job session.
Run the Get-VBRSureBackupTaskSessionReturns tasks performed during the specified SureBackup session. cmdlet to get the tasks for SureBackup jobs session.
Parameters
Parameters
|
Parameter
|
Description
|
Type
|
Required
|
Position
|
Accept Pipeline Input
|
|
Name
|
Specifies the array of job object names (for example, VMs in job). The cmdlet will return tasks performed for these objects during the selected session.
|
String[]
|
False
|
Named
|
False
|
|
Session
|
Specifies the session tasks which you want to get.
Accepts the following objects:
-
CBackupSession
To get this object, run the Get-VBRBackupSessionReturns jobs sessions. cmdlet.
-
VBRSession
To get this object, run the Get-VBRSessionReturns job sessions. cmdlet.
-
VBRComputerBackupJobSession
To get this object, run the Get-VBRComputerBackupJobSessionReturns jobs sessions. cmdlet.
-
VBREPSession
To get this object, run the Get-VBREPSessionReturns sessions of backup jobs run by Veeam Agent operating in a standalone mode. cmdlet.
-
VBRPluginBackupSession
To get this object, run the Get-VBRPluginBackupSessionReturns sessions of application backup policies and backup jobs for standalone Veeam Plug-ins. cmdlet.
-
VBRTapeBackupSession
To get this object, run the Get-VBRTapeBackupSessionReturns tape backup job sessions. cmdlet.
|
VBRSession
|
True
|
0
|
True (ByPropertyName, ByValue)
|
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
VBRTaskSession
Examples
Example 1. Getting List of Tasks Performed for VMs [Using Pipeline]
|
This example shows how to get the list of tasks performed for the DC and DNS VMs in the backup job session with incremental backups named Exchange Backup.
|
Get-VBRBackupSession -Name "Exchange Backup (Incremental)" | Get-VBRTaskSession -Name "DC", "DNS" |
Perform the following steps:
- Run the
Get-VBRBackupSessionReturns jobs sessions. cmdlet. Specify the Name parameter value.
- Pipe the cmdlet output to the
Get-VBRTaskSession cmdlet. Specify the Name parameter value.
|
Example 2. Getting List of Tasks Performed for VMs [Using Variable]
|
This example shows how to get the list of tasks performed for the DC and DNS VMs in the backup job session with incremental backups named Exchange Backup.
|
$ExchangeSession = Get-VBRBackupSession -Name "Exchange Backup (Incremental)"
Get-VBRTaskSession -Session $ExchangeSession -Name "DC", "DNS" |
Perform the following steps:
- Run the
Get-VBRBackupSessionReturns jobs sessions. cmdlet. Specify the Name parameter value. Save the result to the $ExchangeSession variable.
- Run the
Get-VBRTaskSession cmdlet. Set the $ExchangeSession variable as the Session parameter value. Specify the Name parameter value.
|
Related Commands
Get-VBRBackupSessionReturns jobs sessions.
Example 1. Getting List of Tasks Performed for VMs [Using Pipeline]