Get-Log

This cmdlet retrieves entries from vSphere logs. Returns portions of the log files according to the criteria provided by the cmdlet parameters. To specify a server different from the default one, use the Server parameter.

Syntax

[-DestinationPath]  <String>
[-Bundle]
[-RunAsync]
[-Server  <VIServer[]>]
[-VMHost  <VMHost[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
DestinationPath
String 1 Specifies a local file path where you want to save the log bundle.
optional
Bundle
SwitchParameter named Indicates whether to retrieve a diagnostic bundle of logs from vCenter Server.
optional
RunAsync
SwitchParameter named Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.
optional
Server
VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
    optional
    VMHost
    VMHost[] named
  • wildcards
  • pipeline
  • Specifies the hosts for which you want to retrieve logs. If no value is given to this parameter, the command returns logs only for the default vCenter Server system.

    -Key  <String[]>
    [[-VMHost]  <VMHost[]>]
    [[-StartLineNum]  <Int32>]
    [[-NumLines]  <Int32>]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Key
    String[] named
  • wildcards
  • pipeline
  • Specifies the key identifier of the log file you want to retrieve. Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release.
    optional
    VMHost
    VMHost[] 1
  • wildcards
  • pipeline
  • Specifies the hosts for which you want to retrieve logs. If no value is given to this parameter, the command returns logs only for the default vCenter Server system.
    optional
    StartLineNum
    Int32 2 Specifies the start line number for reading from the logs.
    optional
    NumLines
    Int32 3 Specifies the number of the lines you want to retrieve from the logs.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Log

    Examples


    Example 1

    $keys = Get-LogType
    Get-Log -Key $keys[0]

    Obtain the available keys. Obtains the first log file from the currently connected vCenter Server system.

    Example 2

    $vmhost = Get-VMHost Host
    $keyList = Get-LogType -VMHost $vmhost
    $vmhost | Get-Log -Key $keyList[0] -StartLineNum 1 -NumLines 100

    Retrieve the first one hundred log lines for the specified host and key.

    Example 3

    Get-VMHost Host | Get-Log -Bundle -DestinationPath "D:\VMHostBundeLog"

    Retrieve a bundle log for the specified host.

    Related Commands

    Feedback

    Was this page helpful?