LXCAPSTool

2.6.0.5

Lenovo XClarity Administrator PowerShell tool

The LXCAPSTool cmdlets use REST APIs that are provided for Lenovo XClarity Administrator to enable you to automate functions such as:
- Logging in to Lenovo XClarity Administrator;
- Collecting inventory data to support the management of chassis and servers (endpoints);
- Deploying an operating system image to one or
Lenovo XClarity Administrator PowerShell tool

The LXCAPSTool cmdlets use REST APIs that are provided for Lenovo XClarity Administrator to enable you to automate functions such as:
- Logging in to Lenovo XClarity Administrator;
- Collecting inventory data to support the management of chassis and servers (endpoints);
- Deploying an operating system image to one or more endpoints;
- Configuring endpoints through the use of Configuration Patterns;
- Applying firmware update to endpoint;
- Managing user accounts;
- Monitoring events;

Lenovo XClarity Administrator is a centralized, resource-management solution that is aimed at reducing complexity, speeding response, and enhancing the availability of Lenovo server systems and solutions. It runs as a virtual appliance that you can use to manage Flex System chassis and System x rack servers in a secure environment.
Get more detail information from:
https://sysmgt.lenovofiles.com/help/topic/com.lenovo.systems.management.common.nav.doc/ic-homepage.html?cp=0

Lenovo XClarity Administrator REST APIs used in this module:
https://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca_restapis.doc/rest_apis.html?cp=1_21_3
Show more

Minimum PowerShell version

3.0

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name LXCAPSTool -RequiredVersion 2.6.0.5

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name LXCAPSTool -Version 2.6.0.5

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

Copyright (c) Lenovo. All rights reserved.

Package Details

Author(s)

  • Lenovo Corporation

Tags

LXCA LXCAPSTool XClarity

Cmdlets

Add-LXCAResourceGroupMembers Get-LXCAResourceGroups Add-LXCARack Add-LXCARackItem Add-LXCARoleGroup Add-LXCAStoredCredential Backup-LXCASwitchConfig Get-LXCADevicesWarranty Get-LXCAManagementServerPackage Get-LXCARole Get-LXCARoleGroup Get-LXCASchedule Get-LXCAScheduleAction New-LXCAScheduleRule Get-LXCAServer Get-LXCAServiceTickets Get-LXCAStorage Get-LXCAEncapsulation Get-LXCAStoredCredential Get-LXCASwitchConfigData Get-LXCASwitchConfigFile Get-LXCATask Get-LXCAThinkServer Get-LXCARackSwitch Import-LXCASwitchConfig Install-LXCAStoredCredential Install-LXCATrustedCertificate Install-LXCAUpdateManagementServer Invoke-LXCARestMethod Get-LXCAScalableComplexSystem Import-LXCAConfigPattern Remove-LXCARoleGroup Remove-LXCASchedule Remove-LXCAStoredCredential Remove-LXCASwitchConfigFile Remove-LXCATask Restore-LXCASwitchConfig Set-LXCAEncapsulation Set-LXCARackItem Set-LXCARack Remove-LXCARackItem Remove-LXCARack Get-LXCARack New-LXCAScheduleObj Set-LXCAResourceAccessControl Set-LXCAResourceView Set-LXCARoleGroup Set-LXCAStoredCredential Set-LXCASwitchPort Set-LXCASystemIPInterface Get-LXCAServiceFile Get-LXCARackServer Add-LXCAManagedDevice Add-LXCAUserAccount Backup-LXCAEventLog Get-LXCAConnection Get-LXCAActiveSession Get-LXCAEventExclusionFilter Get-LXCAUpdatePackage Remove-LXCAEventExclusionFilter Set-LXCASystemProperty Add-LXCAEventExclusionFilter Install-LXCAConfigProfile Install-LXCAConfigPattern Get-LXCAAvailableMachineType Get-LXCAUpdateCompliancePolicy Import-LXCAUpdatePackage Install-LXCAUpdatePackage Join-LXCAUpdateCompliancePolicy Remove-LXCAManagedDevice Get-LXCAConfigPatternDeployableServer Remove-LXCAConfigProfileFromSystem Get-LXCAConfigPattern Get-LXCAConfigProfile Get-LXCAInformation Stop-LXCAJob Remove-LXCAJob Get-LXCAJob Get-LXCAActiveStatus Get-LXCAFFDCFile Get-LXCAAuditLog Get-LXCAActiveAlert Get-LXCASystemCompliance Get-LXCAUserAccount Install-LXCAOSImage Disconnect-LXCA Get-LXCAEvent Get-LXCADeployableServer Invoke-LXCASystemAction New-LXCADeployTask Remove-LXCAUserAccount Set-LXCAUserAccount Set-LXCAUserAccountPassword Start-LXCAEventMonitor Stop-LXCATask Get-LXCADeployGlobalSetting Get-LXCAStorageNode Get-LXCAChassis Get-LXCAChassisInventory Get-LXCAChassisMember Get-LXCAComputeNode Get-LXCAIOModule Get-LXCAOSImage Import-LXCAOSImage Remove-LXCAOSImage Set-LXCADeployGlobalSetting Connect-LXCA Set-LXCAPSLogLevel

Dependencies

This module has no dependencies.

Release Notes

Released v2.6.0 (November 04, 2019)

This LXCAPSTool version supports the following Lenovo XClarity Administrator versions:
   - 2.4.0, 2.5.0, 2.6.0

New features and bug fixes:
  - Changes in logging mechanism: use of a single name for log file and the file rolling mechanism;
    log is splitted in 20MB files, no more then 1000 files.
  - Get-LXCAFFDCFile: issues fixed:
    * create ffdc path on the target system if it does not exist.
    * use the ffdc file name from Lenovo XClarity Administrator  if the name is not specified by the user.
  - Three cmdlets were deprecated:
    * Get-LXCAJob: use instead Get-LXCATask.
    * Remove-LXCAJob: use instead Remove-LXCATask.
    * Stop-LXCAJob: use instead Stop-LXCATask.
  - Two data types were deprecated:
    * Data.Job: use instead Data.LxcaJob.
    * Data.TaskData: use instead Data.LxcaJob.

FileList

Version History

Version Downloads Last updated
4.0.0.11 1,212 9/5/2023
4.0.0.10 600 3/1/2023
3.6.0.11 893 6/15/2022
3.5.0.7 569 2/3/2022
3.4.0.6 1,260 9/14/2021
3.2.0.8 211 6/4/2021
3.2.0.7 130 3/30/2021
3.0.0.17 246 9/18/2020
2.8.0.4 78 8/26/2020
2.7.0.17 239 4/9/2020
2.6.0.5 (current version) 252 11/27/2019
2.5.0.7 174 9/5/2019
2.4.0.8 172 4/24/2019
1.1.0 609 4/6/2016
1.0.1 710 9/24/2015
Show less