Skip to main content

Management-server cmdlets

The following PowerShell cmdlets are available for performing management-server update functions and retrieving licenses.

  • 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.
  • Copy-LXCABackup
    Use this cmdlet to copy a Lenovo XClarity Administrator backup from the local repository to a remote share, copy a backup from a remote share to the local repository, or to move a backup from the local repository to a remote share.
  • Get-LXCABackups
    Use this cmdlet to retrieve information about all Lenovo XClarity Administrator backups or export (download) an XClarity Administrator backup (.tar file) to the local system.
  • Get-LXCALicenseCompliance
    This cmdlet retrieves information about whether Lenovo XClarity Administrator is license compliant.
  • Get-LXCALicensableDeviceCount
    This cmdlet retrieves the number of managed devices that require licenses for advanced functions.
  • Get-LXCALicenseWarningPeriod
    This cmdlet retrieves the license warning period, which determines the number of days before a license expires when Lenovo XClarity Administrator triggers a warning.
  • Get-LXCAManagementServerPackage
    This cmdlet retrieves information about one or all management-server update packages that are in the Lenovo XClarity Administrator updates repository.
  • Get-LXCAQuantityLicense
    This cmdlet retrieves all installed licenses or export a specified list of the installed licenses to the local system.
  • Get-LXCASingleSignon
    Use this cmdlet to return the single sign-on setting for Lenovo XClarity Administrator management server or for a specific ThinkSystem or ThinkAgile server.
  • Install-LXCAQuantityLicense
    This cmdlet uploads and installs one or more license activation keys in the Lenovo XClarity Administrator server. You can import and install each license-activation key individually or multiple key bundled in a zip archive.
  • Install-LXCAUpdateManagementServer
    This cmdlet installs a management-server update.
  • Remove-LXCABackup
    Use this cmdlet to delete an Lenovo XClarity Administrator backup from a specific location.
  • Remove-LXCAQuantityLicense
    This cmdlet removes a specific license activation key from the Lenovo XClarity Administrator server.
  • 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.
  • Set-LXCALicenseWarningPeriod
    This cmdlet modifies the license warning period, which determines the number of days before a license expires when Lenovo XClarity Administrator triggers a warning.
  • Set-LXCASingleSignon
    Use this cmdlet to enable or disable single sign-on for Lenovo XClarity Administrator management server or for a specific ThinkSystem or ThinkAgile server.