zhmcclient 0.8.0

A pure Python client library for the z Systems HMC Web Services API.

zhmcclient - A pure Python client library for the z Systems HMC Web Services API

Overview

The zhmcclient package (also known as python-zhmcclient) is a client library written in pure Python that interacts with the Web Services API of the Hardware Management Console (HMC) of z Systems 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 z Systems 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 is used for notification 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

#!/usr/bin/env python

import zhmcclient
import requests.packages.urllib3

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

requests.packages.urllib3.disable_warnings()

session = zhmcclient.Session(zhmc, userid, password)
client = zhmcclient.Client(session)

vi = client.version_info()
print("HMC API version: {}.{}".format(vi[0], vi[1]))

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

Documentation

The zhmcclient documentation is on RTD:

• Documentation for version on Pypi

• Documentation for master branch in Git repo

Development, testing, and contributing

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

License

python-zhmcclient is licensed under the Apache 2.0 License.