Skip to main content

Backup-LXCA

Use this cmdlet to create a backup a 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​

Backup-LXCA  [-Connection LXCAConnection] 
              -Label SecureString
              -Password SecureString
             [-RemoteShareDestination String]
             [-IncludeOS]
             [-IncludeFirmware]
             [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.
-Label SecureString
Name of the backup
-Password SecureString
Passphrase that is required for decrypting and restoring the backup.
Attention
If you forget the passphrase, it cannot be recovered.
-RemoteShareDestination String
Remote share location where the backup will be created.

If not specified, the backup is created in the XClarity Administrator internal repository.

-IncludeOS
If specified, the backup includes operating system images.
-IncludeFirmware
If specified, the backup includes firmware and OS device-driver updates.
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 creates a full backup, including OS images, firmware updates, and OS device driver updates.

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

$backupPwd = ConvertTo-SecureString "password" -AsPlainText -Force
$result = Backup-LXCA -Label backupLabel -Password $backupPwd -IncludeFirmware -IncludeOS

# Show all the information about the request, including result value, message (if any), and brief 
# description of each backup (if any)
$result

Disconnect-LXCA