Get-VBRPluginJob

In this article

    Short Description

    Returns plug-in jobs.

    Applies to

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Get-VBRPluginJob [-Name <string>] [-Id <guid>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns the VBRPluginBackupJob and  VBRPluginBackupCopyJob objects that contains settings of the following types of jobs:

    • A plug-in backup job that was created to back up Oracle RMAN, SAP HANA or SAP on Oracle.
    • A plug-in backup copy job.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Name

    Specifies a name of a job. The cmdlet will return the job with this name.

    String

    False

    Named

    False

    Id

    Specifies an ID of a job. The cmdlet will return the job with this ID.

    Guid

    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.

    Output Object

    The cmdlet returns the VBRPluginBackupJob and  VBRPluginBackupCopyJob objects that contain settings for plug-in backup jobs and plug-in backup copy jobs.

    Examples

    Get-VBRPluginJobExample 1. Getting All Plug-In Jobs

    This command returns all plug-in backup and plug-in backup copy jobs that are created in the Veeam Backup & Replication infrastructure.

    Get-VBRPluginJob

    Get-VBRPluginJobExample 2. Getting Plug-In Backup Copy Job by Name

    This command returns the plug-in backup 17 plug-in backup copy job.

    Get-VBRPluginJob -Name "Plug-in backup 17"

    Get-VBRPluginJobExample 3. Getting Plug-in Backup Copy Job by ID

    This command returns the 35d7b6cc-5726-4ec9-a954-f58109f3ff28 plug-in backup copy job.

    Get-VBRPluginJob -Id "35d7b6cc-5726-4ec9-a954-f58109f3ff28"

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.