Get-VBRComputerBackupJobSession
Short Description
Returns jobs sessions.
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides the following parameter sets:
-
Name (Default)Get-VBRComputerBackupJobSession [-Name <String[]>] [<CommonParameters>]
-
IdGet-VBRComputerBackupJobSession [-Id <Guid[]>] [<CommonParameters>]
Detailed Description
This cmdlet returns job sessions. You can get sessions of Veeam Agent jobs that are managed by Veeam Backup & Replication and Veeam Agent backup policies.
Parameters
|
Parameter |
Description |
Type |
Required |
Position |
Accept Pipeline Input |
|---|---|---|---|---|---|
|
Id |
Specifies an array of IDs for Veeam Agent job sessions. The cmdlet will return the sessions with these IDs. |
|
False |
Named |
True (ByPropertyName, ByValue) |
|
Name |
Specifies an array of names for Veeam Agent jobs. The cmdlet will return sessions with these names. |
|
False |
Named |
True (ByPropertyName, ByValue) |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
This cmdlet returns the VBRSession object that contains settings of sessions that are running by Veeam Agent backup jobs and Veeam Agent backup policies.
Examples
Example 1. Getting Agent Jobs Sessions by Name
|
This command returns the
|
Example 2. Get Agent Jobs Sessions by ID
|
This command returns the 1137c678-e79d-48c4-8d30-b921a612ba1e Agent job session.
|