# zhmccli - A CLI for the IBM Z HMC, written in pure Python
[](https://pypi.python.org/pypi/zhmccli/)
[](https://github.com/zhmcclient/zhmccli/actions/workflows/test.yml?query=branch%3Amaster)
[](https://readthedocs.org/projects/zhmccli/builds/)
[](https://coveralls.io/r/zhmcclient/zhmccli)
[](https://codeclimate.com/github/zhmcclient/zhmccli)
# Overview
The zhmccli package is a CLI written in pure Python that interacts with
the Hardware Management Console (HMC) of
[IBM Z](http://www.ibm.com/systems/z/) or
[LinuxONE](http://www.ibm.com/systems/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
The quick way:
``` bash
$ pip install zhmccli
```
For more details, see the
[Installation section](http://zhmccli.readthedocs.io/en/latest/intro.html#installation)
in the documentation.
# Quickstart
The following example lists the names of the machines (CPCs) managed by
an HMC:
``` bash
$ 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](http://zhmccli.readthedocs.io/en/latest/)
- [Change log](http://zhmccli.readthedocs.io/en/latest/changes.html)
# Contributing
For information on how to contribute to this project, see the
[Development section](http://zhmccli.readthedocs.io/en/latest/development.html)
in the documentation.
# License
The zhmccli package is licensed under the
[Apache 2.0 License](https://github.com/zhmcclient/zhmccli/tree/master/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "zhmccli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Andreas Maier <maiera@de.ibm.com>, Kathir Velusamy <kathir.velu@in.ibm.com'>",
"keywords": "hmc, prometheus, monitoring",
"author": null,
"author_email": "Juergen Leopold <leopoldj@de.ibm.com>, Andreas Maier <maiera@de.ibm.com>",
"download_url": "https://files.pythonhosted.org/packages/22/02/8cc2e97cf02a0ad5ea3bacd625b0c44598fe893d3c6d7f658fcf4c9dc264/zhmccli-1.12.1.tar.gz",
"platform": "any",
"description": "# zhmccli - A CLI for the IBM Z HMC, written in pure Python\n\n[](https://pypi.python.org/pypi/zhmccli/)\n[](https://github.com/zhmcclient/zhmccli/actions/workflows/test.yml?query=branch%3Amaster)\n[](https://readthedocs.org/projects/zhmccli/builds/)\n[](https://coveralls.io/r/zhmcclient/zhmccli)\n[](https://codeclimate.com/github/zhmcclient/zhmccli)\n\n# Overview\n\nThe zhmccli package is a CLI written in pure Python that interacts with\nthe Hardware Management Console (HMC) of\n[IBM Z](http://www.ibm.com/systems/z/) or\n[LinuxONE](http://www.ibm.com/systems/linuxone/) machines. The goal of\nthis package is to provide an easy-to-use command line interface for\noperators.\n\nThe zhmccli package uses the API provided by the zhmcclient package,\nwhich interacts with the Web Services API of the HMC. It supports\nmanagement of the lifecycle and configuration of various platform\nresources, such as partitions, CPU, memory, virtual switches, I/O\nadapters, and more.\n\n# Installation\n\nThe quick way:\n\n``` bash\n$ pip install zhmccli\n```\n\nFor more details, see the\n[Installation section](http://zhmccli.readthedocs.io/en/latest/intro.html#installation)\nin the documentation.\n\n# Quickstart\n\nThe following example lists the names of the machines (CPCs) managed by\nan HMC:\n\n``` bash\n$ hmc_host=\"<IP address or hostname of the HMC>\"\n$ hmc_userid=\"<userid on that HMC>\"\n$ zhmc -h $hmc_host -u $hmc_userid cpc list --names-only\nEnter password (for user ... at HMC ...): .......\n+----------+\n| name |\n|----------+\n| P000S67B |\n+----------+\n```\n\n# Documentation\n\n- [Documentation](http://zhmccli.readthedocs.io/en/latest/)\n- [Change log](http://zhmccli.readthedocs.io/en/latest/changes.html)\n\n# Contributing\n\nFor information on how to contribute to this project, see the\n[Development section](http://zhmccli.readthedocs.io/en/latest/development.html)\nin the documentation.\n\n# License\n\nThe zhmccli package is licensed under the\n[Apache 2.0 License](https://github.com/zhmcclient/zhmccli/tree/master/LICENSE).\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "A CLI for the IBM Z HMC, written in pure Python",
"version": "1.12.1",
"project_urls": {
"Bug Tracker": "https://github.com/zhmcclient/zhmccli/issues",
"Changelog": "https://zhmccli.readthedocs.io/en/stable/changes.html",
"Documentation": "https://zhmccli.readthedocs.io/en/stable/",
"Homepage": "https://github.com/zhmcclient/zhmccli",
"Source Code": "https://github.com/zhmcclient/zhmccli"
},
"split_keywords": [
"hmc",
" prometheus",
" monitoring"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eac20adfef9f4693f24a205aa50f6a45153048554186c59f909dc2d3878cf401",
"md5": "71acf8792b161f9a49b3156acc459c5e",
"sha256": "5b488633b4176a349f029aaea06e27b45d02606523e9d5ef2032a60143431a42"
},
"downloads": -1,
"filename": "zhmccli-1.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71acf8792b161f9a49b3156acc459c5e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 166426,
"upload_time": "2024-12-12T14:59:18",
"upload_time_iso_8601": "2024-12-12T14:59:18.729890Z",
"url": "https://files.pythonhosted.org/packages/ea/c2/0adfef9f4693f24a205aa50f6a45153048554186c59f909dc2d3878cf401/zhmccli-1.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "22028cc2e97cf02a0ad5ea3bacd625b0c44598fe893d3c6d7f658fcf4c9dc264",
"md5": "531afeb75402ab2c45d6b62b1e62be9d",
"sha256": "87f8f929357e4f2d18b000c943572909e8116f724acc05b598c74cbd87fc9487"
},
"downloads": -1,
"filename": "zhmccli-1.12.1.tar.gz",
"has_sig": false,
"md5_digest": "531afeb75402ab2c45d6b62b1e62be9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 223011,
"upload_time": "2024-12-12T14:59:21",
"upload_time_iso_8601": "2024-12-12T14:59:21.136454Z",
"url": "https://files.pythonhosted.org/packages/22/02/8cc2e97cf02a0ad5ea3bacd625b0c44598fe893d3c6d7f658fcf4c9dc264/zhmccli-1.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 14:59:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zhmcclient",
"github_project": "zhmccli",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "zhmcclient",
"specs": [
[
">=",
"1.18.0"
]
]
},
{
"name": "click",
"specs": [
[
">=",
"8.0.2"
]
]
},
{
"name": "click-repl",
"specs": [
[
">=",
"0.2"
]
]
},
{
"name": "click-spinner",
"specs": [
[
">=",
"0.1.6"
]
]
},
{
"name": "click-spinner",
"specs": [
[
">=",
"0.1.10"
]
]
},
{
"name": "progressbar2",
"specs": [
[
">=",
"3.12.0"
]
]
},
{
"name": "tabulate",
"specs": [
[
">=",
"0.8.2"
]
]
},
{
"name": "tabulate",
"specs": [
[
">=",
"0.8.8"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
">=",
"2.8.2"
]
]
},
{
"name": "click-option-group",
"specs": [
[
">=",
"0.5.6"
]
]
},
{
"name": "prompt-toolkit",
"specs": [
[
">=",
"3.0.13"
]
]
},
{
"name": "PyYAML",
"specs": [
[
">=",
"6.0.2"
]
]
},
{
"name": "jsonschema",
"specs": [
[
">=",
"4.18.0"
]
]
},
{
"name": "yamlloader",
"specs": [
[
">=",
"0.5.5"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.26.19"
]
]
},
{
"name": "pyrsistent",
"specs": [
[
">=",
"0.20.0"
]
]
}
],
"tox": true,
"lcname": "zhmccli"
}
JSON
