Skip to main content

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

Version on Pypi Test status (master) Docs status (master) Test coverage (master) Code Climate

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

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.

Download files

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

Source Distribution

zhmccli-1.14.3.tar.gz (278.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zhmccli-1.14.3-py3-none-any.whl (191.8 kB view details)

Uploaded Python 3

File details

Details for the file zhmccli-1.14.3.tar.gz.

File metadata

  • Download URL: zhmccli-1.14.3.tar.gz
  • Upload date:
  • Size: 278.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for zhmccli-1.14.3.tar.gz
Algorithm Hash digest
SHA256 b9048df7c88d641a6d1f9101fed520373c7ae49ef9012049b2e21a00a0145a32
MD5 c053a46fec545ef197e497479fc98f16
BLAKE2b-256 1c8aacbe0dfa694f5d80ecdc6fb20dcbbcf7f28cdc4b4f8ac82b9a7e8ae0cf8a

See more details on using hashes here.

Provenance

The following attestation bundles were made for zhmccli-1.14.3.tar.gz:

Publisher: publish.yml on zhmcclient/zhmccli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file zhmccli-1.14.3-py3-none-any.whl.

File metadata

  • Download URL: zhmccli-1.14.3-py3-none-any.whl
  • Upload date:
  • Size: 191.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for zhmccli-1.14.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a3f5260052f256370666593e042ea747bdb60380f02f2093588341d20509ae44
MD5 ee49a8a085e8e376263bc0c1eeee9d0f
BLAKE2b-256 d76847e514a6d367e93b2e68aa6c2df57f1bfb99219edf69524e8a2bf00e72ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for zhmccli-1.14.3-py3-none-any.whl:

Publisher: publish.yml on zhmcclient/zhmccli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page