Skip to main content

Remove-LXCABackup

Use this cmdlet to delete an Lenovo XClarity Administrator backup from a specific location.

Note
You cannot pipe objects to this cmdlet.

Syntax​

Remove-LXCABackup [-Connection LXCAConnection]
                    -Uuid String
                    -Location String
                   [CommonParameters]

Remove-LXCABackup [-Connection LXCAConnection]
                    -Uuid String
                    -SharedLocation String
                [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.
-Location String
Location from where to delete the backup. This can be one of the following values:.

  • All. Deletes the backup from all locations (XClarity Administrator local repository and remote shares).

  • Internal. Deletes the backup from only the XClarity Administrator local repository.

-SharedLocation String
Mounting point of the configured remote share from where to delete the backup.
-Uuid String
UUID of the backup to be deleted.
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 deletes an existing backup from the XClarity Administrator local repository.
$cred = Get-Credential
Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck

$result = Remove-LXCABackup -Uuid c4e24aab-7f56-99f4-a81c676df128 -Location Internal

# Show all the request information, including result values and messages, if any
$result | Format-List

Disconnect-LXCA
The following example deletes an existing backup from a configured remote share.
$cred = Get-Credential
Connect-LXCA -Host "192.0.2.0" -Credential $Cred -SkipCertificateCheck

$result = Remove-LXCABackup -Uuid c4e24aab-a81c676df128 -SharedLocation '/mnt/sharedFolder'

# Show all the request information, including result values and messages, if any
$result | Format-List

Disconnect-LXCA