Export-VBRLogs

Short Description

Collects system logs for export.

Applies to

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Collect logs for servers.

Export-VBRLogs -Server <CHost[]> -FolderPath <string> [-Compress] -LastDays <Int32>] [-Wait]  [<CommonParameters>]

  • Collect logs for jobs.

Export-VBRLogs -Job <IJob[]> -FolderPath <string> [-Compress] [-LastDays <Int32>] [-Wait]  [<CommonParameters>]

  • Collect logs for VMs.

Export-VBRLogs -Entity <IVmItem[]> -FolderPath <string> [-Compress] [-LastDays <Int32>] [-Wait]  [<CommonParameters>]

  • Collect logs for backups.

Export-VBRLogs -Backup <CBackup[]> -FolderPath <string> [-Compress] [-LastDays <Int32>] [-Wait]  [<CommonParameters>]

  • Collect logs for protected computers.

Export-VBRLogs -Computer <VBRDiscoveredComputer[]> -FolderPath <String> [-Compress] [-LastDays <Int32>] [-Wait]  [<CommonParameters>]

  • Collect logs for cloud tenants.

Export-VBRLogs -Tenant <VBRCloudTenant[]> -FolderPath <String> [-Compress] [-Wait] [-LastDays <Int32>]  [<CommonParameters>]

Detailed Description

This cmdlet collects system logs. The log files are written to the folder you specify in this cmdlet.

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

You can get logs for all kind of virtual host, any jobs including SureBackup jobs, entities including VMware or Hyper-V VMs, or any backup. Use an appropriate parameter set for each case.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Server

Specifies an array of servers. The cmdlet will collect logs from these servers.

Note: The selected servers must be running and available over the network.

Accepts the CHost[] object. To create this object, run the Get-VBRServer cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Job

Specifies an array of jobs. The cmdlet will collect logs of these jobs.

Accepts all kinds of jobs.

Accepts the IJob[] object. To get this object, run one of the following cmdlets:

True

Named

True (ByValue,
ByProperty
Name)

Entity

Specifies an array of VMs. The cmdlet will collect logs of these VMs.

Accepts the IVmItem[] object. To get this object, run one of the following cmdlets:

True

Named

True (ByValue,
ByProperty
Name)

Backup

Specifies an array of backups. The cmdlet will collect logs of these backups.

Accepts the CBackup[] object. To get this object, run the Get-VBRBackup cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Computer

Specifies an array of protected computers. The cmdlet will collect logs of these computers.

Accepts the VBRDiscoveredComputer[] object. To get this object, run the Get-VBRDiscoveredComputer cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Tenant

Specifies an array of cloud tenants. The cmdlet will collect logs of these cloud tenants.

Note: This parameter does not return logs of VMware Cloud Director and Active Directory tenant accounts.

Accepts the VBRCloudTenant[] object. To get this object, run the Get-VBRCloudTenant cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

FolderPath

Specifies the destination folder. The cmdlet will export  logs to this folder.

String

True

Named

False

Compress

Defines that the log files will be compressed.

Default: True.

Note: To disable this option, set the parameter value to $false. That is, parameter_name:$false.

SwitchParameter

False

Named

False

LastDays

Specifies the number of last days to collect the logs for.

Int32

False

Named

False

Wait

Defines that the command waits for the process to complete before accepting more input.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRLogs object that contains system logs.

Examples

Export-VBRLogsExample 1. Collecting Logs for Servers

Export-VBRLogsExample 2. Collecting Logs for Jobs

Export-VBRLogsExample 3. Collecting Logs for VM

Export-VBRLogsExample 4. Collecting Logs for Backups

Export-VBRLogsExample 5. Collecting Logs for Protected Computers

Related Commands

Page updated 7/25/2024

Page content applies to build 12.3.1.1139