{"id":22960039,"url":"https://github.com/zhmcclient/zhmc-ansible-modules","last_synced_at":"2025-08-13T05:32:49.921Z","repository":{"id":37412534,"uuid":"97764250","full_name":"zhmcclient/zhmc-ansible-modules","owner":"zhmcclient","description":"An Ansible collection for the IBM Z HMC","archived":false,"fork":false,"pushed_at":"2024-12-12T13:57:32.000Z","size":15285,"stargazers_count":12,"open_issues_count":38,"forks_count":9,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-12T14:38:55.081Z","etag":null,"topics":["ansible-collection","hmc","mainframe","python","s390x"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zhmcclient.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-19T21:50:30.000Z","updated_at":"2024-12-12T13:57:28.000Z","dependencies_parsed_at":"2024-01-15T15:01:39.168Z","dependency_job_id":"dc39e21d-79b0-44b3-81bf-08edc23d3f75","html_url":"https://github.com/zhmcclient/zhmc-ansible-modules","commit_stats":null,"previous_names":[],"tags_count":47,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhmcclient%2Fzhmc-ansible-modules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhmcclient%2Fzhmc-ansible-modules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhmcclient%2Fzhmc-ansible-modules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhmcclient%2Fzhmc-ansible-modules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zhmcclient","download_url":"https://codeload.github.com/zhmcclient/zhmc-ansible-modules/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229740281,"owners_count":18116930,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansible-collection","hmc","mainframe","python","s390x"],"created_at":"2024-12-14T18:30:11.651Z","updated_at":"2024-12-14T18:30:12.339Z","avatar_url":"https://github.com/zhmcclient.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!---\nCopyright 2017,2020,2024 IBM Corp. All Rights Reserved.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n   http://www.apache.org/licenses/LICENSE-2.0\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n--\u003e\n\n\u003c!---\nNote: Details on the \"Version on Galaxy\" badge, below:\n\nShields.io allows defining dynamic badge creation using data in the result of\nan HTTP GET on a JSON based REST API, as follows:\n\nhttps://img.shields.io/badge/dynamic/json?\n  url=\u003cURL\u003e\u0026\n  label=\u003cLABEL\u003e\u0026\n  query=\u003c$.DATA.SUBDATA\u003e\u0026\n  color=\u003cCOLOR\u003e\u0026\n  prefix=\u003cPREFIX\u003e\u0026\n  suffix=\u003cSUFFIX\u003e\nplus the standard query parameters (style, color, ...)\n\nAnsible Galaxy returns the latest version of a collection using an HTTP GET on\nhttps://galaxy.ansible.com/api/v2/collections/\u003cNS\u003e/\u003cCOLL\u003e/ as follows:\n\n{\n    . . .\n    \"latest_version\": {\n        \"version\": \"1.0.0\",\n    }\n}\n\nAnsible AutomationHub returns the latest version of a collection using an HTTP GET on\nhttps://console.redhat.com/api/automation-hub/v3/collections/\u003cNS\u003e/\u003cCOLL\u003e/ as follows:\n\n{\n    . . .\n    \"highest_version\": {\n        \"version\": \"1.0.0\",\n    }\n}\n\nThat would result in the following markup:\n\n[![Version on AutomationHub](https://img.shields.io/badge/dynamic/json?style=flat\u0026label=hub\u0026prefix=v\u0026url=https://console.redhat.com/api/automation-hub/v3/collections/ibm/ibm_zhmc/\u0026query=highest_version.version)](https://console.redhat.com/ansible/automation-hub/repo/published/ibm/ibm_zhmc/ \"Version on AutomationHub\")\n\nHowever, for now this does not work, so it has been removed again from the README page.\nFor details, see the discussion at https://github.com/ansible-collections/overview/discussions/202\n--\u003e\n\n[![Version on Galaxy](https://img.shields.io/badge/dynamic/json?style=flat\u0026label=galaxy\u0026prefix=v\u0026url=https://galaxy.ansible.com/api/v3/plugin/ansible/content/published/collections/index/ibm/ibm_zhmc/versions/%3Fis_highest=true\u0026query=data[0].version)](https://galaxy.ansible.com/ui/repo/published/ibm/ibm_zhmc/ \"Version on Galaxy\")\n[![Test status (master)](https://github.com/zhmcclient/zhmc-ansible-modules/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/zhmcclient/zhmc-ansible-modules/actions/workflows/test.yml?query=branch%3Amaster \"Test status (master)\")\n[![Docs status (master)](https://github.com/zhmcclient/zhmc-ansible-modules/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/zhmcclient/zhmc-ansible-modules/actions/workflows/pages/pages-build-deployment \"Docs status (master)\")\n[![Test coverage (master)](https://img.shields.io/coveralls/zhmcclient/zhmc-ansible-modules.svg)](https://coveralls.io/github/zhmcclient/zhmc-ansible-modules \"Test coverage (master)\")\n\n# IBM® Z HMC collection\n\nThe **IBM Z HMC** collection enables automation with the IBM Z Hardware\nManagement Console (HMC) to manage platform resources on\n[IBM Z](https://www.ibm.com/it-infrastructure/z) and\n[IBM LinuxONE](https://www.ibm.com/it-infrastructure/linuxone/) machines.\n\n## Description\n\nThe **IBM Z HMC** collection is part of the\n**Red Hat® Ansible Certified Content for IBM Z®** offering that brings Ansible\nautomation to IBM Z®.\n\nThis collection supports automation tasks on the IBM Z HMC such as creating,\nupdating or deleting partitions, accesssing operating system messages,\nconfiguring adapters, managing HMC users, upgrading the SE and HMC firmware,\nand many more. It supports CPCs in classic mode and in DPM mode.\n\nThe IBM Z HMC collection uses the Web Services API of the HMC and therefore its\nmodules run on the Ansible control node (there is no separate Ansible managed\nnode in this case).\n\nFor guides and reference, please review the\n[documentation](https://zhmcclient.github.io/zhmc-ansible-modules/)\nor the Z HMC section in the\n[unified documentation](https://ibm.github.io/z_ansible_collections_doc/).\n\n## Requirements\n\nBefore you install the IBM Z HMC collection, you must have a minimum Python\nversion and Ansible version on the Ansible control node. The documentation section\n[Support matrix](https://zhmcclient.github.io/zhmc-ansible-modules/installation.html#support-matrix)\ndetails the specific version requirements.\n\n## Installation\n\nBefore using this collection, you need to install it with the Ansible Galaxy\ncommand-line tool:\n\n```sh\nansible-galaxy collection install ibm.ibm_zhmc\n```\n\nYou can also include it in a requirements.yml file and install it with\n`ansible-galaxy collection install -r requirements.yml`, using the format:\n\n```sh\ncollections:\n  - name: ibm.ibm_zhmc\n```\n\nThe installation of the collection will not cause any required Python packages\nto be installed. They need to be installed separately, either as OS-level\npackages or as Python packages, depending on how you manage the Python packages\non your system. A `requirements.txt` file is provided in the installation\ndirectory of the ibm.ibm_zhmc collection for that purpose, either for direct use\nwith `pip install -r requirements.txt`, or for manually checking and installing\nthe corresponding OS-level packages.\n\nNote that if you install the collection from Ansible Galaxy, it will not be\nupgraded automatically when you upgrade the Ansible (OS-level or Python) package.\n\nTo upgrade the collection to the latest available version, run the following\ncommand:\n\n```sh\nansible-galaxy collection install ibm.ibm_zhmc --upgrade\n```\n\nYou can also install a specific version of the collection, for example, if you\nneed to downgrade for some reason. For example, the following command installs\nversion 1.0.0:\n\n```sh\nansible-galaxy collection install ibm.ibm_zhmc:1.0.0\n```\n\n## Use Cases\n\n* Use Case Name: Create partition (DPM mode)\n  * Actors:\n    * System Programmer\n  * Description:\n    * The system programmer can automate the creation of a partition on a Z\n      system (that is in DPM mode).\n  * Flow:\n    * If the partition does not exist, create it.\n    * Update properties of the partition, including boot mode.\n    * Bring the partition into the specified status (active, stopped).\n\n* Use Case Name: Adjust workload related LPAR properties (classic mode)\n  * Actors:\n    * System Programmer\n  * Description:\n    * The system programmer can automate the adjustment of workload related\n      LPAR properties in order to optimize the performance of applications\n      running in the LPAR.\n  * Flow:\n    * Verify LPAR exists on the HMC\n    * Update the specified LPAR properties.\n\n* Use Case Name: Update password of HMC user\n  * Actors:\n    * System Programmer\n  * Description:\n    * The system programmer can automate the password update for their userid on\n      the HMC.\n  * Flow:\n    * Verify user exists on the HMC\n    * Update password of the user\n\n## Testing\n\nAll releases will meet the following test criteria:\n\n* 100% success for [Unit](https://github.com/zhmcclient/zhmc-ansible-modules/tree/master/tests/unit) tests.\n* 100% success for [Function](https://github.com/zhmcclient/zhmc-ansible-modules/tree/master/tests/function) tests.\n* 100% success for [End2end](https://github.com/zhmcclient/zhmc-ansible-modules/tree/master/tests/end2end) tests.\n* 100% success for [Ansible sanity](https://docs.ansible.com/ansible/latest/dev_guide/testing/sanity/index.html#all-sanity-tests) tests as part of [ansible-test](https://docs.ansible.com/ansible/latest/dev_guide/testing.html#run-sanity-tests).\n* 100% success for [flake8](https://flake8.pycqa.org).\n* 100% success for [pylint](https://pylint.readthedocs.io/en/stable/).\n* 100% success for [ansible-lint](https://ansible.readthedocs.io/projects/lint/) allowing only false positives.\n* 100% success for [safety](https://docs.safetycli.com/safety-docs) vulnerability checks.\n* 100% success for [bandit](https://bandit.readthedocs.io/) vulnerability checks.\n* 100% success for [pip-missing-reqs](https://github.com/adamtheturtle/pip-check-reqs/blob/master/README.rst) checks for missing dependencies.\n\nFor more details on testing the IBM Z HMC collection, including the specific version\ncombinations that were tested, refer to documentation section\n[Testing](https://zhmcclient.github.io/zhmc-ansible-modules/development.html#testing).\n\n## Contributing\n\nThis community is not currently accepting contributions. However, we encourage\nyou to open [git issues](https://github.com/zhmcclient/zhmc-ansible-modules/issues)\nfor bugs, comments or feature requests and check back periodically for when\ncommunity contributions will be accepted in the near future.\n\nReview the [development docs](https://zhmcclient.github.io/zhmc-ansible-modules/development.html)\nto learn how you can create an environment and test the collections modules.\n\n## Communication\n\nIf you would like to communicate with this community, you can do so through the\nfollowing options:\n\n* GitHub [IBM Z HMC issues](https://github.com/zhmcclient/zhmc-ansible-modules/issues).\n* Discord [ansible in System Z Enthusiasts](https://discord.com/channels/880322471608344597/1195381184360894595)\n  - Invitation link for server [System Z Enthusiasts](https://discord.gg/Kmy5QaUGbB)\n  - Invitation link for channel [ansible](https://discord.gg/nHrDdRTC)\n\n## Support\n\nAs Red Hat Ansible\n[Certified Content](https://catalog.redhat.com/software/search?target_platforms=Red%20Hat%20Ansible%20Automation%20Platform),\nthis collection is entitled to [support](https://access.redhat.com/support/) through\n[Ansible Automation Platform](https://www.redhat.com/en/technologies/management/ansible)\n(AAP). After creating a Red Hat support case, if it is determined the issue\nbelongs to IBM, Red Hat will instruct you to create an\n[IBM support case](https://www.ibm.com/mysupport/s/createrecord/NewCase) and\nshare the case number with Red Hat so that a collaboration can begin between\nRed Hat and IBM.\n\nIf a support case cannot be opened with Red Hat and the collection has been\nobtained either from [Galaxy](https://galaxy.ansible.com/ui/) or its\n[GitHub repo](https://github.com/zhmcclient/zhmc-ansible-modules), there is\ncommunity support available at no charge. Community support is limited to the\ncollection; community support does not include any of the Ansible Automation\nPlatform components or Ansible.\n\nThe current supported versions of this collection can be found listed in the\nfollowing section.\n\n## Release Notes and Roadmap\n\nThe collection's cumulative release notes can be reviewed\n[here](https://zhmcclient.github.io/zhmc-ansible-modules/release_notes.html).\nNote, some collection versions release before an ansible-core version reaches\nEnd of Life (EOL), thus the version of ansible-core that is supported must be a\nversion that is currently supported.\n\nFor AAP users, to see the supported ansible-core versions, review the\n[AAP Life Cycle](https://access.redhat.com/support/policy/updates/ansible-automation-platform).\n\nFor Galaxy and GitHub users, to see the supported ansible-core versions, review the\n[ansible-core support matrix](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix).\n\nThe collection's changelogs can be reviewed in the following table:\n\n| Version  | Status         | Release notes \u0026 change log |\n|----------|----------------|----------------------------|\n| 1.10.0   | In development | unreleased                 |\n| 1.9.0    | Released       | [Release notes \u0026 change log](https://zhmcclient.github.io/zhmc-ansible-modules/1.9.0/release_notes.html) |\n| 1.8.3    | Released       | [Release notes \u0026 change log](https://zhmcclient.github.io/zhmc-ansible-modules/1.8.3/release_notes.html) |\n| 1.7.4    | Released       | [Release notes \u0026 change log](https://zhmcclient.github.io/zhmc-ansible-modules/1.7.4/release_notes.html) |\n| 1.6.1    | Released       | [Release notes \u0026 change log](https://zhmcclient.github.io/zhmc-ansible-modules/1.6.1/release_notes.html) |\n| 1.5.0    | Released       | [Release notes \u0026 change log](https://zhmcclient.github.io/zhmc-ansible-modules/1.5.0/release_notes.html) |\n| 1.4.1    | Released       | [Release notes \u0026 change log](https://zhmcclient.github.io/zhmc-ansible-modules/1.4.1/release_notes.html) |\n| 1.3.1    | Released       | [Release notes \u0026 change log](https://zhmcclient.github.io/zhmc-ansible-modules/1.3.1/release_notes.html) |\n| 1.2.1    | Released       | [Release notes \u0026 change log](https://zhmcclient.github.io/zhmc-ansible-modules/1.2.1/release_notes.html) |\n| 1.1.1    | Released       | [Release notes \u0026 change log](https://zhmcclient.github.io/zhmc-ansible-modules/1.1.1/release_notes.html) |\n| 1.0.3    | Released       | [Release notes \u0026 change log](https://zhmcclient.github.io/zhmc-ansible-modules/1.0.3/release_notes.html) |\n\n## Related Information\n\nExample playbooks and use cases can be be found in the\n[IBM Z HMC sample playbooks](https://github.com/IBM/z_ansible_collections_samples/tree/master/z_systems_administration/zhmc)\nrepo.\n\nSupplemental content on getting started with Ansible, architecture and use cases\nis available [here](https://ibm.github.io/z_ansible_collections_doc/reference/helpful_links.html).\n\n## License Information\n\nThis collection is licensed under\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhmcclient%2Fzhmc-ansible-modules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhmcclient%2Fzhmc-ansible-modules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhmcclient%2Fzhmc-ansible-modules/lists"}