Skip to main content

A pure Python client library for the IBM Z HMC Web Services API.

Project description

zhmcclient - A pure Python client library for the IBM Z HMC Web Services API

Version on Pypi Test status (master) Docs status (master) Test coverage (master) CodeClimate status

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 or 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:

$ pip install zhmcclient

For more details, see the Installation section in the documentation.

Quickstart

The following example code lists the partitions on CPCs in DPM mode that are accessible for the user:

#!/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:

P000S67B PART1
P000S67B PART2
P0000M96 PART1

Documentation and Change Log

For the latest released version on PyPI:

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.

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 to its dependencies.

Contributing

For information on how to contribute to this project, see the Development section in the documentation.

License

The zhmcclient package is licensed under the Apache 2.0 License.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zhmcclient-1.16.0.tar.gz (251.8 kB view details)

Uploaded Source

Built Distribution

zhmcclient-1.16.0-py2.py3-none-any.whl (314.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file zhmcclient-1.16.0.tar.gz.

File metadata

  • Download URL: zhmcclient-1.16.0.tar.gz
  • Upload date:
  • Size: 251.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for zhmcclient-1.16.0.tar.gz
Algorithm Hash digest
SHA256 ddf9f83c8429d9d7684209b0cfd6e254885bca80c03ec3823c89fb4633dee1c4
MD5 7dbc29bbb84fb9363e31bd84b4e54c97
BLAKE2b-256 ec1ff3b6ef37781b7dcdc7c9fb6d427aa5bd39d9e3a88f187f5afd7b00d7159c

See more details on using hashes here.

File details

Details for the file zhmcclient-1.16.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for zhmcclient-1.16.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 97fa7dba28e74fc62ddfc2885a86a2190d4da236088a94f73f0354f6bee33e8e
MD5 ae90c6e370170d87ddf0c653ead789c7
BLAKE2b-256 5847dbf2b44ca6baa2b297493e2eaba8f06ca395058dbdcb6803e2e5b4d28c0e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page