This is an archive version of the document. To get the most up-to-date information, see the current version.

Export-VBRLogs

In this article

    Short Description

    Collects system logs for export.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus

    Syntax

    Export-VBRLogs -Server <CHost[]> -FolderPath <String> [-Compress] [-From <DateTime>] [-To <DateTime>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    -OR-

    Export-VBRLogs -Job <IJob[]> -FolderPath <String> [-Compress] [-From <DateTime>] [-To <DateTime>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    -OR-

    Export-VBRLogs -Entity <IVmItem[]> -FolderPath <String> [-Compress] [-From <DateTime>] [-To <DateTime>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    -OR-

    Export-VBRLogs -Backup <CBackup[]> -FolderPath <String> [-Compress] [-From <DateTime>] [-To <DateTime>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Related Commands

    Get-VBRServer

    Get-VBRJob

    Get-VSBJob

    Find-VBRViEntity / Find-VBRHvEntity

    Get-VBRBackup

    Detailed Description

    This cmdlet collects system logs. You can use this cmdlet to collect logs you can send to the Veeam support.

    The log files are written to the folder you specify in this cmdlet.

    This cmdlet provides syntax for getting logs for hosts, jobs, entities or backups. You can get logs for all kind of virtual host, any jobs including SureBackup jobs, all entities including datastores, clusters, replicas, etc., or any backup.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Server

    Specifies the server(s) from which you want to collect logs.

    Note that selected servers must be running and reachable over the network.

    You can assign multiple servers to this object.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    From

    Specifies the start date to collect the logs for export. Enter the date in format set in your workstation Date and Time settings.

    False

    Named

    False

    False

    To

    Specifies the end date to collect the logs for export. Enter the date in format set in your workstation Date and Time settings.

    False

    Named

    False

    False

    Job

    Specifies the job(s) you want to collect logs for. You can get logs for all kind of jobs.

    You can assign multiple jobs to this object.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Entity

    Specifies the VM(s) you want to collect logs for.

    You can assign multiple VMs to this object.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Backup

    Specifies the backups you want to collect logs for.

    You can assign multiple backups to this object.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    FolderPath

    Specifies the destination folder to which the logs will be exported.

    True

    Named

    False

    False

    Compress

    If set, the log files will be archived.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Example 1

    This command starts collecting log files from the server represented by the $server variable. The destination path is C:\Logs. The period for collecting data is July, 21, 2013 - July, 25, 2013. The data compression is enabled. Run Get-VBRServer to get the source server.

    PS C:\PS> Export-VBRLogs -Server $server -FolderPath "C:\Logs" -Compress -From 7/21/2013 -To 7/25/2013

    Example 2

    This command starts collecting log files for the SureBackup job named "DC SureJob". The job is obtained with Get-VSBJob and piped down. The destination path is C:\Logs\SureBackup Logs. The period for collecting data is not set to collect all the data for the job. The data compression is enabled.

    PS C:\PS> Get-VSBJob -Name "DC SureJob" | Export-VBRLogs -FolderPath "C:\Logs\SureBackup Logs" -Compress

    Example 3

    This command starts collecting log files for the VM named "DC" for May, 2015. The VM is obtained with Find-VBRViEntity and piped down. The destination path is C:\Logs. The data compression is enabled.

    PS C:\PS> Find-VBRViEntity -Name "DC" | Export-VBRLogs -FolderPath "C:\Logs" -Compress -From 5/01/2015 -To 6/01/2015