Summary of changes in the PowerShell toolkit
Lenovo XClarity Administrator supports enhancements to the PowerShell toolkit.
Version 4.0.0
The following cmdlets were added or modified.
- Connect-LXCA. Added the -ChangeExpiredPassword parameter to prompts for the current password, new password, and confirm password if the password is expired.
- Get-LXCAServer. Added the -Type parameter to specify the server type.
- Get-LXCASystemCompliance. Added the EdgeServer value for the -SystemType parameter.
- Get-LXCAUpdateCompliancePolicy. Added the EdgeServer value for the -SystemType parameter.
- Install-LXCAUpdatePackage. Added the EdgeServer value for the -SystemType parameter.
- Invoke-LXCASystemAction. Starts a job that runs in the background to perform the requested power operation. Added the -Schedule parameter to create a schedule for performing the power operation. Added the -DeviceUUID parameter to replace the following deprecated attributes: -CMMUuid, -ComputeNodeUuid, -CanisterUuid, -IOSwitchUuid, -RackServerUuid, -ThinkServerUuid, -RackSwitchUuid, -StorageUuid. Added the -ServerAction parameter to replace the following deprecated attributes: -ComputeNodeAction, -RackServerAction, -ThinkServerAction.
- Join-LXCAUpdateCompliancePolicy. Added the EdgeServer value for the -SystemType parameter.
- (New) New-LXCAScheduleObj. Creates a local schedule object that can be used with certain cmdlets to create a scheduled job on XClarity Administrator.
- (New) New-LXCAScheduleRule. Creates a rule for a recurring schedule object that is to be created using New-LXCAScheduleObj cmdlet.
- Set-LXCASystemIPInterface. Added the -ServerUuid parameter to specify the UUID of a server for which you want to set the IP interface. Deprecated -ServerUuid and -ComputeNodeUuid parameter; however, these aliases are supported for backward compatibility
- Set-LXCASystemProperty. Added the -ServerUuid parameter to specify the UUID of a server for which you want to modify system properties. Deprecated -ServerUuid, -ThinkServerUuid and -ComputeNodeUuid parameter; however, these aliases are supported for backward compatibility
The following data objects were added or modified.
LXCASchedule class. Contains information about a scheduled job.
ScheduleObject class. Contains information about the schedule to be used for creating a XClarity Administrator scheduled job.
ScheduleRule class. Contains information about the scheduling rule.
ScheduleTriggerAction class. Contains information about update compliance for a specific resource manager.
Version 3.6.0
PowerShell toolkit for PowerShell 7.x has a flaw that prevent the uploading of files larger than 2 GB. A fix was added to PowerShell toolkit for XClarity Administrator to allow uploading files that are larger then 2 GB.
The following cmdlets were added or modified.
- Add-LXCAManagedDevice. Added the NVIDIAMellanoxSwitch value to the -DeviceType attribute to manage NVDIA switches.
- (New) Get-LXCAServersGlobalSettings. Returns global-configuration settings for ThinkAgile and ThinkSystem servers.
- (New) Set-LXCAServersGlobalSettings. Modifies global-configuration settings for ThinkAgile and ThinkSystem servers.
The following data objects were added or modified.
- (New) DriveSecureEraseResult class. Contains information about the status of the drives secure erase request.
- (New) ServersGlobalSettings class. Contains global inventory-configuration settings for servers .
Version 3.5.0
Transport Layer Security (TLS) v1.3 is supported (see Installing the Lenovo XClarity Administrator PowerShell toolkit).
The following cmdlets were added or modified.
- Add-LXCAManagedDevice. Added the -DeviceAddress parameter to specify the IP address of the device (such as a Brocade switch) to manage. Added the -DeviceType parameter to specify the type of device to manage. Added the -DisableDeviceDiscovery parameter to manage the device without SLP discovery.
- (New) Get-LXCABulletins. Returns a list of bulletins from the last 30 days.
- (New) Set-LXCABulletinService. Enables or disables receiving Lenovo bulletins.
The following data objects were added or modified.
- (New) BulletinData class. Contains information about a Lenovo bulletin.
Version 3.4.0
The following cmdlets were added or modified.
- Install-LXCAUpdatePackage. Added the -applyBundle parameter to apply firmware updates to all components of specified ThinkSystem SR635 and SR655 devices according to the assigned firmware-compliance policy using a bundled image that contain all applicable firmware packages.
- (New) Get-LXCAIdentityManagementSystems. Returns information about all configured identity-management systems or a specific identity-management system configuration.
The following data objects were added.
- (New) IdentityManagementSystems class. Contains information about the identity-management systems configuration.
- (New) IdentityManagementSystemsPaths class. Contains a path of the identity-management system.
Version 3.3.0
The following cmdlets were added or modified.
- Add-LXCAManagedDevice. Supports discovering and managing a server using CyberArk authentication, using new properties -ServerAddress, -UserName, -ApplicationId, -Folder, and -Safe.
- (New) Copy-LXCABackup. Copies 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
- (New) Get-LXCASingleSignon. Returns the single sign-on setting for XClarity Administrator or for a specific server.
- (New) Restore-LXCABackup. Restores Lenovo XClarity Administrator system data, settings, and imported files such as operating-system images, firmware updates, and OS device drivers.
- (New) Set-LXCASingleSignon. Modifies the single sign-on setting for XClarity Administrator or for a specific server.
The following data objects were added.
- (New) LXCABackupRestoreRequest class. Contains the operational status when a backup is being restored or imported.
- (New) LXCABackupRestoreResult class. Contains information about the results of a XClarity Administrator restore or import process.
- (New) SingleSignOnStatus class. Contains information about the single sign-on status.
Version 3.2.0
The following cmdlets were added or modified.
- (New) Backup-LXCA. Creates a backup of XClarity Administrator system data, settings, and imported files such as operating-system images, firmware updates, and OS device drivers.
- (New) Get-LXCABackups. Retrieves information about all Lenovo XClarity Administrator backups or export (download) an XClarity Administrator backup (.tar file) to the local system.
- (New) Remove-LXCABackup. Deletes an Lenovo XClarity Administrator from a specific location
The following data objects were added.
- (New) LXCABackupResult class. Contains information about the XClarity Administrator backup process.
- (New) BackupInfo class. Contains information about a specific Lenovo XClarity Administrator backup.
- (New) LXCABackupsInfo class. Contains information about all Lenovo XClarity Administrator backups.
- (New) LXCAFileDownloadResult class. Contains the full path to the file that was downloaded from Lenovo XClarity Administrator to the local system.
Version 3.1.1
There are no changes to the PowerShell toolkit in this release.
Version 3.1.0
XClarity Administrator v3.1 requires PowerShell 4, 5.1 or PowerShell Core 7.0.3 or later.
The following cmdlets were added or modified.
- Get-LXCATask. The -LegacyMode parameter is deprecated and will be removed in a future release.
- (New) Update-LXCAFirmwareRepository. Refreshes the firmware catalog by retrieving information (metadata) about firmware updates and UpdateXpress System Packs (UXSPs) from the Lenovo Support website, or downloads specific firmware updates or UXSPs from Lenovo XClarity Support website and stores the files in the updates repository.
The following data objects were added.
- (New) FirmwarePackageData class. Contains information about a firmware package.
- (New) FirmwareRepositoryData class. Contains information about the firmware-updates repository.
Version 3.0.0
The following cmdlets were added.
(New) Get-LXCALicenseCompliance. Retrieves information about whether XClarity Administrator is license compliant..
(New) Get-LXCALicensableDeviceCount. Retrieves the number of managed devices that require licenses for advanced functions.
- (New) Get-LXCALicenseWarningPeriod. Retrieves the license warning period, which determines the number of days before a license expires when XClarity Administrator triggers a warning
- (New) Get-LXCAQuantityLicense. Retrieves all installed licenses or export a specified list of the installed licenses to the local system.
- (New) Install-LXCAQuantityLicense. Installs a specific license activation key from the Lenovo XClarity Administrator server.
- (New) Remove-LXCAQuantityLicense. Removes a specific license activation key from the Lenovo XClarity Administrator server.
- (New) Set-LXCALicenseWarningPeriod. Sets the license warning period.
The following data objects were added.
- (New) LicenseComplianceData class. Contains information about whether XClarity Administrator is license compliant.
- (New) LicenseComplianceStatus enum. Contains the license-compliance status.
- (New) LicenseWarningPeriod class. Contains information about the license warning period.
- (New) QuantityLicense class. Contains information about all installed licenses on a XClarity Administrator server.
- (New) QuantityLicenseData class. Contains information about a license.
- (New) QuantityLicenseStatus enum. Contains the license status.
- (New) RequestResult class. Contains information about the result of the request.
- (New) RequestResultStatus enum. Contains the result of the request.
Give documentation feedback