Get-Log

Synopsis

Retrieves entries from vSphere logs.

Syntax

Get-Log [-Key] <String[]> [[-VMHost] <VMHost[]>] [[-StartLineNum] <Int32>] [[-NumLines] <Int32>] [-Server <VIServer[]>] [<CommonParameters>]
Get-Log [[-VMHost] <VMHost[]>] [-Bundle] [-DestinationPath] <String> [-Server <VIServer[]>] [-RunAsync] [<CommonParameters>]

Related Commands

Get-LogType

Detailed Description

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.

Parameters

Name	Description	Required?	Pipeline Input
Key	Specify 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.	true	true (ByValue)
VMHost	Specify 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 vSphere server.	false	true (ByValue)
StartLineNum	Specify the start line number for reading from the logs.	false	false
NumLines	Specify the number of the lines you want to retrieve from the logs.	false	false
Server	A vSphere servers to apply the command on. If no value is given to this parameter, the command runs on the server currently specified in the $DefaultVIServer variable.	false	false
Bundle	Indicate whether to retrieve a diagnostic bundle of logs from the vSphere server.	false	false
DestinationPath	Specify a local file path where you want to save the log bundle.	true	false
RunAsync	Indicate 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 vSphere PowerCLI console.	false	false

Input Type

Return Type

VMware.VimAutomation.Types.Log

Notes

Examples

--------------  Example 1 --------------

C:\PS>$keys = Get-LogType 

Get-Log -Key $keys[0]


Obtain the available keys. Obtains the first log file from the currently connect
ed vSphere server.