zhmccli 1.14.1

A CLI for the IBM Z HMC, written in pure Python

zhmccli - A CLI for the IBM Z HMC, written in pure Python

Overview

The zhmccli package is a CLI written in pure Python that interacts with the Hardware Management Console (HMC) of IBM Z or LinuxONE machines. The goal of this package is to provide an easy-to-use command line interface for operators.

The zhmccli package uses the API provided by the zhmcclient package, which interacts with the Web Services API of the HMC. It supports management of the lifecycle and configuration of various platform resources, such as partitions, CPU, memory, virtual switches, I/O adapters, and more.

Installation

• If not yet available, install the "pipx" command as described in https://pipx.pypa.io/stable/installation/.

• Without having any virtual Python environment active, install the CLI as follows:

  $ pipx install zhmccli
  

  That makes the zhmc command available in the PATH, without having to activate any virtual Python environment.

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

Quickstart

The following example lists the names of the machines (CPCs) managed by an HMC:

$ hmc_host="<IP address or hostname of the HMC>"
$ hmc_userid="<userid on that HMC>"
$ zhmc -h $hmc_host -u $hmc_userid cpc list --names-only
Enter password (for user ... at HMC ...): .......
+----------+
| name     |
|----------+
| P000S67B |
+----------+

Documentation

• Documentation
• Change log

Contributing

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

License

The zhmccli package is licensed under the Apache 2.0 License.