Skip to main content

Restore-LXCABackup

Use this cmdlet to restore Lenovo XClarity Administrator system data, settings, and imported files such as operating-system images, firmware updates, and OS device drivers.

Note
You cannot pipe objects to this cmdlet.

Syntax​

Restore-LXCABackup [-Connection LXCAConnection]
                    -Uuid String
                    -Password SecureString
                   [-RestoreFirmware]
                   [-RestoreManagedDevice]
                   [-RestoreNetworkSettings]
                   [-RestoreOS]
                   [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.
-Uuid String
Specifies the UUID of the backup to be restored.
-Password String
Specifies the passphrase that is required for decrypting and restoring the backup.
-RestoreFirmware String
When specified, firmware and OS device-driver updates are restored.

When not specified, firmware and OS device-driver updates are not restored.

-RestoreManagedDevices String
When specified, device inventory is restored.

When not specified, device inventory is not restored.

-RestoreNetworkSettings String
When specified, network settings are restored.

When not specified, network settings are not restored.

-RestoreOS String
When specified, operating-system images are restored.

When not specified, operating-system images are not restored.

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 restores a backup.

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

$backupPwd = ConvertTo-SecureString "password" -AsPlainText -Force

$result = Restore-LXCABackup -Password $backupPwd -Uuid f56382e0-e39e-4cac-8124-9b96cdc52dbf -RestoreFirmware `
                 -RestoreManagedDevices -RestoreNetworkSettings -RestoreOS

# Show all the information about the request, including result value and message (if any)
$result | Format-List

# Show detailed backup restore information, if the restore process completed successfully
$result.RestoreInfo

Disconnect-LXCA