Lenovo xClarity Python Client
=============================
What is PyLXCA?
---------------
PyLXCA is Python based interface for Lenovo xClarity Administration APIs.
PyLXCA command-line interface (CLI) provides a Python-based library of
commands to automate provisioning and resource management from an OpenStack
environment, such as Ansible or Puppet.
The Lenovo XClarity Administrator PYLXCA CLI provide an interface to
Lenovo XClarity Administrator REST APIs to automate functions such as:
* Logging in to Lenovo XClarity Administrator
* Managing and unmanaging chassis, servers, storage systems, and
top-of-rack switches (endpoints)
* Viewing inventory data for endpoints and components
* Deploying an operating-system image to one or more servers
* Configuring servers through the use of Configuration Patterns
* Applying firmware updates to endpoints
Whats New
------------------
* Argument Parsing library replaced from optparse to argparse.
* Support for subcmd under various commands.
* New commands supported under shell
osimages
managementserver
resourcegroups
* Better Error handling.
Installation
------------
To use the PYLXCA command-line interface (CLI), you must install the
CLI and start a command session.
Python (including the request and logging modules) is required to use
to the PYLXCA CLI. Ensure at the following requirements are met. For
more information about Python, see the [Link]www.python.org website.
* Python v3.10.x (Later versions have not been tested.)
* Python requests v2.7.0 or later
* Python logging v0.4.9.6 or later
Complete the following steps to install the PYLXCA CLI.
1. Download the toolkit by clicking Help ( )> Resources from the
Lenovo XClarity Administrator title bar, and then clicking Download
PYLXCA CLI from the dialog.
2. Unzip the package into a local directory.
3. Run the following command to install the module:
easy_install unzip_directory\pylxca-1.0-py2.7.egg
4. Start a Python shell session.
$lxca_shell
--------------------------------------------------
Welcome to PyLXCA Shell v1.0
Type "help" at any time for a list of commands.
Type "pyshell" at any time to get interactive python shell
--------------------------------------------------
PyLXCA >>
3. Start a Python LXCA Shell in Interactive mode.
$lxca_shell --api
Interactive Python Shell for Lenovo XClarity Administrator v2.4.0
Type "dir()" or "help(lxca command object)" for more information.
>>>
4. Validate that the module was installed correctly by running the following command:
In Python Shell Try to import pylxca module as follows
>>> import pylxca
If python able to import pylxca without any error then it is installed correctly.
API Reference
-------------
PyLXCA command reference is available at
http://ralfss30.labs.lenovo.com:8120/help/topic/com.lenovo.lxca.doc/pycli_overview.html
PyLXCA API Help can be seen from Interactive Python Shell as follows.
$lxca_shell --api
Interactive Python Shell for Lenovo XClarity Administrator v4.2.0
Type "dir()" or "help(lxca command object)" for more information.
>>>
>>> help(connect)
Example
------------
python lxca_shell
connect -l https://10.241.106.216 -u USERID --noverify
connect -l https://10.241.106.216 -u USERID
Example to call lxca_cmd python module from python script or Ansible module
import pylxca
con1 = connect("https://10.241.106.216","USERID","Passw0rd","True")
Several sample scripts are also available to help you to quickly begin using the PYLXCA command-line interface (CLI) to manage endpoints.
The sample scripts are location in the following directory:
lib/python2.7/site-packages/pylxca-<version>-py2.7.egg/pylxca\test
License
-------
Apache Software License (http://www.apache.org/licenses/LICENSE-2.0)
Raw data
{
"_id": null,
"home_page": "http://www.lenovo.com",
"name": "pylxca",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "PYLXCA",
"author": "Girish Kumar, Prashant Bhosle",
"author_email": "gkumar1@lenovo.com, pbhosle@lenovo.com",
"download_url": null,
"platform": null,
"description": "Lenovo xClarity Python Client \n=============================\nWhat is PyLXCA?\n---------------\nPyLXCA is Python based interface for Lenovo xClarity Administration APIs.\n\nPyLXCA command-line interface (CLI) provides a Python-based library of \ncommands to automate provisioning and resource management from an OpenStack \nenvironment, such as Ansible or Puppet.\n\nThe Lenovo XClarity Administrator PYLXCA CLI provide an interface to \nLenovo XClarity Administrator REST APIs to automate functions such as:\n*\tLogging in to Lenovo XClarity Administrator\n*\tManaging and unmanaging chassis, servers, storage systems, and \ntop-of-rack switches (endpoints)\n*\tViewing inventory data for endpoints and components\n*\tDeploying an operating-system image to one or more servers\n*\tConfiguring servers through the use of Configuration Patterns\n*\tApplying firmware updates to endpoints\n\nWhats New \n------------------\n* \tArgument Parsing library replaced from optparse to argparse.\n*\tSupport for subcmd under various commands.\n*\tNew commands supported under shell\n\t\tosimages\n\t\tmanagementserver\n\t\tresourcegroups\n* \tBetter Error handling.\n\nInstallation\n------------\nTo use the PYLXCA command-line interface (CLI), you must install the \nCLI and start a command session.\n\nPython (including the request and logging modules) is required to use\nto the PYLXCA CLI. Ensure at the following requirements are met. For \nmore information about Python, see the [Link]www.python.org website. \n\n*\tPython v3.10.x (Later versions have not been tested.)\n*\tPython requests v2.7.0 or later\n*\tPython logging v0.4.9.6 or later\n\nComplete the following steps to install the PYLXCA CLI.\n\n1.\tDownload the toolkit by clicking Help ( )> Resources from the \nLenovo XClarity Administrator title bar, and then clicking Download \nPYLXCA CLI from the dialog.\n2.\tUnzip the package into a local directory.\n3.\tRun the following command to install the module:\neasy_install unzip_directory\\pylxca-1.0-py2.7.egg\n4.\tStart a Python shell session.\n\n$lxca_shell\n--------------------------------------------------\nWelcome to PyLXCA Shell v1.0\nType \"help\" at any time for a list of commands.\nType \"pyshell\" at any time to get interactive python shell\n--------------------------------------------------\nPyLXCA >>\n\n3. \tStart a Python LXCA Shell in Interactive mode.\n\n\t\n\t$lxca_shell --api\n\tInteractive Python Shell for Lenovo XClarity Administrator v2.4.0\n\tType \"dir()\" or \"help(lxca command object)\" for more information.\n\t>>>\n\n4.\tValidate that the module was installed correctly by running the following command:\n\nIn Python Shell Try to import pylxca module as follows\n\n>>> import pylxca\n\nIf python able to import pylxca without any error then it is installed correctly.\n\n\t\nAPI Reference\n-------------\n\nPyLXCA command reference is available at \n\thttp://ralfss30.labs.lenovo.com:8120/help/topic/com.lenovo.lxca.doc/pycli_overview.html\n\nPyLXCA API Help can be seen from Interactive Python Shell as follows.\n\t\n\t$lxca_shell --api\n\tInteractive Python Shell for Lenovo XClarity Administrator v4.2.0\n\tType \"dir()\" or \"help(lxca command object)\" for more information.\n\t>>>\n\t>>> help(connect)\n\nExample\n------------\n\n\tpython lxca_shell\n\tconnect -l https://10.241.106.216 -u USERID --noverify\n\tconnect -l https://10.241.106.216 -u USERID\n\nExample to call lxca_cmd python module from python script or Ansible module\n\n\timport pylxca\n\tcon1 = connect(\"https://10.241.106.216\",\"USERID\",\"Passw0rd\",\"True\")\n\nSeveral sample scripts are also available to help you to quickly begin using the PYLXCA command-line interface (CLI) to manage endpoints. \nThe sample scripts are location in the following directory:\nlib/python2.7/site-packages/pylxca-<version>-py2.7.egg/pylxca\\test\n\nLicense\n-------\nApache Software License (http://www.apache.org/licenses/LICENSE-2.0)\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "It is tool/api to connect LXCA from command line",
"version": "4.2.0",
"project_urls": {
"Homepage": "http://www.lenovo.com"
},
"split_keywords": [
"pylxca"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5635cd6abb2a4b1f58a41bde54af9291f99e8696c34d0da1dd6012daa1395d6c",
"md5": "81534402af4cc9de10c4898d149446dd",
"sha256": "386c90e6ff481e900859bad794c9e634292644a6fb46639c89f354e7ccfbca4d"
},
"downloads": -1,
"filename": "pylxca-4.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81534402af4cc9de10c4898d149446dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 73285,
"upload_time": "2024-12-09T13:47:27",
"upload_time_iso_8601": "2024-12-09T13:47:27.188300Z",
"url": "https://files.pythonhosted.org/packages/56/35/cd6abb2a4b1f58a41bde54af9291f99e8696c34d0da1dd6012daa1395d6c/pylxca-4.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-09 13:47:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pylxca"
}
JSON