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 Actions status ReadTheDocs status Coveralls status 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 machines (CPCs) managed by an HMC:

#!/usr/bin/env python

import zhmcclient
import requests.packages.urllib3
requests.packages.urllib3.disable_warnings()

# Set these variables for your environment:
hmc_host = "<IP address or hostname of the HMC>"
hmc_userid = "<userid on that HMC>"
hmc_password = "<password of that HMC userid>"

session = zhmcclient.Session(hmc_host, hmc_userid, hmc_password)
client = zhmcclient.Client(session)

cpcs = client.cpcs.list()
for cpc in cpcs:
    print(cpc)

Possible output when running the script:

Cpc(name=P000S67B, object-uri=/api/cpcs/fa1f2466-12df-311a-804c-4ed2cc1d6564, status=service-required)

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.0.3.tar.gz (174.9 kB view details)

Uploaded Source

Built Distribution

zhmcclient-1.0.3-py2.py3-none-any.whl (230.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: zhmcclient-1.0.3.tar.gz
  • Upload date:
  • Size: 174.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for zhmcclient-1.0.3.tar.gz
Algorithm Hash digest
SHA256 ed1304e7ddd6ff67d79fa98950c449ad902deff1b9336bacb55cd439b13e3e52
MD5 25d03d473aea54172da1ad87aa21c16a
BLAKE2b-256 0e10c546a0f090bc2a66b8cd2aa93b83457d4b7fb6a3d75712826cc6e849ed4a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: zhmcclient-1.0.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 230.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for zhmcclient-1.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cdd17687e7842cb3bb9cf96935c7eafb75d2fe85f6f193a60c7cb2965d2d7de4
MD5 2e139296042ea74ff691b8dfcee8d410
BLAKE2b-256 4fa4c7925a407d797163bc5e12770d3d16484a130c90a75c1bec7c3484fe7e16

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