Get-VBOJobSession
Short Description
Returns backup and backup copy job sessions.
Syntax
This cmdlet provides parameter sets that allow you to:
- Get job sessions for jobs of the specified type and status.
Get-VBOJobSession [-JobType <VBOJobSessionType>] [-Status <VBOJobStatus>] [-Last] [<CommonParameters>] |
- Get a job session for a specific job.
Get-VBOJobSession [-Job <IVBOJobWithId>] [-Status <VBOJobStatus>] [-Last] [<CommonParameters>] |
Detailed Description
This cmdlet returns job sessions stored in Veeam Backup for Microsoft 365.
Job session record contains the following information:
- Id — specifies the system ID of the job session.
- JobId — specifies the system ID of the job.
- JobName — specifies the job name.
- CreationTime — specifies date and time when the job session was created.
- EndTime — specifies date and time when the job session ended.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
JobType | Specifies a job type. The cmdlet will return job sessions for the jobs of the specified type:
| VBOJobSessionType | False | Named | False |
Status | Specifies a job status. The cmdlet will return job sessions for the jobs with the specified status:
| VBOJobStatus | False | Named | False |
Last | Defines that the cmdlet will return the latest job session. If the Job parameter is used, the cmdlet will return the latest job session for the specified job. If the Status parameter is used, the cmdlet will return the latest job session for the jobs with the specified status. Default: False | SwitchParameter | False | Named | False |
Job | Specifies a job. The cmdlet will return job sessions for this backup or backup copy job. | IVBOJobWithId Accepts the VBOJob or VBOCopyJob object. To get this object, run the Get-VBOJob or Get-VBOCopyJob cmdlet. | False | Named | True (ByValue) |
<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 Job Sessions
This command returns a list of all job sessions.
|
Example 2. Getting Job Sessions for Backup Jobs with Success Status
This command returns all job sessions for backup jobs with the Success status.
|
Example 3. Getting Latest Job Session
This command returns the latest job session stored in Veeam Backup for Microsoft 365.
|
Example 4. Getting Latest Job Session for Backup Jobs with Failed Status
This command returns the latest job session for backup jobs with the Failed status.
|
Example 5. Getting Statistics for Latest Job Session
This example shows how to get statistics for the latest job session.
Perform the following steps:
|
Related Commands