# zhmcclient - A pure Python client library for the IBM Z HMC Web Services API
[](https://pypi.python.org/pypi/zhmcclient/)
[](https://github.com/zhmcclient/python-zhmcclient/actions/workflows/test.yml?query=branch%3Amaster)
[](https://readthedocs.org/projects/python-zhmcclient/builds/)
[](https://coveralls.io/github/zhmcclient/python-zhmcclient?branch=master)
[](https://codeclimate.com/github/zhmcclient/python-zhmcclient)
# Overview
The zhmcclient package is a client library written in pure Python that
interacts with the Web Services API of the Hardware Management Console
(HMC) of [IBM Z](http://www.ibm.com/systems/z/) or
[LinuxONE](http://www.ibm.com/systems/linuxone/) machines. The goal of
this package is to make the HMC Web Services API easily consumable for
Python programmers.
The HMC Web Services API is the access point for any external tools to
manage the IBM Z or LinuxONE platform. It supports management of the
lifecycle and configuration of various platform resources, such as
partitions, CPU, memory, virtual switches, I/O adapters, and more.
The zhmcclient package encapsulates both protocols supported by the HMC
Web Services API:
- REST over HTTPS for request/response-style operations driven by the
client. Most of these operations complete synchronously, but some
long-running tasks complete asynchronously.
- JMS (Java Messaging Services) for notifications from the HMC to the
client. This can be used to be notified about changes in the system,
or about completion of asynchronous tasks started using REST.
# Installation
The quick way:
``` bash
$ pip install zhmcclient
```
For more details, see the
[Installation section](http://python-zhmcclient.readthedocs.io/en/master/intro.html#installation)
in the documentation.
# Quickstart
The following example code lists the partitions on CPCs in DPM mode that
are accessible for the user:
``` python
#!/usr/bin/env python
import zhmcclient
import requests.packages.urllib3
requests.packages.urllib3.disable_warnings()
# Set these variables for your environment:
host = "<IP address or hostname of the HMC>"
userid = "<userid on that HMC>"
password = "<password of that HMC userid>"
verify_cert = False
session = zhmcclient.Session(host, userid, password, verify_cert=verify_cert)
client = zhmcclient.Client(session)
console = client.consoles.console
partitions = console.list_permitted_partitions()
for part in partitions:
cpc = part.manager.parent
print("{} {}".format(cpc.name, part.name))
```
Possible output when running the script:
``` text
P000S67B PART1
P000S67B PART2
P0000M96 PART1
```
# Documentation and Change Log
For the latest released version on PyPI:
- [Documentation](http://python-zhmcclient.readthedocs.io)
- [Change
log](http://python-zhmcclient.readthedocs.io/en/master/changes.html)
# zhmc CLI
Before version 0.18.0 of the zhmcclient package, it contained the zhmc
CLI. Starting with zhmcclient version 0.18.0, the zhmc CLI has been
moved from this project into the new
[zhmccli project](https://github.com/zhmcclient/zhmccli).
If your project uses the zhmc CLI, and you are upgrading the zhmcclient
package from before 0.18.0 to 0.18.0 or later, your project will need to
add the [zhmccli package](https://pypi.python.org/pypi/zhmccli) to its
dependencies.
# Contributing
For information on how to contribute to this project, see the
[Development section](http://python-zhmcclient.readthedocs.io/en/master/development.html)
in the documentation.
# License
The zhmcclient package is licensed under the
[Apache 2.0 License](https://github.com/zhmcclient/python-zhmcclient/tree/master/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "zhmcclient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Andreas Maier <maiera@de.ibm.com>, Kathir Velusamy <kathir.velu@in.ibm.com'>",
"keywords": "hmc, client",
"author": null,
"author_email": "Juergen Leopold <leopoldj@de.ibm.com>, Andreas Maier <maiera@de.ibm.com>",
"download_url": "https://files.pythonhosted.org/packages/bb/0e/f5770422d346629d07f745aa94eea0900bbe01444e9125084d43133b00ef/zhmcclient-1.18.1.tar.gz",
"platform": "any",
"description": "# zhmcclient - A pure Python client library for the IBM Z HMC Web Services API\n\n[](https://pypi.python.org/pypi/zhmcclient/)\n[](https://github.com/zhmcclient/python-zhmcclient/actions/workflows/test.yml?query=branch%3Amaster)\n[](https://readthedocs.org/projects/python-zhmcclient/builds/)\n[](https://coveralls.io/github/zhmcclient/python-zhmcclient?branch=master)\n[](https://codeclimate.com/github/zhmcclient/python-zhmcclient)\n\n# Overview\n\nThe zhmcclient package is a client library written in pure Python that\ninteracts with the Web Services API of the Hardware Management Console\n(HMC) of [IBM Z](http://www.ibm.com/systems/z/) or\n[LinuxONE](http://www.ibm.com/systems/linuxone/) machines. The goal of\nthis package is to make the HMC Web Services API easily consumable for\nPython programmers.\n\nThe HMC Web Services API is the access point for any external tools to\nmanage the IBM Z or LinuxONE platform. It supports management of the\nlifecycle and configuration of various platform resources, such as\npartitions, CPU, memory, virtual switches, I/O adapters, and more.\n\nThe zhmcclient package encapsulates both protocols supported by the HMC\nWeb Services API:\n\n- REST over HTTPS for request/response-style operations driven by the\n client. Most of these operations complete synchronously, but some\n long-running tasks complete asynchronously.\n- JMS (Java Messaging Services) for notifications from the HMC to the\n client. This can be used to be notified about changes in the system,\n or about completion of asynchronous tasks started using REST.\n\n# Installation\n\nThe quick way:\n\n``` bash\n$ pip install zhmcclient\n```\n\nFor more details, see the\n[Installation section](http://python-zhmcclient.readthedocs.io/en/master/intro.html#installation)\nin the documentation.\n\n# Quickstart\n\nThe following example code lists the partitions on CPCs in DPM mode that\nare accessible for the user:\n\n``` python\n#!/usr/bin/env python\n\nimport zhmcclient\nimport requests.packages.urllib3\nrequests.packages.urllib3.disable_warnings()\n\n# Set these variables for your environment:\nhost = \"<IP address or hostname of the HMC>\"\nuserid = \"<userid on that HMC>\"\npassword = \"<password of that HMC userid>\"\nverify_cert = False\n\nsession = zhmcclient.Session(host, userid, password, verify_cert=verify_cert)\nclient = zhmcclient.Client(session)\nconsole = client.consoles.console\n\npartitions = console.list_permitted_partitions()\nfor part in partitions:\n cpc = part.manager.parent\n print(\"{} {}\".format(cpc.name, part.name))\n```\n\nPossible output when running the script:\n\n``` text\nP000S67B PART1\nP000S67B PART2\nP0000M96 PART1\n```\n\n# Documentation and Change Log\n\nFor the latest released version on PyPI:\n\n- [Documentation](http://python-zhmcclient.readthedocs.io)\n- [Change\n log](http://python-zhmcclient.readthedocs.io/en/master/changes.html)\n\n# zhmc CLI\n\nBefore version 0.18.0 of the zhmcclient package, it contained the zhmc\nCLI. Starting with zhmcclient version 0.18.0, the zhmc CLI has been\nmoved from this project into the new\n[zhmccli project](https://github.com/zhmcclient/zhmccli).\n\nIf your project uses the zhmc CLI, and you are upgrading the zhmcclient\npackage from before 0.18.0 to 0.18.0 or later, your project will need to\nadd the [zhmccli package](https://pypi.python.org/pypi/zhmccli) to its\ndependencies.\n\n# Contributing\n\nFor information on how to contribute to this project, see the\n[Development section](http://python-zhmcclient.readthedocs.io/en/master/development.html)\nin the documentation.\n\n# License\n\nThe zhmcclient package is licensed under the\n[Apache 2.0 License](https://github.com/zhmcclient/python-zhmcclient/tree/master/LICENSE).\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "A pure Python client library for the IBM Z HMC Web Services API",
"version": "1.18.1",
"project_urls": {
"Bug Tracker": "https://github.com/zhmcclient/python-zhmcclient/issues",
"Changelog": "https://python-zhmcclient.readthedocs.io/en/master/changes.html",
"Documentation": "https://python-zhmcclient.readthedocs.io",
"Homepage": "https://github.com/zhmcclient/python-zhmcclient",
"Source Code": "https://github.com/zhmcclient/python-zhmcclient"
},
"split_keywords": [
"hmc",
" client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "55e8bd17f572e5358ec5074209df50ae08ea28f0f6343e6912edc2d7ba3c00eb",
"md5": "b30d332cf6f8ac1264744128b44721ad",
"sha256": "e54e7aee11a39f3ea2492257ddec075df9efaac5d22077f9bbd0ba6d8a3e26dd"
},
"downloads": -1,
"filename": "zhmcclient-1.18.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b30d332cf6f8ac1264744128b44721ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 322181,
"upload_time": "2024-11-28T18:31:14",
"upload_time_iso_8601": "2024-11-28T18:31:14.831025Z",
"url": "https://files.pythonhosted.org/packages/55/e8/bd17f572e5358ec5074209df50ae08ea28f0f6343e6912edc2d7ba3c00eb/zhmcclient-1.18.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb0ef5770422d346629d07f745aa94eea0900bbe01444e9125084d43133b00ef",
"md5": "ba7a5dd6fb94af8b1ac1ba1162e7ad20",
"sha256": "2d3a0debfa572077a8ade2978f821cc6fc190aed248c815d9de221796b0687aa"
},
"downloads": -1,
"filename": "zhmcclient-1.18.1.tar.gz",
"has_sig": false,
"md5_digest": "ba7a5dd6fb94af8b1ac1ba1162e7ad20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 619327,
"upload_time": "2024-11-28T18:31:16",
"upload_time_iso_8601": "2024-11-28T18:31:16.263377Z",
"url": "https://files.pythonhosted.org/packages/bb/0e/f5770422d346629d07f745aa94eea0900bbe01444e9125084d43133b00ef/zhmcclient-1.18.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-28 18:31:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zhmcclient",
"github_project": "python-zhmcclient",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "zhmcclient"
}
JSON
