LXCAPSTool.psd1

# ------------------------------------------------------------------
# Lenovo Copyright
#
# (C) Copyright Lenovo 2020 - present.
#
# LIMITED AND RESTRICTED RIGHTS NOTICE:
# If data or software is delivered pursuant a General Services
# Administration (GSA) contract, use, reproduction, or disclosure
# is subject to restrictions set forth in Contract No. GS-35F-05925.
# ------------------------------------------------------------------

#
# Module manifest for module 'LXCAPSTool'
#
# Generated by: "Lenovo"
#

@{

# Script module or binary module file associated with this manifest
RootModule = 'LXCAPSTool.psm1'

# Version number of this module.
ModuleVersion = '3.0.0.17'

# ID used to uniquely identify this module
GUID = 'a0b0eede-6d1c-409c-b8a4-122b862fe857'

# Author of this module
Author = 'Lenovo Corporation'

# Company or vendor of this module
CompanyName = 'Lenovo Corporation'

# Copyright statement for this module
Copyright = 'Copyright (c) Lenovo. All rights reserved.'

# Description of the functionality provided by this module
Description = '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
 
Lenovo XClarity Administrator REST APIs used in this module:
https://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca_restapis.doc/rest_apis.html
'


# Modules that must be imported into the global environment prior to importing this module
RequiredModules = @()

# Functions to export from this module
FunctionsToExport = '*'

# Cmdlets to export from this module
CmdletsToExport = @('Add-LXCAEventExclusionFilter','Add-LXCAJobNote','Add-LXCAManagedDevice','Add-LXCAPSLogHeader','Add-LXCARack','Add-LXCARackItem','Add-LXCAResourceGroupMembers','Add-LXCARoleGroup','Add-LXCAStoredCredential','Add-LXCAUserAccount','Backup-LXCAEventLog','Backup-LXCASwitchConfig','Connect-LXCA','Disconnect-LXCA','Get-LXCAActiveAlert','Get-LXCAActiveSession','Get-LXCAActiveStatus','Get-LXCAAuditLog','Get-LXCAAvailableMachineType','Get-LXCAChassis','Get-LXCAChassisInventory','Get-LXCAChassisMember','Get-LXCAComputeNode','Get-LXCAConfigPattern','Get-LXCAConfigPatternDeployableServer','Get-LXCAConfigProfile','Get-LXCAConnection','Get-LXCADeployableServer','Get-LXCADeployGlobalSetting','Get-LXCADeviceMaintenance','Get-LXCADevicesWarranty','Get-LXCAEncapsulation','Get-LXCAEvent','Get-LXCAEventExclusionFilter','Get-LXCAFFDCFile','Get-LXCAInformation','Get-LXCAIOModule','Get-LXCAJob','Get-LXCAJobNotes','Get-LXCALicensableDeviceCount','Get-LXCALicenseCompliance','Get-LXCALicenseWarningPeriod','Get-LXCAManagementServerPackage','Get-LXCAOSImage','Get-LXCAQuantityLicense','Get-LXCARack','Get-LXCARackServer','Get-LXCARackSwitch','Get-LXCAResourceGroups','Get-LXCARole','Get-LXCARoleGroup','Get-LXCAScalableComplexSystem','Get-LXCASchedule','Get-LXCAScheduleAction','Get-LXCAServer','Get-LXCAServiceFile','Get-LXCAServiceTickets','Get-LXCAStorage','Get-LXCAStorageNode','Get-LXCAStoredCredential','Get-LXCASwitchConfigData','Get-LXCASwitchConfigFile','Get-LXCASystemCompliance','Get-LXCATask','Get-LXCAThinkServer','Get-LXCAUpdateCompliancePolicy','Get-LXCAUpdatePackage','Get-LXCAUserAccount','Import-LXCAConfigPattern','Import-LXCAOSImage','Import-LXCASwitchConfig','Import-LXCAUpdatePackage','Install-LXCAConfigPattern','Install-LXCAConfigProfile','Install-LXCAOSImage','Install-LXCAQuantityLicense','Install-LXCAStoredCredential','Install-LXCATrustedCertificate','Install-LXCAUpdateManagementServer','Install-LXCAUpdatePackage','Invoke-LXCARestMethod','Invoke-LXCASystemAction','Join-LXCAUpdateCompliancePolicy','New-LXCADeployTask','New-LXCAScheduleObj','New-LXCAScheduleRule','Remove-LXCAConfigProfileFromSystem','Remove-LXCAEventExclusionFilter','Remove-LXCAJob','Remove-LXCAJobNotes','Remove-LXCAManagedDevice','Remove-LXCAOSImage','Remove-LXCAQuantityLicense','Remove-LXCARack','Remove-LXCARackItem','Remove-LXCARoleGroup','Remove-LXCASchedule','Remove-LXCAStoredCredential','Remove-LXCASwitchConfigFile','Remove-LXCATask','Remove-LXCAUserAccount','Restore-LXCASwitchConfig','Set-LXCADeployGlobalSetting','Set-LXCADeviceMaintenance','Set-LXCAEncapsulation','Set-LXCALicenseWarningPeriod','Set-LXCAPSLogLevel','Set-LXCARack','Set-LXCARackItem','Set-LXCAResourceAccessControl','Set-LXCAResourceView','Set-LXCARoleGroup','Set-LXCAStoredCredential','Set-LXCASwitchPort','Set-LXCASystemIPInterface','Set-LXCASystemProperty','Set-LXCAUserAccount','Set-LXCAUserAccountPassword','Start-LXCAEventMonitor','Stop-LXCAJob','Stop-LXCATask')

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module
AliasesToExport = '*'

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        Tags = @('LXCA', 'LXCAPSTool', 'XClarity')

        # A URL to the license for this module.
        LicenseUri = 'https://datacentersupport.lenovo.com/docs/UM920681'

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
    ReleaseNotes = 'Released v3.0.0 (August 2020)
 
This LXCAPSTool version supports the following Lenovo XClarity Administrator versions:
    - 2.7.0, 2.8.0, 3.0.0
 
New features and bug fixes:
   - Added the following cmdlets to automate Lenovo XClarity Administrator licenses:
     * Get-LXCALicenseCompliance
     * Get-LXCALicensableDeviceCount
     * Get-LXCALicenseWarningPeriod
     * Get-LXCAQuantityLicense
     * Install-LXCAQuantityLicense
     * Remove-LXCAQuantityLicense
     *Set-LXCALicenseWarningPeriod
'


    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
HelpInfoURI = 'https://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca_restapis.doc/pshell_overview.html'

}