Skip to main content

Get-LXCOServiceData

This cmdlet downloads the XClarity Orchestrator service-data file tar.gz archive to the local system.

Note
You cannot pipe objects to this cmdlet.

Syntax​

Get-LXCOServiceData [-Connection LXCOConnection]
                     -Destination String
                    [-Overwrite]
                    [CommonParameter]

Parameters​

-Connection LXCAConnection
Specifies the connection to the Lenovo XClarity Orchestrator server. If no connection is specified, the result from the last Connect-LXCO 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, provided by the orchestrator server, LXCO_Service_Data_{date}_{time}.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_servicd_data_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​

Examples​

The following example downloads the service-data 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-LXCO -HostUri "192.0.2.0" -Credential $Cred -SkipCertificateCheck

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

Disconnect-LXCO
The following example downloads the service-data 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 Orchestrator.
$cred = Get-Credential
Connect-LXCO -HostUri "192.0.2.0" -Credential $Cred -SkipCertificateCheck

$(Get-LXCOServiceData -Destination C:\LXCOServiceData\)

Disconnect-LXCO