lxca
Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.7.0 < 6.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'lenovo-lxca', '1.0.0'
Learn more about managing modules with a PuppetfileDocumentation
lxca
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with lxca
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
lxca module is used to interact with Lenovo XClarity™ Administrator resources through implemented puppet types.
Module Description
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. Using the lxca module, you can interact with the LXCA resources such lxca_cabinet, lxca_canister, lxca_chassis, lxca_cmm, lxca_config_pattern, lxca_config_profile, lxca_config_target, lxca_discover_request, lxca_discovery, lxca_event, lxca_fan, lxca_fan_muxes, lxca_ffdc, lxca_job, lxca_manage_request, lxca_node, lxca_power_supplies, lxca_resource, lxca_scalable_complex, lxca_switches, lxca_unmanage_request, lxca_update_comp, lxca_users
In lxca_node supported functionality are:
- Listing of all nodes
- Listing of managed nodes
- Listing of unmanaged nodes
- Listing and filtering of nodes using a chassis
- Listing and filtering of nodes using a uuid
- Power on node
- Power off node
- Power restart node
- Blink LOC LED
- Turn on LOC LED
- Turn off LOC LED
- Listing of all chassis
- Listing of managed chassis
- Listing of unmanaged chassis
- Listing and filtering of chassis using a uuid
Setup
Once the lxca module becomes a part of the Puppet Forge, it can be installed using the command: puppet module install lenovo-lxca
Till then, download the entire contents of this repository to the directory /etc/puppetlabs/code/modules/lxca on the Puppet server
Beginning with Lxca Module in puppet
Before you can use the lxca module, you must create a proxy system able to run puppet device. Your Puppet agent will serve as the proxy for the puppet device subcommand. This module can used as host also.
Usage
Installation Requirements
The following infrastructure is required for the use of Lxca module:
- A server running as a Puppet Master
- A Puppet Agent running as a Puppet Device proxy to the lxca
- A Lxca device running having static ip and hostname/FQDN
Installation and Configuration Steps
- Install Puppet Lxca Module on Puppet Master
- Install Lxca and xClarity Client gems on Puppet Agent, running as proxy to the Lxca device
- Create a device.conf file on the Puppet Agent node with details of the Lxca device
- Run Puppet Device command on the Puppet Agent to initiate registration with the Puppet Master
- Creating, Updating and Applying Manifests (Resources) to create a catalog on Puppet Master
- Classify the Lxca device to the applied Manifests (Resources) from PE console
- Run Configuration Task to the Lxca device per Catalog from Puppet Master
- Puppet module as host.
See below for the detailed steps.
Step One: Install Puppet Lxca Module on Puppet Master
To install the module run,
puppet module install lenovo-lxca
Step Two: Install Lxca and Rest-Client gems on Puppet Agent
To install the gem files on Puppet Agent
/opt/puppetlabs/puppet/bin/gem install xclarity_client
To handle xclarity_client gem dependencies on Puppet Agent, 'Package' resource is used for reference gems on init.pp manifest file on Puppet Master under Lxca Module path. Sample manifest looks like;
class lxca::install {
if $::puppetversion and $::puppetversion =~ /Puppet Enterprise/ {
$provider = 'pe_gem'
} elsif $::puppetversion and versioncmp($::puppetversion, '4.0.0') >= 0 {
$provider = 'puppet_gem'
} else {
$provider = 'gem'
}
package { 'xclarity_client' :
ensure => '0.6.1',
provider => 'gem',
}
}
Step Three: Create a device.conf file on the Puppet Agent
Create a device.conf file in the /etc/puppetlabs/puppet/ directory on Puppet Agent with details of the Lxca
[<FQDN of Lxca>]
type lxca
url https://<USERNAME>:<PASSWORD>@<IP ADDRESS OF Lxca >/
In the above example, and refer to Puppet's login for the device FQDN refers to Fully Qualified Domain Name of the lxca
NOTE: Make sure the Lxca is reachable by its FQDN from the Master and Agent instance
Step Four: Run Puppet Device command on the Puppet Agent
Run the following command on Puppet Agent to have the device proxy node generate a certificate for the device (switch)
puppet device -v
Verify the device (lxca) FQDN with SSL certificate information is listed on the output of following command on Puppet Master
puppet cert list --all
Sign the device SSL certificate on Puppet Master
puppet cert sign <device FQDN>
puppet cert list --all
Step Five: Updating and Applying Manifests (Resources)
Manifests are available at /etc/puppetlabs/code/environment/production/modules/lxca/manifests/ To list existing managed lxca nodes modify manifest (for eg: For lxca_node )
Sample Manifest
class lxca::node {
lxca_node { 'list_managed':
ensure => 'discover_managed',
}
}
Step Six: Classify the Lxca device
Open Puppet Enterprise (PE) Console using https:/// and enter credentials created during Puppet Enterprise Installation Click on Classification under Configure section and select the Manifests (Resource - lxca::) and Node (switch/device)
Step Seven: Run Confiyyguration Tasks to the Lxca device from Puppet Agent
Run the following commands on Puppet Agent
puppet agent --test
puppet device -v --user=root
Step Eight: Run module as host
set fact url export FACTER_url="https://USERID:PASSWORD@10.243.9.238"
Reference
What lxca affects
In the current implementation, LXCA can interact with the following LXCA resources:
- Node
- Chassis
Setup Requirements OPTIONAL
The lxca module needs xclarity_client gem to be installed.
Classes
Public classes
lxca::chassis
Handles Chassis on Lenovo lxca for interfaces. For details regarding parameters, please refer to lxca_chassis.
Sample Manifest
class lxca::chassis {
lxca_chassis{'list_all':
ensure => 'discover_all',
}
}
Usage
Types and Providers
There are types and the respective providers have been implemented - lxca_node, lxca_chassis, ...
lxca_nodes accepts the following ensurable methods: discover_all, discover_managed, discover_unmanaged, filter_by_chassis, filter_by_uuid, power_on, power_off, power_restart, blink_led, turn_on_led, turn_off_led
lxca_chassis accepts the following ensurable methods: discover_all, discover_managed, discover_unmanaged, filter_by_uuid
A sample manifest is provided below that demonstrates the usage of lxca_node and lxca_chassis:
lxca_node{'list_all':
ensure => 'discover_all',
}
lxca_node{'blink_led':
ensure => 'turn_on_led',
uuid => 'FA59C0BBC43C3C15B9D72B94AFF52B91',
}
Classes
Public classes
lxca::chassis
Sample Manifest
class lxca::chassis {
lxca_chassis{'filter_by_uuid':
ensure => 'filter_by_uuid',
uuid => 'F44E92339683385A8D97CD6348A6F45F',
}
}
License and Authors
Copyright (C) 2018 Lenovo, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Development
Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. Please follow our guidelines when contributing changes. For more information, see our 'module contribution guide.'
Support
Support for this module is provided by Lenovo. To file an issue, please visit this 'link'
Dependencies
- puppetlabs-stdlib (>= 1.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.