Skip to main content

Get-LXCAFFDCFile

This cmdlet downloads the first failure data capture (FFDC) file for Lenovo XClarity Administrator file to the local system.

Note

  • You cannot pipe objects to this cmdlet.

  • The returned FFDC file is a tar.gz archive.

Syntax​

Get-LXCAFFDCFile [-Connection LXCAConnection] 
                  -Destination String
                 [-Overwrite]
                 [CommonParameter]

Parameters​

-Connection LXCAConnection
Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.
-Destination String
Specifies the directory and file name where the file is to be saved on the local system.

  • If you do not specify a file name (in other words, if the destination ends in a back slash "\"), the default file name LXCA_<app-uuid>_<time>_<date>.tar.gz is used.

  • If the directory does not exist, it is automatically created.

-Overwrite
When specified, if the file already exists in the specified directory, the file is overwritten.

If not specified, and the file already exists in the specified directory, the file is not overwritten, and the System.IO.IOException: The <full_ffdc_file_path> file already exists exception is thrown.

CommonParameters
This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.

Results​

This cmdlet downloads the XClarity Administrator service-data file to the specified directory on the local system and returns a System.String object that contains the full path of the saved file

Examples​

  • The following example downloads the FFDC file, saves it on the local system, and prints the file's fully qualified path to the PS console. If a file with same name already exists, the file is overwritten.

    $cred = Get-Credential
    Connect-LXCA -Host 192.0.2.0 -Credential $cred -SkipCertificateCheck

    $(Get-LXCAFFDCFile -Destination C:\LXCA\ffdc.tar.gz -Overwrite)

    Disconnect-LXCA

  • The following example downloads the FFDC file, saves it on the local system, and prints the file's fully qualified path to the PS console. The file name used is the one that is returned by XClarity Administrator.

    $cred = Get-Credential
    Connect-LXCA -Host 192.0.2.0 -Credential $cred -SkipCertificateCheck

    $(Get-LXCAFFDCFile -Destination C:\LXCA\)

    Disconnect-LXCA

Get-LXCAServiceFile