LXCAPSTool

2.7.0.17

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

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

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deloy 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

Author(s)

Lenovo Corporation

Copyright

Copyright (c) Lenovo. All rights reserved.

Owners

Tags

LXCA LXCAPSTool XClarity

Cmdlets

Add-LXCAJobNote Add-LXCAResourceGroupMembers Remove-LXCAJobNotes Get-LXCADeviceMaintenance Get-LXCAJobNotes 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-LXCADeviceMaintenance 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 Add-LXCAPSLogHeader 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.7.0 (February 28, 2020)

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

New features and bug fixes:
  - Added the following cmdlets to retrieve, enable, and disable maintenance mode:
    * Get-LXCADeviceMaintenance
    * Set-LXCADeviceMaintenance
  - Added the following cmdlets to add, retrieve, and delete job notes/acknowledgments.
    * Add-LXCAJobNote
    * Get-LXCAJobNotes
    * Remove=LXCAJobNotes
  - Updated the Add-LXCARack cmdlet to disallow special characters in rack name.
  - Added the Add-LXCAPSLogHeader cmdlet write a header in the log file when a script starts
    or to mark some start/stop blocks in a script. This cmdlet is used for script debug purpose.
  - Updated the following cmdlets to create and modify stored credential for recovery purposes.
    Note that you cannot modify the UserName if a stored credential is in use.
    * Add-LXCAStoredCredential
    * Set-LXCAStoredCredential

Version History

Version Downloads Last updated
2.7.0.17 (current version) 78 4/9/2020
2.6.0.5 207 11/27/2019
2.5.0.7 131 9/5/2019
2.4.0.8 122 4/24/2019
1.1.0 567 4/6/2016
1.0.1 380 9/24/2015