The IBM Z HMC OS Message Forwarder connects to the console of operating systems running in LPARs on Z systems and forwards the messages written by the operating systems in the LPARs to remote syslog servers.
The Z systems can be in classic or DPM operational mode.
The forwarder attempts to stay up as much as possible, for example it performs automatic session renewals with the HMC if the logon session expires, and it survives HMC reboots and automatically resumes forwarding again once the HMC come back up, without loosing or duplicating any messages.
Documentation
Supported environments
Operating systems: Linux, macOS, Windows
Python versions: 3.5 and higher
HMC versions: 2.11.1 and higher
Quickstart
Install the forwarder and all of its Python dependencies as follows:
$ pip install zhmc-os-forwarderProvide a config file for use by the forwarder.
The config file tells the forwarder which HMC to use, and for which CPCs and LPARs it should forward to which syslog servers.
Download the Example forwarder config file and edit that copy according to your needs.
For details, see Forwarder config file.
Run the forwarder as follows:
$ zhmc_os_forwarder -c config.yaml zhmc_os_forwarder version: 0.2.0 zhmcclient version: 1.10.0 Verbosity level: 0 Opening session with HMC 10.11.12.13 (user: johndoe@us.ibm.com, certificate validation: False) Forwarder is up and running (Press Ctrl-C to shut down)
Limitations
At this point, the forwarder has several limitations. All of them are intended to be resolved in future releases.
The forwarder does not recover from HMC restart or connection loss
Restarting the forwarder will send again all OS messages the HMC has buffered
New and deleted LPARs in DPM mode are not automatically detected.
Reporting issues
If you encounter a problem, please report it as an issue on GitHub.
License
This package is licensed under the Apache 2.0 License.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file zhmc_os_forwarder-0.2.0.tar.gz.
File metadata
- Download URL: zhmc_os_forwarder-0.2.0.tar.gz
- Upload date:
- Size: 23.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
66a3aa525cc3ec9ed771f4919762f4b1dcb9e2faa18dffef216bd27c26ab13fc
|
|
| MD5 |
f348f552a887587b339ac4d815339b44
|
|
| BLAKE2b-256 |
07c5c63645a063b7f5ab2bac85310cb0b3e1bdab05ebd13d0da89eca8d077058
|
File details
Details for the file zhmc_os_forwarder-0.2.0-py2.py3-none-any.whl.
File metadata
- Download URL: zhmc_os_forwarder-0.2.0-py2.py3-none-any.whl
- Upload date:
- Size: 25.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aa89e215dad41a4ab9f6ac7f6bfd13e1b315c0095f936dc67e75af707767d779
|
|
| MD5 |
155b5c798628dcf9ef515b21d2e6b531
|
|
| BLAKE2b-256 |
734559e7d253eecaff3d88aad36727785778744829496ebd27cf36d05140a5d5
|
